@c DO NOT EDIT!  Generated automatically by genpropdoc.m.

@c Copyright (C) 2014-2025 The Octave Project Developers
@c
@c See the file COPYRIGHT.md in the top-level directory of this
@c distribution or <https://octave.org/copyright/>.
@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{uipushtool} objects (@pxref{XREFuipushtool,,uipushtool}):

@subsubheading Categories:

@ref{XREFuipushtoolcategoryAppearance, , @w{Appearance}}@: | @ref{XREFuipushtoolcategoryCallbackExecution, , @w{Callback Execution}}@: | @ref{XREFuipushtoolcategoryCreation/Deletion, , @w{Creation/Deletion}}@: | @ref{XREFuipushtoolcategoryDisplay, , @w{Display}}@: | @ref{XREFuipushtoolcategoryMouseInteraction, , @w{Mouse Interaction}}@: | @ref{XREFuipushtoolcategoryObjectIdentification, , @w{Object Identification}}@: | @ref{XREFuipushtoolcategoryParent/Children, , @w{Parent/Children}}@: | @ref{XREFuipushtoolcategoryPushtoolOperation, , @w{Pushtool Operation}}@: 

@anchor{XREFuipushtoolcategoryAppearance}
@subsubheading Appearance

@table @asis

@anchor{XREFuipushtool__named_icon__}
@prindex uipushtool __named_icon__
@item @code{__named_icon__}: string, def. @qcode{""}
The name of an bundled icon file to use as the image for the pushtool object.


@anchor{XREFuipushtoolcdata}
@prindex uipushtool cdata
@item @code{cdata}: array, def. @code{[](0x0)}
Image data used to represent the pushtool object, stored as a M x N x 3 RGB array.


@anchor{XREFuipushtoolseparator}
@prindex uipushtool separator
@item @code{separator}: @{@qcode{"off"}@} | @qcode{"on"}
State indicating whether a separator line will be drawn next to the current pushtool position.

@end table

@anchor{XREFuipushtoolcategoryCallbackExecution}
@subsubheading Callback Execution

@table @asis

@anchor{XREFuipushtoolbusyaction}
@prindex uipushtool 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{XREFuipushtoolclickedcallback}
@prindex uipushtool clickedcallback
@item @code{clickedcallback}: string, def. @code{[](0x0)}
A string consisting of a valid Octave expression that will be executed whenever this control object is clicked.


@anchor{XREFuipushtoolinterruptible}
@prindex uipushtool 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}}.

@end table

@anchor{XREFuipushtoolcategoryCreation/Deletion}
@subsubheading Creation/Deletion

@table @asis

@anchor{XREFuipushtoolbeingdeleted}
@prindex uipushtool beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}
Property indicating that a function has initiated deletion of the object.  @code{beingdeleted} is set to true until the object no longer exists.


@anchor{XREFuipushtoolcreatefcn}
@prindex uipushtool createfcn
@item @code{createfcn}: string | function handle, def. @code{[](0x0)}
Callback 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!")')}.

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


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

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

@end table

@anchor{XREFuipushtoolcategoryDisplay}
@subsubheading Display

@table @asis

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


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

@end table

@anchor{XREFuipushtoolcategoryMouseInteraction}
@subsubheading Mouse Interaction

@table @asis

@anchor{XREFuipushtoolbuttondownfcn}
@prindex uipushtool buttondownfcn
@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)}
@code{buttondownfcn} is unused.


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


@anchor{XREFuipushtoolhittest}
@prindex uipushtool hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}
Specify 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}}.


@anchor{XREFuipushtoolpickableparts}
@prindex uipushtool pickableparts
@item @code{pickableparts}: @qcode{"all"} | @qcode{"none"} | @{@qcode{"visible"}@}
Specify 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}}.


@anchor{XREFuipushtoolselected}
@prindex uipushtool selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}
Property indicates whether this uipushtool is selected.


@anchor{XREFuipushtoolselectionhighlight}
@prindex uipushtool selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{selectionhighlight} is @qcode{"on"}, then the uipushtool's selection state is visually highlighted.


@anchor{XREFuipushtooltooltipstring}
@prindex uipushtool tooltipstring
@item @code{tooltipstring}: string, def. @qcode{""}
A text string that appears in a tooltip when the mouse pointer hovers over the pushtool object.

@end table

@anchor{XREFuipushtoolcategoryObjectIdentification}
@subsubheading Object Identification

@table @asis

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


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


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

@end table

@anchor{XREFuipushtoolcategoryParent/Children}
@subsubheading Parent/Children

@table @asis

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


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


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

@end table

@anchor{XREFuipushtoolcategoryPushtoolOperation}
@subsubheading Pushtool Operation

@table @asis

@anchor{XREFuipushtoolenable}
@prindex uipushtool enable
@item @code{enable}: @qcode{"off"} | @{@qcode{"on"}@}
Sets whether this pushtool object is active or is grayed out.

@end table