1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
########################################################################
##
## Copyright (C) 2012-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {@var{hui} =} uitoggletool ()
## @deftypefnx {} {@var{hui} =} uitoggletool (@var{property}, @var{value}, @dots{})
## @deftypefnx {} {@var{hui} =} uitoggletool (@var{parent})
## @deftypefnx {} {@var{hui} =} uitoggletool (@var{parent}, @var{property}, @var{value}, @dots{})
##
## Create a uitoggletool object.
##
## uitoggletool are togglebuttons that appear on a figure toolbar. The
## button is created with a border that is shown when the user hovers over
## the button. An image can be set using the cdata property.
##
## If @var{parent} is omitted then a uitoggletool for the current figure is
## created. If no figure is available, a new figure is created first. If a
## figure is available, but does not contain a uitoolbar, a uitoolbar will be
## created.
##
## If @var{parent} is given then a uitoggletool is created on the
## @var{parent} uitoolbar.
##
## Any provided property value pairs will override the default values of the
## created uitoggletool object.
##
## The full list of properties is documented at @ref{Uitoggletool Properties}.
##
## The optional return value @var{hui} is a graphics handle to the created
## uitoggletool object.
##
## Examples:
##
## @example
## @group
## % create figure without a default toolbar
## f = figure ("toolbar", "none");
## % create empty toolbar
## t = uitoolbar (f);
## % create a 19x19x3 black square
## img=zeros(19,19,3);
## % add uitoggletool button to toolbar
## b = uitoggletool (t, "cdata", img);
## @end group
## @end example
## @seealso{figure, uitoolbar, uipushtool}
## @end deftypefn
function hui = uitoggletool (varargin)
[h, args] = __uiobject_split_args__ ("uitoggletool", varargin,
{"uitoolbar"}, 0);
if (isempty (h))
h = findobj (gcf, "-depth", 1, "type", "uitoolbar");
if (isempty (h))
h = uitoolbar ();
else
h = h(1);
endif
endif
htmp = __go_uitoggletool__ (h, args{:});
if (nargout > 0)
hui = htmp;
endif
endfunction
|
