1@c DO NOT EDIT! Generated automatically by genpropdoc.m. 2 3@c Copyright (C) 2014-2019 Pantxo Diribarne 4@c 5@c This file is part of Octave. 6@c 7@c Octave is free software: you can redistribute it and/or modify it 8@c under the terms of the GNU General Public License as published by 9@c the Free Software Foundation, either version 3 of the License, or 10@c (at your option) any later version. 11@c 12@c Octave is distributed in the hope that it will be useful, but 13@c WITHOUT ANY WARRANTY; without even the implied warranty of 14@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15@c GNU General Public License for more details. 16@c 17@c You should have received a copy of the GNU General Public License 18@c along with Octave; see the file COPYING. If not, see 19@c <https://www.gnu.org/licenses/>. 20 21Properties of @code{uipushtool} objects (@pxref{XREFuipushtool,,uipushtool}): 22 23@table @asis 24 25@anchor{XREFuipushtool__named_icon__} 26@prindex uipushtool __named_icon__ 27@item @code{__named_icon__}: def. @qcode{""} 28 29 30 31@anchor{XREFuipushtoolbeingdeleted} 32@prindex uipushtool beingdeleted 33@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"} 34 35 36 37@anchor{XREFuipushtoolbusyaction} 38@prindex uipushtool busyaction 39@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@} 40Define 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"}). 41@xref{Callbacks, , @w{Callbacks section}}. 42 43 44@anchor{XREFuipushtoolbuttondownfcn} 45@prindex uipushtool buttondownfcn 46@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)} 47@code{buttondownfcn} is unused. 48 49 50@anchor{XREFuipushtoolcdata} 51@prindex uipushtool cdata 52@item @code{cdata}: def. @code{[](0x0)} 53 54 55 56@anchor{XREFuipushtoolchildren} 57@prindex uipushtool children 58@item @code{children} (read-only): vector of graphics handles, def. @code{[](0x1)} 59Graphics handles of the uipushtool's children. 60 61 62@anchor{XREFuipushtoolclickedcallback} 63@prindex uipushtool clickedcallback 64@item @code{clickedcallback}: def. @code{[](0x0)} 65 66 67 68@anchor{XREFuipushtoolclipping} 69@prindex uipushtool clipping 70@item @code{clipping}: @qcode{"off"} | @{@qcode{"on"}@} 71If @code{clipping} is @qcode{"on"}, the uipushtool is clipped in its parent axes limits. 72 73 74@anchor{XREFuipushtoolcreatefcn} 75@prindex uipushtool createfcn 76@item @code{createfcn}: string | function handle, def. @code{[](0x0)} 77Callback function executed immediately after uipushtool has been created. Function is set by using default property on root object, e.g., @code{set (groot, "defaultuipushtoolcreatefcn", 'disp ("uipushtool created!")')}. 78 79For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}. 80 81 82@anchor{XREFuipushtooldeletefcn} 83@prindex uipushtool deletefcn 84@item @code{deletefcn}: string | function handle, def. @code{[](0x0)} 85Callback function executed immediately before uipushtool is deleted. 86 87For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}. 88 89 90@anchor{XREFuipushtoolenable} 91@prindex uipushtool enable 92@item @code{enable}: @qcode{"off"} | @{@qcode{"on"}@} 93 94 95 96@anchor{XREFuipushtoolhandlevisibility} 97@prindex uipushtool handlevisibility 98@item @code{handlevisibility}: @qcode{"callback"} | @qcode{"off"} | @{@qcode{"on"}@} 99If @code{handlevisibility} is @qcode{"off"}, the uipushtool's handle is not visible in its parent's "children" property. 100 101 102@anchor{XREFuipushtoolhittest} 103@prindex uipushtool hittest 104@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@} 105Specify whether uipushtool 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{XREFuipushtoolpickableparts, , @w{pickableparts property}}. 106 107 108@anchor{XREFuipushtoolinterruptible} 109@prindex uipushtool interruptible 110@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@} 111Specify 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. 112@xref{Callbacks, , @w{Callbacks section}}. 113 114 115@anchor{XREFuipushtoolparent} 116@prindex uipushtool parent 117@item @code{parent}: graphics handle 118Handle of the parent graphics object. 119 120 121@anchor{XREFuipushtoolpickableparts} 122@prindex uipushtool pickableparts 123@item @code{pickableparts}: @qcode{"all"} | @qcode{"none"} | @{@qcode{"visible"}@} 124Specify whether uipushtool will accept mouse clicks. By default, @code{pickableparts} is @qcode{"visible"} and only visible parts of the uipushtool 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{XREFuipushtoolhittest, , @w{hittest property}}. 125 126 127@anchor{XREFuipushtoolselected} 128@prindex uipushtool selected 129@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"} 130 131 132 133@anchor{XREFuipushtoolselectionhighlight} 134@prindex uipushtool selectionhighlight 135@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@} 136 137 138 139@anchor{XREFuipushtoolseparator} 140@prindex uipushtool separator 141@item @code{separator}: @{@qcode{"off"}@} | @qcode{"on"} 142 143 144 145@anchor{XREFuipushtooltag} 146@prindex uipushtool tag 147@item @code{tag}: string, def. @qcode{""} 148A user-defined string to label the graphics object. 149 150 151@anchor{XREFuipushtooltooltipstring} 152@prindex uipushtool tooltipstring 153@item @code{tooltipstring}: def. @qcode{""} 154 155 156 157@anchor{XREFuipushtooltype} 158@prindex uipushtool type 159@item @code{type} (read-only): string 160Class name of the graphics object. @code{type} is always @qcode{"uipushtool"} 161 162 163@anchor{XREFuipushtooluicontextmenu} 164@prindex uipushtool uicontextmenu 165@item @code{uicontextmenu}: graphics handle, def. @code{[](0x0)} 166Graphics handle of the uicontextmenu object that is currently associated to this uipushtool object. 167 168 169@anchor{XREFuipushtooluserdata} 170@prindex uipushtool userdata 171@item @code{userdata}: Any Octave data, def. @code{[](0x0)} 172User-defined data to associate with the graphics object. 173 174 175@anchor{XREFuipushtoolvisible} 176@prindex uipushtool visible 177@item @code{visible}: @qcode{"off"} | @{@qcode{"on"}@} 178If @code{visible} is @qcode{"off"}, the uipushtool is not rendered on screen. 179 180@end table