Mercurial > octave-nkf

comparison scripts/gui/uitoggletool.m @ 20632:7890893a0e69 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add uiXXXX documentation (Bug #46076) * scripts/gui/uicontextmenu.m: add function documentation. * scripts/gui/uitoolbar.m: add function documentation. * scripts/gui/uitoggletool.m: add function documentation. * scripts/gui/uipushtool.m: add function documentation. * scripts/gui/uipanel.m: add function documentation. * scripts/gui/uicontrol.m: add function documentation.
author John Donoghue <john.donoghue@ieee.org>
date Thu, 08 Oct 2015 20:59:25 -0400
parents 9fc020886ae9
children 93d96da9ff3e
comparison
equal deleted inserted replaced
20625:45759620a9a5 20632:7890893a0e69
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{hui} =} uitoggletool ("Name", value, @dots{}) 20 ## @deftypefn {Function File} {@var{hui} =} uitoggletool (@var{property}, @var{value}, @dots{})
21 ## @deftypefnx {Function File} {@var{hui} =} uitoggletool (@var{parent}, "Name", value, @dots{}) 21 ## @deftypefnx {Function File} {@var{hui} =} uitoggletool (@var{parent}, @var{property}, @var{value}, @dots{})
22 ##
23 ## Create a uitoggletool object and return a handle to it.
24 ##
25 ## uitoggletool are togglebuttons that appear on a figure toolbar. The button is created with a border that
26 ## is shown when the user hovers over the button. An image can be set using the cdata property.
27 ##
28 ## If @var{parent} is omitted then a uitoggletool for the current figure is
29 ## created. If no figure is available, a new figure is created first. If a figure is
30 ## available, but does not contain a uitoolbar, a uitoolbar will be created.
31 ##
32 ## If @var{parent} is given then a uitoggletool is created on the @var{parent} uitoolbar.
33 ##
34 ## Any provided property value pairs will override the default values of the created
35 ## uitoggletool object.
36 ##
37 ## Examples:
38 ##
39 ## @example
40 ## @group
41 ## % create figure without a default toolbar
42 ## f = figure ("toolbar", "none");
43 ## % create empty toolbar
44 ## t = uitoolbar (f);
45 ## % create a 19x19x3 black square
46 ## img=zeros(19,19,3);
47 ## % add uitoggletool button to toolbar
48 ## b = uitoggletool (t, "cdata", img);
49 ## @end group
50 ## @end example
51 ## @seealso{figure, uitoolbar, uipushtool}
22 ## @end deftypefn 52 ## @end deftypefn
23 53
24 ## Author: goffioul 54 ## Author: goffioul
25 55
26 function hui = uitoggletool (varargin) 56 function hui = uitoggletool (varargin)