MATLAB Function Reference Previous page   Next Page
Uitoolbar Properties

Modifying Properties

You can set and query graphics object properties in two ways:

You can set default Uitoolbar properties by typing:

Where h can be the root handle (0), a figure handle, or a uitoolbar handle. PropertyName is the name of the Uitoolbar property and PropertyValue is the value you specify as the default for that property.

For more information about changing the default value of a property see Setting Default Property Values.

Uitoolbar Properties

This section lists all properties useful to uitoolbar objects along with valid values and a descriptions of their use. Curly braces { } enclose default values.

Property 
Purpose
BeingDeleted
This object is being deleted.
BusyAction
Callback routine interruption.
Children
Handles of uitoolbar's children.
CreateFcn
Callback routine executed during object creation.
DeleteFcn
Callback routine executed during object deletion.
HandleVisibility
Control access to object's handle.
Interruptible
Callback routine interruption mode.
Parent
Handle of uitoolbar's parent.
Tag
User-specified object identifier.
Type
Object class.
UserData
User specified data.
Visible
Uitoolbar visibility.

BeingDeleted                 on | {off} (read-only)

This object is being deleted. The BeingDeleted property provides a mechanism that you can use to determine if objects are in the process of being deleted. MATLAB sets the BeingDeleted property to on when the object's delete function callback is called (see the DeleteFcn property) It remains set to on while the delete function executes, after which the object no longer exists.

For example, some functions may not need to perform actions on objects that are being deleted, and therefore, can check the object's BeingDeleted property before acting.

BusyAction                   cancel | {queue}

Callback routine interruption. If a callback is executing and the user triggers an event (such as a mouse click) on an object for which a callback is defined, the callback associated with the new event uses the value of BusyAction to decide whether or not to attempt to interrupt the executing callback.

Children                     vector of handles

Handles of tools on the toolbar. A vector containing the handles of all children of the uitoolbar object, in the order in which they appear on the toolbar. The children objects of uitoolbars are uipushtools and uitoggletools. You can use this property to reorder the children.

CreateFcn                    string or function handle

Callback routine executed during object creation. The specified function executes when MATLAB creates a uitoolbar object. MATLAB sets all property values for the uitoolbar before executing the CreateFcn callback so these values are available to the callback. Within the function, use gcbo to get the handle of the toolbar being created.

Setting this property on an existing uitoolbar object has no effect.

You can define a default CreateFcn callback for all new uitoolbars. This default applies unless you override it by specifying a different CreateFcn callback when you call uitoolbar. For example, the statement,

creates a default CreateFcn callback that runs whenever you create a new toolbar. It sets the toolbar visibility to off.

To override this default and create a toolbar whose Visibility property is set to on, you could call uitoolbar with a call similar to

See Function Handle Callbacks for information on how to use function handles to define a callback function.

DeleteFcn                    string or function handle

Callback routine executed during object deletion. A callback function that executes when the uitoolbar object is deleted (e.g., when you call the delete function or cause the figure containing the uitoolbar to reset). MATLAB executes the routine before destroying the object's properties so these values are available to the callback routine.

Within the function, use gcbo to get the handle of the toolbar being deleted.

HandleVisibility             {on} | callback | off

Control access to object's handle. This property determines when an object's handle is visible in its parent's list of children. When a handle is not visible in its parent's list of children, it is not returned by functions that obtain handles by searching the object hierarchy or querying handle properties. This includes get, findobj, gca, gcf, gco, newplot, cla, clf, and close. Neither is the handle visible in the parent figure's CurrentObject property. Handles that are hidden are still valid. If you know an object's handle, you can set and get its properties, and pass it to any function that operates on handles.

You can set the root ShowHiddenHandles property to on to make all handles visible, regardless of their HandleVisibility settings. This does not affect the values of the HandleVisibility properties.

Interruptible                {on} | off

Callback routine interruption mode. If a callback is executing and the user triggers an event (such as a mouse click) on an object for which a callback is defined, that callback attempts to interrupt the first callback. MATLAB processes the callbacks according to these factors:

If the Interruptible property of the object whose callback is executing is on (the default), the callback can be interrupted. Whenever the callback calls one of the drawnow, figure, getframe, pause, or waitfor functions, the function processes any events in the event queue, including the waiting callback, before performing its defined task.

If the Interruptible property of the object whose callback is executing is off, the callback cannot be interrupted (except by certain callbacks; see the note below). The BusyAction property of the object whose callback is waiting to execute determines what happens to the callback.

Parent                       handle

Uitoolbar parent. The handle of the uitoolbar's parent figure. You can move a uitoolbar object to another figure by setting this property to the handle of the new parent.

Tag                          string

User-specified object identifier. The Tag property provides a means to identify graphics objects with a user-specified label. You can define Tag as any string.

With the findobj function, you can locate an object with a given Tag property value. This saves you from defining object handles as global variables. For example, this function call returns the handles of all children (of the specified figures) that have the Tag value 'FormatTb'.

Type                         string (read-only)

Object class. This property identifies the kind of graphics object. For uitoolbar objects, Type is always the string 'uitoolbar'.

UserData                     array

User specified data. You can specify UserData as any array you want to associate with the uitoolbar object. The object does not use this data, but you can access it using the set and get functions.

Visible                      {on} | off

Uitoolbar visibility. By default, all uitoolbars are visible. When set to off, the uitoolbar is not visible, but still exists and you can query and set its properties.


Previous page  uitoolbar undocheckout Next page

© 1994-2005 The MathWorks, Inc.