User Tools

Site Tools


DzToolBarItem

Encapsulates an item in a DzToolBar.

More...

Inherits :

Enumerations

Properties

Detailed Description

This class provides access to toolbar items within the interface. This class is not intended to be constructed directly, rather an instance of the class is created using one of the following:

Enumerations


: Type

The types of action menu items

  • Separator - A toolbar separator (i.e. divider)
  • Action - An action item - a toolbar item that activates a DzAction
  • CustomAction - A toolbar item that activates a Custom Action. See DzActionMgr for more information about custom actions.
  • CustomWidget - A toolbar item that provides a non-standard widget.
  • ViewportLeftAlignSpacer - A toolbar item that adjusts itself so that any items after it are left aligned over the application viewport.
  • ViewportCenterAlignSpacer - A toolbar item that adjusts itself so that any items after it are centered over the application viewport.

Properties


String : action

If the item type is Action, holds the QObject::className() of the DzAction which is activated by this item. If the item type is CustomAction, holds the name (GUID) of the Custom Action that is activated by this item.

If the action has not been set, or the type of the item is not Action or CustomAction, holds an empty string.


Type : type

The type of the toolbar item. (Read Only)


String : uiScript

If the item type is CustomWidget, holds the path to the script to execute in order to create the UI of the widget for this item. The path can be absolute, relative to the application resources path, or relative to the resources folder in the application data path.

If the type of the item is not CustomWidget, holds an empty string.

See Also: