Uimenu Properties

Properties of uimenu objects (see uimenu):


Appearance | Callback Execution | Creation/Deletion | Display | Keyboard Interaction | Menu Options | Mouse Interaction | Object Identification | Object Position | Parent/Children


foregroundcolor: colorspec, def. [0 0 0]

The color value of the text for this menu entry.

separator: {"off"} | "on"

State indicating whether a separator line will be drawn above the current menu 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.

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.

menuselectedfcn: string | function handle, def. [](0x0)

Function that is called when this menu item is executed. For information on how to write graphics listener functions see Callbacks section.


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 uimenu has been created. Function is set by using default property on root object, e.g., set (groot, "defaultuimenucreatefcn", 'disp ("uimenu created!")').

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

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

Callback function executed immediately before uimenu is deleted.

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


clipping: "off" | {"on"}

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

visible: "off" | {"on"}

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

Keyboard Interaction

accelerator: character, def. ""

A character that when pressed together with CTRL will execute this menu entry (e.g., "x" for CTRL+x).

checked: {"off"} | "on"

Sets whether or not a mark appears at this menu entry.

enable: "off" | {"on"}

Sets whether this menu entry is active or is grayed out.

text: string, def. ""

The text for this menu entry. A "&" character can be used to mark the "accelerator" key

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 uimenu object.

hittest: "off" | {"on"}

Specify whether uimenu 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 uimenu will accept mouse clicks. By default, pickableparts is "visible" and only visible parts of the uimenu 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 uimenu is selected.

selectionhighlight: "off" | {"on"}

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

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 "uimenu".

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

User-defined data to associate with the graphics object.

Object Position

position: scalar, def. 4

A scalar value containing the relative menu position from the left or top depending on the orientation of the menu.


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

Graphics handles of the uimenu’s children.

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

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

parent: graphics handle

Handle of the parent graphics object.