Uipushtool Properties (GNU Octave (version 10.3.0))

#### 15.3.3.19 Uipushtool Properties ¶

Properties of `uipushtool` objects (see uipushtool):

#### Categories: ¶

Appearance | Callback Execution | Creation/Deletion | Display | Mouse Interaction | Object Identification | Parent/Children | Pushtool Operation

#### Appearance ¶

`__named_icon__`: string, def. `""` ¶

  The name of an bundled icon file to use as the image for the pushtool object.

`cdata`: array, def. `[](0x0)` ¶

  Image data used to represent the pushtool object, stored as a M x N x 3 RGB array.

`separator`: {`"off"`} | `"on"` ¶

  State indicating whether a separator line will be drawn next to the current pushtool position.

#### Callback Execution ¶

`busyaction`: `"cancel"` | {`"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 `interruptible` property set to `"off"`. The `busyaction` property of the interrupting callback object indicates whether the interrupting callback is queued (`"queue"` (default)) or discarded (`"cancel"`). See Callbacks section.

`clickedcallback`: string, def. `[](0x0)` ¶

  A string consisting of a valid Octave expression that will be executed whenever this control object is clicked.

`interruptible`: `"off"` | {`"on"`} ¶

  Specify whether this object’s callback functions may be interrupted by other callbacks. By default `interruptible` is `"on"` and callbacks that make use of `drawnow`, `figure`, `waitfor`, `getframe` or `pause` functions are eventually interrupted. See Callbacks section.

#### Creation/Deletion ¶

`beingdeleted`: {`"off"`} | `"on"` ¶

  Property indicating that a function has initiated deletion of the object. `beingdeleted` is set to true until the object no longer exists.

`createfcn`: string | function handle, def. `[](0x0)` ¶

  Callback function executed immediately after uipushtool has been created. Function is set by using default property on root object, e.g., `set (groot, "defaultuipushtoolcreatefcn", 'disp ("uipushtool created!")')`.

  For information on how to write graphics listener functions see Callbacks section.

`deletefcn`: string | function handle, def. `[](0x0)` ¶

  Callback function executed immediately before uipushtool is deleted.

  For information on how to write graphics listener functions see Callbacks section.

#### Display ¶

`clipping`: `"off"` | {`"on"`} ¶

  If `clipping` is `"on"`, the uipushtool is clipped in its parent axes limits.

`visible`: `"off"` | {`"on"`} ¶

  If `visible` is `"off"`, the uipushtool is not rendered on screen.

#### Mouse Interaction ¶

`buttondownfcn`: string | function handle, def. `[](0x0)` ¶

  `buttondownfcn` is unused.

`contextmenu`: graphics handle, def. `[](0x0)` ¶

  Graphics handle of the uicontextmenu object that is currently associated to this uipushtool object.

`hittest`: `"off"` | {`"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 `"buttondownfcn"`, showing the uicontextmenu, and eventually becoming the root `"currentobject"`. This property is only relevant when the object can accept mouse clicks which is determined by the `"pickableparts"` property. See pickableparts property.

`pickableparts`: `"all"` | `"none"` | {`"visible"`} ¶

  Specify whether uipushtool will accept mouse clicks. By default, `pickableparts` is `"visible"` and only visible parts of the uipushtool or its children may react to mouse clicks. When `pickableparts` is `"all"` both visible and invisible parts (or children) may react to mouse clicks. When `pickableparts` is `"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 `"hittest"` property will determine how they are processed. See hittest property.

`selected`: {`"off"`} | `"on"` ¶

  Property indicates whether this uipushtool is selected.

`selectionhighlight`: `"off"` | {`"on"`} ¶

  If `selectionhighlight` is `"on"`, then the uipushtool’s selection state is visually highlighted.

`tooltipstring`: string, def. `""` ¶

  A text string that appears in a tooltip when the mouse pointer hovers over the pushtool object.

#### Object Identification ¶

`tag`: string, def. `""` ¶

  A user-defined string to label the graphics object.

`type` (read-only): string ¶

  Class name of the graphics object. `type` is always `"uipushtool"`.

`userdata`: Any Octave data, def. `[](0x0)` ¶

  User-defined data to associate with the graphics object.

#### Parent/Children ¶

`children` (read-only): vector of graphics handles, def. `[](0x1)` ¶

  Graphics handles of the uipushtool’s children.

`handlevisibility`: `"callback"` | `"off"` | {`"on"`} ¶

  If `handlevisibility` is `"off"`, the uipushtool’s handle is not visible in its parent’s `"children"` property.

`parent`: graphics handle ¶

  Handle of the parent graphics object.

#### Pushtool Operation ¶

`enable`: `"off"` | {`"on"`} ¶

  Sets whether this pushtool object is active or is grayed out.