File: Uicontextmenu-Properties.html

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 (201 lines) | stat: -rw-r--r-- 11,090 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
<!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>Uicontextmenu Properties (GNU Octave (version 6.2.0))</title>

<meta name="description" content="Uicontextmenu Properties (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Uicontextmenu 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="Uipanel-Properties.html" rel="next" title="Uipanel Properties">
<link href="Uibuttongroup-Properties.html" rel="prev" title="Uibuttongroup 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="Uicontextmenu-Properties"></span><div class="header">
<p>
Next: <a href="Uipanel-Properties.html" accesskey="n" rel="next">Uipanel Properties</a>, Previous: <a href="Uibuttongroup-Properties.html" accesskey="p" rel="prev">Uibuttongroup Properties</a>, Up: <a href="Graphics-Object-Properties.html" accesskey="u" rel="up">Graphics Object Properties</a> &nbsp; [<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="Uicontextmenu-Properties-1"></span><h4 class="subsubsection">15.3.3.13 Uicontextmenu Properties</h4>
<span id="index--Uicontextmenu-PropertiesUicontextmenu-Properties"></span>



<p>Properties of <code>uicontextmenu</code> objects (see <a href="UI-Elements.html#XREFuicontextmenu">uicontextmenu</a>):
</p>
<dl compact="compact">
<dd>
<span id="XREFuicontextmenubeingdeleted"></span><span id="index-uicontextmenu-beingdeleted"></span>
</dd>
<dt><code>beingdeleted</code>: {<code>&quot;off&quot;</code>} | <code>&quot;on&quot;</code></dt>
<dd>


<span id="XREFuicontextmenubusyaction"></span><span id="index-uicontextmenu-busyaction"></span>
</dd>
<dt><code>busyaction</code>: <code>&quot;cancel&quot;</code> | {<code>&quot;queue&quot;</code>}</dt>
<dd><p>Define how Octave handles the execution of this object&rsquo;s callback properties when it is unable to interrupt another object&rsquo;s executing callback.  This is only relevant when the currently executing callback object has its <code>interruptible</code> property set to <code>&quot;off&quot;</code>.  The <code>busyaction</code> property of the interrupting callback object indicates whether the interrupting callback is queued (<code>&quot;queue&quot;</code> (default)) or discarded (<code>&quot;cancel&quot;</code>).
See <a href="Callbacks.html">Callbacks&nbsp;section<!-- /@w --></a>.
</p>

<span id="XREFuicontextmenubuttondownfcn"></span><span id="index-uicontextmenu-buttondownfcn"></span>
</dd>
<dt><code>buttondownfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p><code>buttondownfcn</code> is unused.
</p>

<span id="XREFuicontextmenucallback"></span><span id="index-uicontextmenu-callback"></span>
</dd>
<dt><code>callback</code>: def. <code>[](0x0)</code></dt>
<dd>


<span id="XREFuicontextmenuchildren"></span><span id="index-uicontextmenu-children"></span>
</dd>
<dt><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></dt>
<dd><p>Graphics handles of the uicontextmenu&rsquo;s children.
</p>

<span id="XREFuicontextmenuclipping"></span><span id="index-uicontextmenu-clipping"></span>
</dd>
<dt><code>clipping</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p>If <code>clipping</code> is <code>&quot;on&quot;</code>, the uicontextmenu is clipped in its parent axes limits.
</p>

<span id="XREFuicontextmenucreatefcn"></span><span id="index-uicontextmenu-createfcn"></span>
</dd>
<dt><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately after uicontextmenu has been created.  Function is set by using default property on root object, e.g., <code>set (groot, &quot;defaultuicontextmenucreatefcn&quot;, 'disp (&quot;uicontextmenu created!&quot;)')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks&nbsp;section<!-- /@w --></a>.
</p>

<span id="XREFuicontextmenudeletefcn"></span><span id="index-uicontextmenu-deletefcn"></span>
</dd>
<dt><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately before uicontextmenu is deleted.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks&nbsp;section<!-- /@w --></a>.
</p>

<span id="XREFuicontextmenuhandlevisibility"></span><span id="index-uicontextmenu-handlevisibility"></span>
</dd>
<dt><code>handlevisibility</code>: <code>&quot;callback&quot;</code> | <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p>If <code>handlevisibility</code> is <code>&quot;off&quot;</code>, the uicontextmenu&rsquo;s handle is not visible in its parent&rsquo;s &quot;children&quot; property.
</p>

<span id="XREFuicontextmenuhittest"></span><span id="index-uicontextmenu-hittest"></span>
</dd>
<dt><code>hittest</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p>Specify whether uicontextmenu processes mouse events or passes them to ancestors of the object.  When enabled, the object may respond to mouse clicks by evaluating the <code>&quot;buttondownfcn&quot;</code>, showing the uicontextmenu, and eventually becoming the root <code>&quot;currentobject&quot;</code>.  This property is only relevant when the object can accept mouse clicks which is determined by the <code>&quot;pickableparts&quot;</code> property.  See <a href="#XREFuicontextmenupickableparts">pickableparts&nbsp;property<!-- /@w --></a>.
</p>

<span id="XREFuicontextmenuinterruptible"></span><span id="index-uicontextmenu-interruptible"></span>
</dd>
<dt><code>interruptible</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p>Specify whether this object&rsquo;s callback functions may be interrupted by other callbacks.  By default <code>interruptible</code> is <code>&quot;on&quot;</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&nbsp;section<!-- /@w --></a>.
</p>

<span id="XREFuicontextmenuparent"></span><span id="index-uicontextmenu-parent"></span>
</dd>
<dt><code>parent</code>: graphics handle</dt>
<dd><p>Handle of the parent graphics object.
</p>

<span id="XREFuicontextmenupickableparts"></span><span id="index-uicontextmenu-pickableparts"></span>
</dd>
<dt><code>pickableparts</code>: <code>&quot;all&quot;</code> | <code>&quot;none&quot;</code> | {<code>&quot;visible&quot;</code>}</dt>
<dd><p>Specify whether uicontextmenu will accept mouse clicks.  By default, <code>pickableparts</code> is <code>&quot;visible&quot;</code> and only visible parts of the uicontextmenu or its children may react to mouse clicks.  When <code>pickableparts</code> is <code>&quot;all&quot;</code> both visible and invisible parts (or children) may react to mouse clicks.  When <code>pickableparts</code> is <code>&quot;none&quot;</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>&quot;hittest&quot;</code> property will determine how they are processed.  See <a href="#XREFuicontextmenuhittest">hittest&nbsp;property<!-- /@w --></a>.
</p>

<span id="XREFuicontextmenuposition"></span><span id="index-uicontextmenu-position"></span>
</dd>
<dt><code>position</code>: def. <code>[0   0]</code></dt>
<dd>


<span id="XREFuicontextmenuselected"></span><span id="index-uicontextmenu-selected"></span>
</dd>
<dt><code>selected</code>: {<code>&quot;off&quot;</code>} | <code>&quot;on&quot;</code></dt>
<dd>


<span id="XREFuicontextmenuselectionhighlight"></span><span id="index-uicontextmenu-selectionhighlight"></span>
</dd>
<dt><code>selectionhighlight</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd>


<span id="XREFuicontextmenutag"></span><span id="index-uicontextmenu-tag"></span>
</dd>
<dt><code>tag</code>: string, def. <code>&quot;&quot;</code></dt>
<dd><p>A user-defined string to label the graphics object.
</p>

<span id="XREFuicontextmenutype"></span><span id="index-uicontextmenu-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>&quot;uicontextmenu&quot;</code>
</p>

<span id="XREFuicontextmenuuicontextmenu"></span><span id="index-uicontextmenu-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 uicontextmenu object.
</p>

<span id="XREFuicontextmenuuserdata"></span><span id="index-uicontextmenu-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="XREFuicontextmenuvisible"></span><span id="index-uicontextmenu-visible"></span>
</dd>
<dt><code>visible</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p>If <code>visible</code> is <code>&quot;off&quot;</code>, the uicontextmenu is not rendered on screen.
</p>
</dd>
</dl>


<hr>
<div class="header">
<p>
Next: <a href="Uipanel-Properties.html" accesskey="n" rel="next">Uipanel Properties</a>, Previous: <a href="Uibuttongroup-Properties.html" accesskey="p" rel="prev">Uibuttongroup Properties</a>, Up: <a href="Graphics-Object-Properties.html" accesskey="u" rel="up">Graphics Object Properties</a> &nbsp; [<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>