ToolbarPushButton - Axes toolbar push button appearance and behavior - MATLAB (original) (raw)

ToolbarPushButton Properties

Axes toolbar push button appearance and behavior

ToolbarPushButton properties control the appearance and behavior of the axes ToolbarPushButton object. By changing property values, you can modify certain aspects of the push button.

tb = axtoolbar('default') btn = axtoolbarbtn(tb,'push') btn.Tooltip = 'My Push Button';

expand all

Icon — Button icon

'none' (default) | file name | m-by-n-by-3 array | m-by-n matrix | predefined icon

Button icon, specified as one of these values. The axes toolbar displays icons as grayscale images. MATLAB® scales down the image to fit, if necessary.

• File name — Specify the file name as a character vector or a string scalar. The file name can be preceded by a path. The image file must be in JPEG, GIF, or PNG format.
• Array — Specify an m-by-n-by-3 array of RGB triplets that represent pixels in an image.
• Matrix — Specify an m-by-n matrix of numeric values that represent pixels in an image.
  • If the values are of an integer type, then specify values between 0 and 63. A value of 0 is opaque and a value of63 is transparent. NaN is also transparent.
  • If the values are of type double, then specify values between 1 and64. A value of 1 is opaque and a value of 64 is transparent.NaN is also transparent.
• Predefined icon — Specify one of the names in this table.

  Icon Name	Result
  'brush'
  'datacursor'
  'export'
  'rotate'
  'pan'
  'zoomin'
  'zoomout'
  'restoreview'
  'none'	No icon

Example: btn.Icon = 'icon.png'

Example: btn.Icon = 'C:\Documents\icon.png'

Example: btn.Icon = 'rotate'

Tooltip — Button tool tip

'' (default) | character vector | cell array of character vectors | string array

Button tool tip, specified as a character vector, cell array of character vectors, or a string array. Use this property to display a message when you hover the pointer over the button. To display multiple lines of text, specify a cell array of character vectors or a string array. Each element in the array displays a separate line of text.

Example: btn.Tooltip = 'My Tooltip'

State of visibility, specified as "on" or "off", or as numeric or logical 1 (true) or0 (false). A value of "on" is equivalent to true, and "off" is equivalent tofalse. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• "on" — Display the object.
• "off" — Hide the object without deleting it. You still can access the properties of an invisible object.

Callbacks

expand all

ButtonPushedFcn — Push button callback

'' (default) | function handle | cell array | character vector

Push button callback that executes when you click the button, specified as one of these values:

• A function handle.
• A cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.
• A character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.

If you specify this property using a function handle, then MATLAB passes the source PushButton object and an event data structure as the first and second input arguments to the function. This table describes the fields in the event data structure.

Object creation function, specified as one of these values:

• Function handle.
• Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.
• Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.

For more information about specifying a callback as a function handle, cell array, or character vector, see Create Callbacks for Graphics Objects.

This property specifies a callback function to execute when MATLAB creates the object. MATLAB initializes all property values before executing the CreateFcn callback. If you do not specify the CreateFcn property, then MATLAB executes a default creation function.

Setting the CreateFcn property on an existing component has no effect.

If you specify this property as a function handle or cell array, you can access the object that is being created using the first argument of the callback function. Otherwise, use the gcbo function to access the object.

Object deletion function, specified as one of these values:

• Function handle.
• Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.
• Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.

For more information about specifying a callback as a function handle, cell array, or character vector, see Create Callbacks for Graphics Objects.

This property specifies a callback function to execute when MATLAB deletes the object. MATLAB executes the DeleteFcn callback before destroying the properties of the object. If you do not specify the DeleteFcn property, then MATLAB executes a default deletion function.

If you specify this property as a function handle or cell array, you can access the object that is being deleted using the first argument of the callback function. Otherwise, use the gcbo function to access the object.

Callback Execution Control

expand all

Callback interruption, specified as 'on' or 'off', or as numeric or logical 1 (true) or0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent tofalse. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

This property determines if a running callback can be interrupted. There are two callback states to consider:

• The running callback is the currently executing callback.
• The interrupting callback is a callback that tries to interrupt the running callback.

MATLAB determines callback interruption behavior whenever it executes a command that processes the callback queue. These commands include drawnow, figure, uifigure, getframe, waitfor, and pause.

If the running callback does not contain one of these commands, then no interruption occurs. MATLAB first finishes executing the running callback, and later executes the interrupting callback.

If the running callback does contain one of these commands, then theInterruptible property of the object that owns the running callback determines if the interruption occurs:

• If the value of Interruptible is'off', then no interruption occurs. Instead, theBusyAction property of the object that owns the interrupting callback determines if the interrupting callback is discarded or added to the callback queue.
• If the value of Interruptible is 'on', then the interruption occurs. The next time MATLAB processes the callback queue, it stops the execution of the running callback and executes the interrupting callback. After the interrupting callback completes, MATLAB then resumes executing the running callback.

Note

Callback interruption and execution behave differently in these situations:

• If the interrupting callback is a DeleteFcn,CloseRequestFcn, orSizeChangedFcn callback, then the interruption occurs regardless of the Interruptible property value.
• If the running callback is currently executing thewaitfor function, then the interruption occurs regardless of the Interruptible property value.
• If the interrupting callback is owned by a Timer object, then the callback executes according to schedule regardless of the Interruptible property value.

Note

When an interruption occurs, MATLAB does not save the state of properties or the display. For example, the object returned by the gca or gcf command might change when another callback executes.

Callback queuing, specified as 'queue' or 'cancel'. The BusyAction property determines how MATLAB handles the execution of interrupting callbacks. There are two callback states to consider:

• The running callback is the currently executing callback.
• The interrupting callback is a callback that tries to interrupt the running callback.

The BusyAction property determines callback queuing behavior only when both of these conditions are met:

• The running callback contains a command that processes the callback queue, such as drawnow, figure, uifigure, getframe, waitfor, or pause.
• The value of the Interruptible property of the object that owns the running callback is 'off'.

Under these conditions, the BusyAction property of the object that owns the interrupting callback determines how MATLAB handles the interrupting callback. These are possible values of theBusyAction property:

• 'queue' — Puts the interrupting callback in a queue to be processed after the running callback finishes execution.
• 'cancel' — Does not execute the interrupting callback.

This property is read-only.

Deletion status, returned as an on/off logical value of type matlab.lang.OnOffSwitchState.

MATLAB sets the BeingDeleted property to'on' when the DeleteFcn callback begins execution. The BeingDeleted property remains set to'on' until the component object no longer exists.

Check the value of the BeingDeleted property to verify that the object is not about to be deleted before querying or modifying it.

Parent/Child

expand all

Parent — Parent

AxesToolbar object

Parent container, specified as an AxesToolbar object.

Children — Children

empty GraphicsPlaceholder array

This object has no children. You cannot set this property.

Visibility of the object handle in the Children property of the parent, specified as one of these values:

• "on" — Object handle is always visible.
• "off" — Object handle is invisible at all times. This option is useful for preventing unintended changes by another function. SetHandleVisibility to"off" to temporarily hide the handle during the execution of that function.
• "callback" — Object handle is visible from within callbacks or functions invoked by callbacks, but not from within functions invoked from the command line. This option blocks access to the object at the command line, but permits callback functions to access it.

If the object is not listed in the Children property of the parent, then functions that obtain object handles by searching the object hierarchy or querying handle properties cannot return it. Examples of such functions include theget, findobj, gca, gcf, gco, newplot, cla, clf, and close functions.

Hidden object handles are still valid. Set the root ShowHiddenHandles property to "on" to list all object handles regardless of theirHandleVisibility property setting.

Identifiers

expand all

Type — Type of graphics object

'toolbarpushbutton' (default)

This property is read-only.

Type of graphics object, returned as 'toolbarpushbutton'.

Object identifier, specified as a character vector or string scalar. You can specify a unique Tag value to serve as an identifier for an object. When you need access to the object elsewhere in your code, you can use the findobj function to search for the object based on the Tag value.

User data, specified as any MATLAB array. For example, you can specify a scalar, vector, matrix, cell array, character array, table, or structure. Use this property to store arbitrary data on an object.

If you are working in App Designer, create public or private properties in the app to share data instead of using the UserData property. For more information, see Share Data Within App Designer Apps.

Unused Properties

expand all

— Context menu

empty GraphicsPlaceholder array (default) | ContextMenu object

Setting this property has no effect on objects of this type.

ButtonDownFcn — Mouse-click callback

'' (default) | function handle | cell array | character vector

Mouse-click callback, specified as a function handle, a cell array, or a character vector.

Note

The button does not use this property.

Version History

Introduced in R2018b