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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Uicontrol Properties (GNU Octave (version 10.3.0))</title>
<meta name="description" content="Uicontrol Properties (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Uicontrol Properties (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Graphics-Object-Properties.html" rel="up" title="Graphics Object Properties">
<link href="Uitable-Properties.html" rel="next" title="Uitable Properties">
<link href="Uipanel-Properties.html" rel="prev" title="Uipanel Properties">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsubsection-level-extent" id="Uicontrol-Properties">
<div class="nav-panel">
<p>
Next: <a href="Uitable-Properties.html" accesskey="n" rel="next">Uitable Properties</a>, Previous: <a href="Uipanel-Properties.html" accesskey="p" rel="prev">Uipanel Properties</a>, Up: <a href="Graphics-Object-Properties.html" accesskey="u" rel="up">Graphics Object Properties</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsubsection" id="Uicontrol-Properties-1"><span>15.3.3.16 Uicontrol Properties<a class="copiable-link" href="#Uicontrol-Properties-1"> ¶</a></span></h4>
<a class="index-entry-id" id="index-Uicontrol-Properties"></a>
<p>Properties of <code class="code">uicontrol</code> objects (see <a class="pxref" href="UI-Elements.html#XREFuicontrol">uicontrol</a>):
</p>
<h4 class="subsubheading" id="Categories_003a-15"><span>Categories:<a class="copiable-link" href="#Categories_003a-15"> ¶</a></span></h4>
<p><a class="ref" href="#XREFuicontrolcategoryAppearance">Appearance<!-- /@w --></a> | <a class="ref" href="#XREFuicontrolcategoryCallbackExecution">Callback Execution<!-- /@w --></a> | <a class="ref" href="#XREFuicontrolcategoryControlOptions">Control Options<!-- /@w --></a> | <a class="ref" href="#XREFuicontrolcategoryCreation_002fDeletion">Creation/Deletion<!-- /@w --></a> | <a class="ref" href="#XREFuicontrolcategoryDisplay">Display<!-- /@w --></a> | <a class="ref" href="#XREFuicontrolcategoryMouseInteraction">Mouse Interaction<!-- /@w --></a> | <a class="ref" href="#XREFuicontrolcategoryObjectIdentification">Object Identification<!-- /@w --></a> | <a class="ref" href="#XREFuicontrolcategoryObjectPosition">Object Position<!-- /@w --></a> | <a class="ref" href="#XREFuicontrolcategoryParent_002fChildren">Parent/Children<!-- /@w --></a> | <a class="ref" href="#XREFuicontrolcategoryTextAppearance">Text Appearance<!-- /@w --></a>
</p>
<a class="anchor" id="XREFuicontrolcategoryAppearance"></a><h4 class="subsubheading" id="Appearance-4"><span>Appearance<a class="copiable-link" href="#Appearance-4"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontrolbackgroundcolor"></a></dd>
<dt><a id="index-uicontrol-backgroundcolor"></a><span><code class="code">backgroundcolor</code>: colorspec, def. <code class="code">[0.9400 0.9400 0.9400]</code><a class="copiable-link" href="#index-uicontrol-backgroundcolor"> ¶</a></span></dt>
<dd><p>The color value of the background of this control object.
</p>
<a class="anchor" id="XREFuicontrolcdata"></a></dd>
<dt><a id="index-uicontrol-cdata"></a><span><code class="code">cdata</code>: array, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-uicontrol-cdata"> ¶</a></span></dt>
<dd><p>Image data used to represent the control object, stored as a M x N x 3 RGB array.
</p>
<a class="anchor" id="XREFuicontrolextent"></a></dd>
<dt><a id="index-uicontrol-extent"></a><span><code class="code">extent</code> (read-only): four-element vector<a class="copiable-link" href="#index-uicontrol-extent"> ¶</a></span></dt>
<dd><p>Size of the text string associated to the uicontrol returned in the form <code class="code">[0 0 width height]</code> (the two first elements are always zero).
</p>
<p>For multi-line strings the returned <code class="code">width</code> and <code class="code">height</code> indicate the size of the rectangle enclosing all lines.
</p>
<a class="anchor" id="XREFuicontrolforegroundcolor"></a></dd>
<dt><a id="index-uicontrol-foregroundcolor"></a><span><code class="code">foregroundcolor</code>: colorspec, def. <code class="code">[0 0 0]</code><a class="copiable-link" href="#index-uicontrol-foregroundcolor"> ¶</a></span></dt>
<dd><p>The color value of the text for this control object. See <a class="xref" href="Colors.html">colorspec</a>.
</p>
<a class="anchor" id="XREFuicontrolstyle"></a></dd>
<dt><a id="index-uicontrol-style"></a><span><code class="code">style</code>: <code class="code">"checkbox"</code> | <code class="code">"edit"</code> | <code class="code">"frame"</code> | <code class="code">"listbox"</code> | <code class="code">"popupmenu"</code> | {<code class="code">"pushbutton"</code>} | <code class="code">"radiobutton"</code> | <code class="code">"slider"</code> | <code class="code">"text"</code> | <code class="code">"togglebutton"</code><a class="copiable-link" href="#index-uicontrol-style"> ¶</a></span></dt>
<dd><p>The type of control object created. For a complete description of available control styles, see the <a class="ref" href="UI-Elements.html#XREFuicontrol"><code class="code">"uicontrol"</code> function<!-- /@w --></a>
</p>
</dd>
</dl>
<a class="anchor" id="XREFuicontrolcategoryCallbackExecution"></a><h4 class="subsubheading" id="Callback-Execution-15"><span>Callback Execution<a class="copiable-link" href="#Callback-Execution-15"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontrolbusyaction"></a></dd>
<dt><a id="index-uicontrol-busyaction"></a><span><code class="code">busyaction</code>: <code class="code">"cancel"</code> | {<code class="code">"queue"</code>}<a class="copiable-link" href="#index-uicontrol-busyaction"> ¶</a></span></dt>
<dd><p>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 class="code">interruptible</code> property set to <code class="code">"off"</code>. The <code class="code">busyaction</code> property of the interrupting callback object indicates whether the interrupting callback is queued (<code class="code">"queue"</code> (default)) or discarded (<code class="code">"cancel"</code>).
See <a class="xref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFuicontrolcallback"></a></dd>
<dt><a id="index-uicontrol-callback"></a><span><code class="code">callback</code>: string, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-uicontrol-callback"> ¶</a></span></dt>
<dd><p>A string consisting of a valid Octave expression that will be executed whenever this control is activated.
</p>
<a class="anchor" id="XREFuicontrolinterruptible"></a></dd>
<dt><a id="index-uicontrol-interruptible"></a><span><code class="code">interruptible</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-uicontrol-interruptible"> ¶</a></span></dt>
<dd><p>Specify whether this object’s callback functions may be interrupted by other callbacks. By default <code class="code">interruptible</code> is <code class="code">"on"</code> and callbacks that make use of <code class="code">drawnow</code>, <code class="code">figure</code>, <code class="code">waitfor</code>, <code class="code">getframe</code> or <code class="code">pause</code> functions are eventually interrupted.
See <a class="xref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFuicontrolkeypressfcn"></a></dd>
<dt><a id="index-uicontrol-keypressfcn"></a><span><code class="code">keypressfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-uicontrol-keypressfcn"> ¶</a></span></dt>
<dd><p>Function that is executed when a key is pressed and the control object has focus.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFuicontrolcategoryControlOptions"></a><h4 class="subsubheading" id="Control-Options"><span>Control Options<a class="copiable-link" href="#Control-Options"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontrolenable"></a></dd>
<dt><a id="index-uicontrol-enable"></a><span><code class="code">enable</code>: <code class="code">"inactive"</code> | <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-uicontrol-enable"> ¶</a></span></dt>
<dd><p>Sets whether this control object is active or is grayed out.
</p>
<a class="anchor" id="XREFuicontrollistboxtop"></a></dd>
<dt><a id="index-uicontrol-listboxtop"></a><span><code class="code">listboxtop</code>: scalar, def. <code class="code">1</code><a class="copiable-link" href="#index-uicontrol-listboxtop"> ¶</a></span></dt>
<dd><p>The index of the string option that will appear at the top of "listbox" controls
</p>
<a class="anchor" id="XREFuicontrolmax"></a></dd>
<dt><a id="index-uicontrol-max"></a><span><code class="code">max</code>: scalar, def. <code class="code">1</code><a class="copiable-link" href="#index-uicontrol-max"> ¶</a></span></dt>
<dd><p>The maximum control value, whose effect on the control is dependent on the control type. For <code class="code">"checkbox"</code>, <code class="code">"togglebutton"</code>, and <code class="code">"radiobutton"</code> controls, the <code class="code">"max"</code> value is assigned to the <code class="code">"value"</code> property when the control object is selected. For <code class="code">"slider"</code> controls, <code class="code">"max"</code> defines the maximum value of the slider. For <code class="code">"edit"</code> and <code class="code">"listbox"</code> controls, if <code class="code">Max - Min > 1</code>, then the control will permit multiple line entries or list item selections, respectively.
</p>
<a class="anchor" id="XREFuicontrolmin"></a></dd>
<dt><a id="index-uicontrol-min"></a><span><code class="code">min</code>: scalar, def. <code class="code">0</code><a class="copiable-link" href="#index-uicontrol-min"> ¶</a></span></dt>
<dd><p>The minimum control value, whose effect on the control is dependent on the control type. For <code class="code">"checkbox"</code>, <code class="code">"togglebutton"</code>, and <code class="code">"radiobutton"</code> controls, the <code class="code">"min"</code> value is assigned to the <code class="code">"value"</code> property when the control object is not selected. For <code class="code">"slider"</code> controls, <code class="code">"min"</code> defines the minimum value of the slider. For <code class="code">"edit"</code> and <code class="code">"listbox"</code> controls, if <code class="code">Max - Min > 1</code>, then the control will permit multiple line entries or list item selections, respectively.
</p>
<a class="anchor" id="XREFuicontrolsliderstep"></a></dd>
<dt><a id="index-uicontrol-sliderstep"></a><span><code class="code">sliderstep</code>: two-element vector, def. <code class="code">[0.010000 0.100000]</code><a class="copiable-link" href="#index-uicontrol-sliderstep"> ¶</a></span></dt>
<dd><p>The fractional step size, measured relative to the <code class="code">Min - Max</code> span of the slider, that the slider moves when the user clicks on the object. <code class="code">"sliderstep"</code> is specified as a two-element vector consisting of <code class="code">[minor major]</code>, where <code class="code">"minor"</code> is the step size for clicking on the slider arrows, and <code class="code">"major"</code> is the step size for clicking within the slider bar.
</p>
<a class="anchor" id="XREFuicontrolvalue"></a></dd>
<dt><a id="index-uicontrol-value"></a><span><code class="code">value</code>: scalar, def. <code class="code">0</code><a class="copiable-link" href="#index-uicontrol-value"> ¶</a></span></dt>
<dd><p>A numerical value associated with the current state of the control object, with the meaning of the value dependent on the "style" of the control object.
</p>
</dd>
</dl>
<a class="anchor" id="XREFuicontrolcategoryCreation_002fDeletion"></a><h4 class="subsubheading" id="Creation_002fDeletion-13"><span>Creation/Deletion<a class="copiable-link" href="#Creation_002fDeletion-13"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontrolbeingdeleted"></a></dd>
<dt><a id="index-uicontrol-beingdeleted"></a><span><code class="code">beingdeleted</code>: {<code class="code">"off"</code>} | <code class="code">"on"</code><a class="copiable-link" href="#index-uicontrol-beingdeleted"> ¶</a></span></dt>
<dd><p>Property indicating that a function has initiated deletion of the object. <code class="code">beingdeleted</code> is set to true until the object no longer exists.
</p>
<a class="anchor" id="XREFuicontrolcreatefcn"></a></dd>
<dt><a id="index-uicontrol-createfcn"></a><span><code class="code">createfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-uicontrol-createfcn"> ¶</a></span></dt>
<dd><p>Callback function executed immediately after uicontrol has been created. Function is set by using default property on root object, e.g., <code class="code">set (groot, "defaultuicontrolcreatefcn", 'disp ("uicontrol created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFuicontroldeletefcn"></a></dd>
<dt><a id="index-uicontrol-deletefcn"></a><span><code class="code">deletefcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-uicontrol-deletefcn"> ¶</a></span></dt>
<dd><p>Callback function executed immediately before uicontrol is deleted.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFuicontrolcategoryDisplay"></a><h4 class="subsubheading" id="Display-13"><span>Display<a class="copiable-link" href="#Display-13"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontrolclipping"></a></dd>
<dt><a id="index-uicontrol-clipping"></a><span><code class="code">clipping</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-uicontrol-clipping"> ¶</a></span></dt>
<dd><p>If <code class="code">clipping</code> is <code class="code">"on"</code>, the uicontrol is clipped in its parent axes limits.
</p>
<a class="anchor" id="XREFuicontrolvisible"></a></dd>
<dt><a id="index-uicontrol-visible"></a><span><code class="code">visible</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-uicontrol-visible"> ¶</a></span></dt>
<dd><p>If <code class="code">visible</code> is <code class="code">"off"</code>, the uicontrol is not rendered on screen.
</p>
</dd>
</dl>
<a class="anchor" id="XREFuicontrolcategoryMouseInteraction"></a><h4 class="subsubheading" id="Mouse-Interaction-14"><span>Mouse Interaction<a class="copiable-link" href="#Mouse-Interaction-14"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontrolbuttondownfcn"></a></dd>
<dt><a id="index-uicontrol-buttondownfcn"></a><span><code class="code">buttondownfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-uicontrol-buttondownfcn"> ¶</a></span></dt>
<dd><p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFuicontrolcontextmenu"></a></dd>
<dt><a id="index-uicontrol-contextmenu"></a><span><code class="code">contextmenu</code>: graphics handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-uicontrol-contextmenu"> ¶</a></span></dt>
<dd><p>Graphics handle of the uicontextmenu object that is currently associated to this uicontrol object.
</p>
<a class="anchor" id="XREFuicontrolhittest"></a></dd>
<dt><a id="index-uicontrol-hittest"></a><span><code class="code">hittest</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-uicontrol-hittest"> ¶</a></span></dt>
<dd><p>Specify whether uicontrol processes mouse events or passes them to ancestors of the object. When enabled, the object may respond to mouse clicks by evaluating the <code class="code">"buttondownfcn"</code>, showing the uicontextmenu, and eventually becoming the root <code class="code">"currentobject"</code>. This property is only relevant when the object can accept mouse clicks which is determined by the <code class="code">"pickableparts"</code> property. See <a class="xref" href="#XREFuicontrolpickableparts">pickableparts property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFuicontrolpickableparts"></a></dd>
<dt><a id="index-uicontrol-pickableparts"></a><span><code class="code">pickableparts</code>: <code class="code">"all"</code> | <code class="code">"none"</code> | {<code class="code">"visible"</code>}<a class="copiable-link" href="#index-uicontrol-pickableparts"> ¶</a></span></dt>
<dd><p>Specify whether uicontrol will accept mouse clicks. By default, <code class="code">pickableparts</code> is <code class="code">"visible"</code> and only visible parts of the uicontrol or its children may react to mouse clicks. When <code class="code">pickableparts</code> is <code class="code">"all"</code> both visible and invisible parts (or children) may react to mouse clicks. When <code class="code">pickableparts</code> is <code class="code">"none"</code> 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 <code class="code">"hittest"</code> property will determine how they are processed. See <a class="xref" href="#XREFuicontrolhittest">hittest property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFuicontrolselected"></a></dd>
<dt><a id="index-uicontrol-selected"></a><span><code class="code">selected</code>: {<code class="code">"off"</code>} | <code class="code">"on"</code><a class="copiable-link" href="#index-uicontrol-selected"> ¶</a></span></dt>
<dd><p>Property indicates whether this uicontrol is selected.
</p>
<a class="anchor" id="XREFuicontrolselectionhighlight"></a></dd>
<dt><a id="index-uicontrol-selectionhighlight"></a><span><code class="code">selectionhighlight</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-uicontrol-selectionhighlight"> ¶</a></span></dt>
<dd><p>If <code class="code">selectionhighlight</code> is <code class="code">"on"</code>, then the uicontrol’s selection state is visually highlighted.
</p>
<a class="anchor" id="XREFuicontroltooltipstring"></a></dd>
<dt><a id="index-uicontrol-tooltipstring"></a><span><code class="code">tooltipstring</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-uicontrol-tooltipstring"> ¶</a></span></dt>
<dd><p>A text string that appears in a tooltip when the mouse pointer hovers over the control object.
</p>
</dd>
</dl>
<a class="anchor" id="XREFuicontrolcategoryObjectIdentification"></a><h4 class="subsubheading" id="Object-Identification-15"><span>Object Identification<a class="copiable-link" href="#Object-Identification-15"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontroltag"></a></dd>
<dt><a id="index-uicontrol-tag"></a><span><code class="code">tag</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-uicontrol-tag"> ¶</a></span></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<a class="anchor" id="XREFuicontroltype"></a></dd>
<dt><a id="index-uicontrol-type"></a><span><code class="code">type</code> (read-only): string<a class="copiable-link" href="#index-uicontrol-type"> ¶</a></span></dt>
<dd><p>Class name of the graphics object. <code class="code">type</code> is always <code class="code">"uicontrol"</code>.
</p>
<a class="anchor" id="XREFuicontroluserdata"></a></dd>
<dt><a id="index-uicontrol-userdata"></a><span><code class="code">userdata</code>: Any Octave data, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-uicontrol-userdata"> ¶</a></span></dt>
<dd><p>User-defined data to associate with the graphics object.
</p>
</dd>
</dl>
<a class="anchor" id="XREFuicontrolcategoryObjectPosition"></a><h4 class="subsubheading" id="Object-Position-8"><span>Object Position<a class="copiable-link" href="#Object-Position-8"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontrolposition"></a></dd>
<dt><a id="index-uicontrol-position"></a><span><code class="code">position</code>: four-element vector, def. <code class="code">[0 0 80 30]</code><a class="copiable-link" href="#index-uicontrol-position"> ¶</a></span></dt>
<dd><p>Size of the control object represented as the four-element vector [left, bottom, width, height].
</p>
<a class="anchor" id="XREFuicontrolunits"></a></dd>
<dt><a id="index-uicontrol-units"></a><span><code class="code">units</code>: <code class="code">"centimeters"</code> | <code class="code">"characters"</code> | <code class="code">"inches"</code> | <code class="code">"normalized"</code> | {<code class="code">"pixels"</code>} | <code class="code">"points"</code><a class="copiable-link" href="#index-uicontrol-units"> ¶</a></span></dt>
<dd><p>Unit of measurement used to interpret the <code class="code">"position"</code> property.
</p>
</dd>
</dl>
<a class="anchor" id="XREFuicontrolcategoryParent_002fChildren"></a><h4 class="subsubheading" id="Parent_002fChildren-14"><span>Parent/Children<a class="copiable-link" href="#Parent_002fChildren-14"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontrolchildren"></a></dd>
<dt><a id="index-uicontrol-children"></a><span><code class="code">children</code> (read-only): vector of graphics handles, def. <code class="code">[](0x1)</code><a class="copiable-link" href="#index-uicontrol-children"> ¶</a></span></dt>
<dd><p>Graphics handles of the uicontrol’s children.
</p>
<a class="anchor" id="XREFuicontrolhandlevisibility"></a></dd>
<dt><a id="index-uicontrol-handlevisibility"></a><span><code class="code">handlevisibility</code>: <code class="code">"callback"</code> | <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-uicontrol-handlevisibility"> ¶</a></span></dt>
<dd><p>If <code class="code">handlevisibility</code> is <code class="code">"off"</code>, the uicontrol’s handle is not visible in its parent’s <code class="code">"children"</code> property.
</p>
<a class="anchor" id="XREFuicontrolparent"></a></dd>
<dt><a id="index-uicontrol-parent"></a><span><code class="code">parent</code>: graphics handle<a class="copiable-link" href="#index-uicontrol-parent"> ¶</a></span></dt>
<dd><p>Handle of the parent graphics object.
</p>
</dd>
</dl>
<a class="anchor" id="XREFuicontrolcategoryTextAppearance"></a><h4 class="subsubheading" id="Text-Appearance-5"><span>Text Appearance<a class="copiable-link" href="#Text-Appearance-5"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFuicontrolfontangle"></a></dd>
<dt><a id="index-uicontrol-fontangle"></a><span><code class="code">fontangle</code>: <code class="code">"italic"</code> | {<code class="code">"normal"</code>}<a class="copiable-link" href="#index-uicontrol-fontangle"> ¶</a></span></dt>
<dd><p>Control whether the font is italic or normal.
</p>
<a class="anchor" id="XREFuicontrolfontname"></a></dd>
<dt><a id="index-uicontrol-fontname"></a><span><code class="code">fontname</code>: string, def. <code class="code">"*"</code><a class="copiable-link" href="#index-uicontrol-fontname"> ¶</a></span></dt>
<dd><p>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 <code class="code">"*"</code> value).
</p>
<p>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 class="code">system ("fc-cache -fv")</code> manually after installing new fonts.
</p>
<a class="anchor" id="XREFuicontrolfontsize"></a></dd>
<dt><a id="index-uicontrol-fontsize"></a><span><code class="code">fontsize</code>: scalar, def. <code class="code">10</code><a class="copiable-link" href="#index-uicontrol-fontsize"> ¶</a></span></dt>
<dd><p>Size of the font used for text rendering. See <a class="xref" href="#XREFuicontrolfontunits">fontunits property</a>.
</p>
<a class="anchor" id="XREFuicontrolfontunits"></a></dd>
<dt><a id="index-uicontrol-fontunits"></a><span><code class="code">fontunits</code>: <code class="code">"centimeters"</code> | <code class="code">"inches"</code> | <code class="code">"normalized"</code> | <code class="code">"pixels"</code> | {<code class="code">"points"</code>}<a class="copiable-link" href="#index-uicontrol-fontunits"> ¶</a></span></dt>
<dd><p>Units used to interpret the <code class="code">"fontsize"</code> property.
</p>
<a class="anchor" id="XREFuicontrolfontweight"></a></dd>
<dt><a id="index-uicontrol-fontweight"></a><span><code class="code">fontweight</code>: <code class="code">"bold"</code> | {<code class="code">"normal"</code>}<a class="copiable-link" href="#index-uicontrol-fontweight"> ¶</a></span></dt>
<dd><p>Control the variant of the base font used for text rendering.
</p>
<a class="anchor" id="XREFuicontrolhorizontalalignment"></a></dd>
<dt><a id="index-uicontrol-horizontalalignment"></a><span><code class="code">horizontalalignment</code>: {<code class="code">"center"</code>} | <code class="code">"left"</code> | <code class="code">"right"</code><a class="copiable-link" href="#index-uicontrol-horizontalalignment"> ¶</a></span></dt>
<dd><p>Specifies the horizontal justification of the text within the uicontrol object.
</p>
<a class="anchor" id="XREFuicontrolstring"></a></dd>
<dt><a id="index-uicontrol-string"></a><span><code class="code">string</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-uicontrol-string"> ¶</a></span></dt>
<dd><p>The text appearing with the control object.
</p>
<a class="anchor" id="XREFuicontrolverticalalignment"></a></dd>
<dt><a id="index-uicontrol-verticalalignment"></a><span><code class="code">verticalalignment</code>: <code class="code">"bottom"</code> | {<code class="code">"middle"</code>} | <code class="code">"top"</code><a class="copiable-link" href="#index-uicontrol-verticalalignment"> ¶</a></span></dt>
<dd><p>Specifies the vertical position of the text in the uicontrol object.
</p>
</dd>
</dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Uitable-Properties.html">Uitable Properties</a>, Previous: <a href="Uipanel-Properties.html">Uipanel Properties</a>, Up: <a href="Graphics-Object-Properties.html">Graphics Object Properties</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
