File: plot-uibuttongroupproperties.texi

package info (click to toggle)
octave 6.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 124,192 kB
  • sloc: cpp: 322,665; ansic: 68,088; fortran: 20,980; objc: 8,121; sh: 7,719; yacc: 4,266; lex: 4,123; perl: 1,530; java: 1,366; awk: 1,257; makefile: 424; xml: 147
file content (262 lines) | stat: -rw-r--r-- 10,569 bytes parent folder | download
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
@c DO NOT EDIT!  Generated automatically by genpropdoc.m.

@c Copyright (C) 2014-2019 Pantxo Diribarne
@c
@c This file is part of Octave.
@c
@c Octave is free software: you can redistribute it and/or modify it
@c under the terms of the GNU General Public License as published by
@c the Free Software Foundation, either version 3 of the License, or
@c (at your option) any later version.
@c
@c Octave is distributed in the hope that it will be useful, but
@c WITHOUT ANY WARRANTY; without even the implied warranty of
@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@c GNU General Public License for more details.
@c
@c You should have received a copy of the GNU General Public License
@c along with Octave; see the file COPYING.  If not, see
@c <https://www.gnu.org/licenses/>.

Properties of @code{uibuttongroup} objects (@pxref{XREFuibuttongroup,,uibuttongroup}):

@table @asis

@anchor{XREFuibuttongroupbackgroundcolor}
@prindex uibuttongroup backgroundcolor
@item @code{backgroundcolor}: def. @code{[0.9400   0.9400   0.9400]}



@anchor{XREFuibuttongroupbeingdeleted}
@prindex uibuttongroup beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFuibuttongroupbordertype}
@prindex uibuttongroup bordertype
@item @code{bordertype}: @qcode{"beveledin"} | @qcode{"beveledout"} | @{@qcode{"etchedin"}@} | @qcode{"etchedout"} | @qcode{"line"} | @qcode{"none"}



@anchor{XREFuibuttongroupborderwidth}
@prindex uibuttongroup borderwidth
@item @code{borderwidth}: def. @code{1}



@anchor{XREFuibuttongroupbusyaction}
@prindex uibuttongroup busyaction
@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@}
Define how Octave handles the execution of this object's callback properties when it is unable to interrupt another object's executing callback.  This is only relevant when the currently executing callback object has its @code{interruptible} property set to @qcode{"off"}.  The @code{busyaction} property of the interrupting callback object indicates whether the interrupting callback is queued (@qcode{"queue"} (default)) or discarded (@qcode{"cancel"}).
@xref{Callbacks, , @w{Callbacks section}}.


@anchor{XREFuibuttongroupbuttondownfcn}
@prindex uibuttongroup buttondownfcn
@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)}
For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.


@anchor{XREFuibuttongroupchildren}
@prindex uibuttongroup children
@item @code{children} (read-only): vector of graphics handles, def. @code{[](0x1)}
Graphics handles of the uibuttongroup's children.


@anchor{XREFuibuttongroupclipping}
@prindex uibuttongroup clipping
@item @code{clipping}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{clipping} is @qcode{"on"}, the uibuttongroup is clipped in its parent axes limits.


@anchor{XREFuibuttongroupcreatefcn}
@prindex uibuttongroup createfcn
@item @code{createfcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately after uibuttongroup has been created.  Function is set by using default property on root object, e.g., @code{set (groot, "defaultuibuttongroupcreatefcn", 'disp ("uibuttongroup created!")')}.

For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.


@anchor{XREFuibuttongroupdeletefcn}
@prindex uibuttongroup deletefcn
@item @code{deletefcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately before uibuttongroup is deleted.

For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.


@anchor{XREFuibuttongroupfontangle}
@prindex uibuttongroup fontangle
@item @code{fontangle}: @qcode{"italic"} | @{@qcode{"normal"}@} | @qcode{"oblique"}
Control whether the font is italic or normal.


@anchor{XREFuibuttongroupfontname}
@prindex uibuttongroup fontname
@item @code{fontname}: string, def. @qcode{"*"}
Name of font used for text rendering.  When setting this property, the text rendering engine will search for a matching font in your system.  If none is found then text is rendered using a default sans serif font (same as the default @qcode{"*"} value).

Programming Note: On systems that don’t use FontConfig natively (all but Linux), the font cache is built when Octave is installed.  You will need to run @code{system ("fc-cache -fv")} manually after installing new fonts.


@anchor{XREFuibuttongroupfontsize}
@prindex uibuttongroup fontsize
@item @code{fontsize}: scalar, def. @code{10}
Size of the font used for text rendering.  @xref{XREFuibuttongroupfontunits, , fontunits property}.


@anchor{XREFuibuttongroupfontunits}
@prindex uibuttongroup fontunits
@item @code{fontunits}: @qcode{"centimeters"} | @qcode{"inches"} | @qcode{"normalized"} | @qcode{"pixels"} | @{@qcode{"points"}@}
Units used to interpret the @qcode{"fontsize"} property.


@anchor{XREFuibuttongroupfontweight}
@prindex uibuttongroup fontweight
@item @code{fontweight}: @qcode{"bold"} | @{@qcode{"normal"}@}
Control the variant of the base font used for text rendering.


@anchor{XREFuibuttongroupforegroundcolor}
@prindex uibuttongroup foregroundcolor
@item @code{foregroundcolor}: def. @code{[0   0   0]}



@anchor{XREFuibuttongrouphandlevisibility}
@prindex uibuttongroup handlevisibility
@item @code{handlevisibility}: @qcode{"callback"} | @qcode{"off"} | @{@qcode{"on"}@}
If @code{handlevisibility} is @qcode{"off"}, the uibuttongroup's handle is not visible in its parent's "children" property.


@anchor{XREFuibuttongrouphighlightcolor}
@prindex uibuttongroup highlightcolor
@item @code{highlightcolor}: def. @code{[1   1   1]}



@anchor{XREFuibuttongrouphittest}
@prindex uibuttongroup hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}
Specify whether uibuttongroup processes mouse events or passes them to ancestors of the object.  When enabled, the object may respond to mouse clicks by evaluating the @qcode{"buttondownfcn"}, showing the uicontextmenu, and eventually becoming the root @qcode{"currentobject"}.  This property is only relevant when the object can accept mouse clicks which is determined by the @qcode{"pickableparts"} property.  @xref{XREFuibuttongrouppickableparts, , @w{pickableparts property}}.


@anchor{XREFuibuttongroupinterruptible}
@prindex uibuttongroup interruptible
@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@}
Specify whether this object's callback functions may be interrupted by other callbacks.  By default @code{interruptible} is @qcode{"on"} and callbacks that make use of @code{drawnow}, @code{figure}, @code{waitfor}, @code{getframe} or @code{pause} functions are eventually interrupted.
@xref{Callbacks, , @w{Callbacks section}}.


@anchor{XREFuibuttongroupparent}
@prindex uibuttongroup parent
@item @code{parent}: graphics handle
Handle of the parent graphics object.


@anchor{XREFuibuttongrouppickableparts}
@prindex uibuttongroup pickableparts
@item @code{pickableparts}: @qcode{"all"} | @qcode{"none"} | @{@qcode{"visible"}@}
Specify whether uibuttongroup will accept mouse clicks.  By default, @code{pickableparts} is @qcode{"visible"} and only visible parts of the uibuttongroup or its children may react to mouse clicks.  When @code{pickableparts} is @qcode{"all"} both visible and invisible parts (or children) may react to mouse clicks.  When @code{pickableparts} is @qcode{"none"} mouse clicks on the object are ignored and transmitted to any objects underneath this one.  When an object is configured to accept mouse clicks the @qcode{"hittest"} property will determine how they are processed.  @xref{XREFuibuttongrouphittest, , @w{hittest property}}.


@anchor{XREFuibuttongroupposition}
@prindex uibuttongroup position
@item @code{position}: def. @code{[0   0   1   1]}



@anchor{XREFuibuttongroupresizefcn}
@prindex uibuttongroup resizefcn
@item @code{resizefcn}: string | function handle, def. @code{[](0x0)}
@code{resizefcn} is deprecated.  Use @code{sizechangedfcn} instead.


@anchor{XREFuibuttongroupselected}
@prindex uibuttongroup selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFuibuttongroupselectedobject}
@prindex uibuttongroup selectedobject
@item @code{selectedobject}: def. @code{[](0x0)}



@anchor{XREFuibuttongroupselectionchangedfcn}
@prindex uibuttongroup selectionchangedfcn
@item @code{selectionchangedfcn}: def. @code{[](0x0)}



@anchor{XREFuibuttongroupselectionhighlight}
@prindex uibuttongroup selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFuibuttongroupshadowcolor}
@prindex uibuttongroup shadowcolor
@item @code{shadowcolor}: def. @code{[0.7000   0.7000   0.7000]}



@anchor{XREFuibuttongroupsizechangedfcn}
@prindex uibuttongroup sizechangedfcn
@item @code{sizechangedfcn}: string | function handle, def. @code{[](0x0)}
Callback triggered when the uibuttongroup size is changed.

For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.


@anchor{XREFuibuttongrouptag}
@prindex uibuttongroup tag
@item @code{tag}: string, def. @qcode{""}
A user-defined string to label the graphics object.


@anchor{XREFuibuttongrouptitle}
@prindex uibuttongroup title
@item @code{title}: def. @qcode{""}



@anchor{XREFuibuttongrouptitleposition}
@prindex uibuttongroup titleposition
@item @code{titleposition}: @qcode{"centerbottom"} | @qcode{"centertop"} | @qcode{"leftbottom"} | @{@qcode{"lefttop"}@} | @qcode{"rightbottom"} | @qcode{"righttop"}



@anchor{XREFuibuttongrouptype}
@prindex uibuttongroup type
@item @code{type} (read-only): string
Class name of the graphics object.  @code{type} is always @qcode{"uibuttongroup"}


@anchor{XREFuibuttongroupuicontextmenu}
@prindex uibuttongroup uicontextmenu
@item @code{uicontextmenu}: graphics handle, def. @code{[](0x0)}
Graphics handle of the uicontextmenu object that is currently associated to this uibuttongroup object.


@anchor{XREFuibuttongroupunits}
@prindex uibuttongroup units
@item @code{units}: @qcode{"centimeters"} | @qcode{"characters"} | @qcode{"inches"} | @{@qcode{"normalized"}@} | @qcode{"pixels"} | @qcode{"points"}



@anchor{XREFuibuttongroupuserdata}
@prindex uibuttongroup userdata
@item @code{userdata}: Any Octave data, def. @code{[](0x0)}
User-defined data to associate with the graphics object.


@anchor{XREFuibuttongroupvisible}
@prindex uibuttongroup visible
@item @code{visible}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{visible} is @qcode{"off"}, the uibuttongroup is not rendered on screen.

@end table