15.3.3.15 Uicontrol Properties

Properties of uicontrol objects (see uicontrol):

backgroundcolor: def. [0.9400 0.9400 0.9400]

beingdeleted: {"off"} | "on"

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.

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

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

callback: def. [](0x0)

cdata: def. [](0x0)

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

Graphics handles of the uicontrol’s children.

clipping: "off" | {"on"}

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

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

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

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

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

Callback function executed immediately before uicontrol is deleted.

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

enable: "inactive" | "off" | {"on"}

extent (read-only): four-element vector

Size of the text string associated to the uicontrol returned in the form [0 0 width height] (the two first elements are always zero).

For multi-line strings the returned width and height indicate the size of the rectangle enclosing all lines.

fontangle: "italic" | {"normal"} | "oblique"

Control whether the font is italic or normal.

fontname: string, def. "*"

Name of font used for text rendering. When setting this property, the text rendering engine will search for a matching font in your system. If none is found then text is rendered using a default sans serif font (same as the default "*" value).

Programming Note: On systems that don’t use FontConfig natively (all but Linux), the font cache is built when Octave is installed. You will need to run system ("fc-cache -fv") manually after installing new fonts.

fontsize: scalar, def. 10

Size of the font used for text rendering. See fontunits property.

fontunits: "centimeters" | "inches" | "normalized" | "pixels" | {"points"}

Units used to interpret the "fontsize" property.

fontweight: "bold" | {"normal"}

Control the variant of the base font used for text rendering.

foregroundcolor: def. [0 0 0]

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

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

hittest: "off" | {"on"}

Specify whether uicontrol 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.

horizontalalignment: {"center"} | "left" | "right"

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.

keypressfcn: def. [](0x0)

listboxtop: def. 1

max: def. 1

min: def. 0

parent: graphics handle

Handle of the parent graphics object.

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

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

position: def. [0 0 80 30]

selected: {"off"} | "on"

selectionhighlight: "off" | {"on"}

sliderstep: def. [0.010000 0.100000]

string: def. ""

style: "checkbox" | "edit" | "frame" | "listbox" | "popupmenu" | {"pushbutton"} | "radiobutton" | "slider" | "text" | "togglebutton"

tag: string, def. ""

A user-defined string to label the graphics object.

tooltipstring: def. ""

type (read-only): string

Class name of the graphics object. type is always "uicontrol"

uicontextmenu: graphics handle, def. [](0x0)

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

units: "centimeters" | "characters" | "inches" | "normalized" | {"pixels"} | "points"

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

User-defined data to associate with the graphics object.

value: def. 0

verticalalignment: "bottom" | {"middle"} | "top"

visible: "off" | {"on"}

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