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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Uitable Properties (GNU Octave (version 6.2.0))</title>
<meta name="description" content="Uitable Properties (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Uitable Properties (GNU Octave (version 6.2.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<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="Uitoolbar-Properties.html" rel="next" title="Uitoolbar Properties">
<link href="Uicontrol-Properties.html" rel="prev" title="Uicontrol Properties">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<span id="Uitable-Properties"></span><div class="header">
<p>
Next: <a href="Uitoolbar-Properties.html" accesskey="n" rel="next">Uitoolbar Properties</a>, Previous: <a href="Uicontrol-Properties.html" accesskey="p" rel="prev">Uicontrol 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>
<span id="Uitable-Properties-1"></span><h4 class="subsubsection">15.3.3.16 Uitable Properties</h4>
<span id="index-uitable-properties"></span>
<p>Properties of <code>uitable</code> objects (see <a href="UI-Elements.html#XREFuitable">uitable</a>):
</p>
<dl compact="compact">
<dd>
<span id="XREFuitablebackgroundcolor"></span><span id="index-uitable-backgroundcolor"></span>
</dd>
<dt><code>backgroundcolor</code>: def. 2-by-3 double</dt>
<dd>
<span id="XREFuitablebeingdeleted"></span><span id="index-uitable-beingdeleted"></span>
</dd>
<dt><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<span id="XREFuitablebusyaction"></span><span id="index-uitable-busyaction"></span>
</dd>
<dt><code>busyaction</code>: <code>"cancel"</code> | {<code>"queue"</code>}</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>interruptible</code> property set to <code>"off"</code>. The <code>busyaction</code> property of the interrupting callback object indicates whether the interrupting callback is queued (<code>"queue"</code> (default)) or discarded (<code>"cancel"</code>).
See <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFuitablebuttondownfcn"></span><span id="index-uitable-buttondownfcn"></span>
</dd>
<dt><code>buttondownfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFuitablecelleditcallback"></span><span id="index-uitable-celleditcallback"></span>
</dd>
<dt><code>celleditcallback</code>: def. <code>[](0x0)</code></dt>
<dd>
<span id="XREFuitablecellselectioncallback"></span><span id="index-uitable-cellselectioncallback"></span>
</dd>
<dt><code>cellselectioncallback</code>: def. <code>[](0x0)</code></dt>
<dd>
<span id="XREFuitablechildren"></span><span id="index-uitable-children"></span>
</dd>
<dt><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></dt>
<dd><p>Graphics handles of the uitable’s children.
</p>
<span id="XREFuitableclipping"></span><span id="index-uitable-clipping"></span>
</dd>
<dt><code>clipping</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>clipping</code> is <code>"on"</code>, the uitable is clipped in its parent axes limits.
</p>
<span id="XREFuitablecolumneditable"></span><span id="index-uitable-columneditable"></span>
</dd>
<dt><code>columneditable</code>: def. <code>[](0x0)</code></dt>
<dd>
<span id="XREFuitablecolumnformat"></span><span id="index-uitable-columnformat"></span>
</dd>
<dt><code>columnformat</code>: def. <code>{}(0x0)</code></dt>
<dd>
<span id="XREFuitablecolumnname"></span><span id="index-uitable-columnname"></span>
</dd>
<dt><code>columnname</code>: def. <code>"numbered"</code></dt>
<dd>
<span id="XREFuitablecolumnwidth"></span><span id="index-uitable-columnwidth"></span>
</dd>
<dt><code>columnwidth</code>: def. <code>"auto"</code></dt>
<dd>
<span id="XREFuitablecreatefcn"></span><span id="index-uitable-createfcn"></span>
</dd>
<dt><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately after uitable has been created. Function is set by using default property on root object, e.g., <code>set (groot, "defaultuitablecreatefcn", 'disp ("uitable created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFuitabledata"></span><span id="index-uitable-data"></span>
</dd>
<dt><code>data</code>: def. <code>[](0x0)</code></dt>
<dd>
<span id="XREFuitabledeletefcn"></span><span id="index-uitable-deletefcn"></span>
</dd>
<dt><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately before uitable is deleted.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFuitableenable"></span><span id="index-uitable-enable"></span>
</dd>
<dt><code>enable</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<span id="XREFuitableextent"></span><span id="index-uitable-extent"></span>
</dd>
<dt><code>extent</code> (read-only): four-element vector</dt>
<dd>
<span id="XREFuitablefontangle"></span><span id="index-uitable-fontangle"></span>
</dd>
<dt><code>fontangle</code>: <code>"italic"</code> | {<code>"normal"</code>} | <code>"oblique"</code></dt>
<dd><p>Control whether the font is italic or normal.
</p>
<span id="XREFuitablefontname"></span><span id="index-uitable-fontname"></span>
</dd>
<dt><code>fontname</code>: string, def. <code>"*"</code></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>"*"</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>system ("fc-cache -fv")</code> manually after installing new fonts.
</p>
<span id="XREFuitablefontsize"></span><span id="index-uitable-fontsize"></span>
</dd>
<dt><code>fontsize</code>: scalar, def. <code>10</code></dt>
<dd><p>Size of the font used for text rendering. See <a href="#XREFuitablefontunits">fontunits property</a>.
</p>
<span id="XREFuitablefontunits"></span><span id="index-uitable-fontunits"></span>
</dd>
<dt><code>fontunits</code>: <code>"centimeters"</code> | <code>"inches"</code> | <code>"normalized"</code> | <code>"pixels"</code> | {<code>"points"</code>}</dt>
<dd><p>Units used to interpret the <code>"fontsize"</code> property.
</p>
<span id="XREFuitablefontweight"></span><span id="index-uitable-fontweight"></span>
</dd>
<dt><code>fontweight</code>: <code>"bold"</code> | {<code>"normal"</code>}</dt>
<dd><p>Control the variant of the base font used for text rendering.
</p>
<span id="XREFuitableforegroundcolor"></span><span id="index-uitable-foregroundcolor"></span>
</dd>
<dt><code>foregroundcolor</code>: def. <code>[0 0 0]</code></dt>
<dd>
<span id="XREFuitablehandlevisibility"></span><span id="index-uitable-handlevisibility"></span>
</dd>
<dt><code>handlevisibility</code>: <code>"callback"</code> | <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>handlevisibility</code> is <code>"off"</code>, the uitable’s handle is not visible in its parent’s "children" property.
</p>
<span id="XREFuitablehittest"></span><span id="index-uitable-hittest"></span>
</dd>
<dt><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Specify whether uitable processes mouse events or passes them to ancestors of the object. When enabled, the object may respond to mouse clicks by evaluating the <code>"buttondownfcn"</code>, showing the uicontextmenu, and eventually becoming the root <code>"currentobject"</code>. This property is only relevant when the object can accept mouse clicks which is determined by the <code>"pickableparts"</code> property. See <a href="#XREFuitablepickableparts">pickableparts property<!-- /@w --></a>.
</p>
<span id="XREFuitableinterruptible"></span><span id="index-uitable-interruptible"></span>
</dd>
<dt><code>interruptible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Specify whether this object’s callback functions may be interrupted by other callbacks. By default <code>interruptible</code> is <code>"on"</code> and callbacks that make use of <code>drawnow</code>, <code>figure</code>, <code>waitfor</code>, <code>getframe</code> or <code>pause</code> functions are eventually interrupted.
See <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFuitablekeypressfcn"></span><span id="index-uitable-keypressfcn"></span>
</dd>
<dt><code>keypressfcn</code>: def. <code>[](0x0)</code></dt>
<dd>
<span id="XREFuitablekeyreleasefcn"></span><span id="index-uitable-keyreleasefcn"></span>
</dd>
<dt><code>keyreleasefcn</code>: def. <code>[](0x0)</code></dt>
<dd>
<span id="XREFuitableparent"></span><span id="index-uitable-parent"></span>
</dd>
<dt><code>parent</code>: graphics handle</dt>
<dd><p>Handle of the parent graphics object.
</p>
<span id="XREFuitablepickableparts"></span><span id="index-uitable-pickableparts"></span>
</dd>
<dt><code>pickableparts</code>: <code>"all"</code> | <code>"none"</code> | {<code>"visible"</code>}</dt>
<dd><p>Specify whether uitable will accept mouse clicks. By default, <code>pickableparts</code> is <code>"visible"</code> and only visible parts of the uitable or its children may react to mouse clicks. When <code>pickableparts</code> is <code>"all"</code> both visible and invisible parts (or children) may react to mouse clicks. When <code>pickableparts</code> is <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>"hittest"</code> property will determine how they are processed. See <a href="#XREFuitablehittest">hittest property<!-- /@w --></a>.
</p>
<span id="XREFuitableposition"></span><span id="index-uitable-position"></span>
</dd>
<dt><code>position</code>: def. <code>[20 20 300 300]</code></dt>
<dd>
<span id="XREFuitablerearrangeablecolumns"></span><span id="index-uitable-rearrangeablecolumns"></span>
</dd>
<dt><code>rearrangeablecolumns</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<span id="XREFuitablerowname"></span><span id="index-uitable-rowname"></span>
</dd>
<dt><code>rowname</code>: def. <code>"numbered"</code></dt>
<dd>
<span id="XREFuitablerowstriping"></span><span id="index-uitable-rowstriping"></span>
</dd>
<dt><code>rowstriping</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<span id="XREFuitableselected"></span><span id="index-uitable-selected"></span>
</dd>
<dt><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<span id="XREFuitableselectionhighlight"></span><span id="index-uitable-selectionhighlight"></span>
</dd>
<dt><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<span id="XREFuitabletag"></span><span id="index-uitable-tag"></span>
</dd>
<dt><code>tag</code>: string, def. <code>""</code></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<span id="XREFuitabletooltipstring"></span><span id="index-uitable-tooltipstring"></span>
</dd>
<dt><code>tooltipstring</code>: def. <code>""</code></dt>
<dd>
<span id="XREFuitabletype"></span><span id="index-uitable-type"></span>
</dd>
<dt><code>type</code> (read-only): string</dt>
<dd><p>Class name of the graphics object. <code>type</code> is always <code>"uitable"</code>
</p>
<span id="XREFuitableuicontextmenu"></span><span id="index-uitable-uicontextmenu"></span>
</dd>
<dt><code>uicontextmenu</code>: graphics handle, def. <code>[](0x0)</code></dt>
<dd><p>Graphics handle of the uicontextmenu object that is currently associated to this uitable object.
</p>
<span id="XREFuitableunits"></span><span id="index-uitable-units"></span>
</dd>
<dt><code>units</code>: <code>"centimeters"</code> | <code>"characters"</code> | <code>"inches"</code> | <code>"normalized"</code> | {<code>"pixels"</code>} | <code>"points"</code></dt>
<dd>
<span id="XREFuitableuserdata"></span><span id="index-uitable-userdata"></span>
</dd>
<dt><code>userdata</code>: Any Octave data, def. <code>[](0x0)</code></dt>
<dd><p>User-defined data to associate with the graphics object.
</p>
<span id="XREFuitablevisible"></span><span id="index-uitable-visible"></span>
</dd>
<dt><code>visible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>visible</code> is <code>"off"</code>, the uitable is not rendered on screen.
</p>
</dd>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="Uitoolbar-Properties.html" accesskey="n" rel="next">Uitoolbar Properties</a>, Previous: <a href="Uicontrol-Properties.html" accesskey="p" rel="prev">Uicontrol 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>
</body>
</html>
|