Properties | |
String | actionGroup |
String | defaultMenu |
String | defaultShortcut |
String | defaultToolBar |
String | description |
String | iconFile |
Methods | |
void | hover () |
void | setChecked (Boolean onOff) |
void | setDisabled (Boolean onOff) |
void | setEnabled (Boolean onOff) |
void | setOff (Boolean onOff) |
void | setVisible (Boolean onOff) |
void | toggle () |
void | trigger () |
Signals | |
void | changed () |
Signature: "changed()" | |
void | enabled (Boolean onOff) |
Signature: "enabled(bool)" | |
void | hovered () |
Signature: "hovered()" | |
void | toggled (Boolean checked) |
Signature: "toggled(bool)" | |
void | triggered (Boolean checked) |
Signature: "triggered(bool)" |
This class represents an action that the user can perform in the interface via pressing a hot key or clicking on a menu/toolbar item.
All action items are added to a list of interface actions which the user can customize. The user can specify their own keyboard shortcut or 'Hot Key' for the action, and any action item can be moved into a custom toolbar, as well as appear in the DAZ Studio main menu.
void DzAction::changed | ( | ) | [signal] |
Signature: "changed()"
Emitted when an action has changed.
void DzAction::enabled | ( | Boolean | onOff | ) | [signal] |
Signature: "enabled(bool)"
Emitted when an action is enabled or disabled. onOff
is true if the action was enabled, false if it was disabled.
void DzAction::hover | ( | ) |
Activates the action in the 'Hover' state programatically.
void DzAction::hovered | ( | ) | [signal] |
Signature: "hovered()"
Emitted when an action is highlighted by the user; for example, when the user pauses with the cursor over a menu option, toolbar button, or presses an action's shortcut key combination.
void DzAction::setChecked | ( | Boolean | onOff | ) |
Sets the action's toggle state.
onOff | If true, the action's toggle state is set on, otherwise, its toggle state is set off. |
DzAction::setDisabled | ( | Boolean | onOff | ) |
Disables/Enables the action in the interface.
onOff | If true, the action will be greyed out in menus, and the user will be unable to activate it, if false, the action will be enabled. |
DzAction::setEnabled | ( | Boolean | onOff | ) |
Enables/Disables the action in the interface.
onOff | If true, the action will be displayed normally in menus, and the user will be able to activate it, if false, the action will be disabled. |
void DzAction::setOff | ( | Boolean | onOff | ) |
The same as calling setChecked( !onOff ). This method is provided for convenience when connecting this slot to a signal that emits a value that is the inverse of the desired onOff state.
onOff | If true, the action's toggle state is set off, otherwise, its toggle state is set on. |
void DzAction::setVisible | ( | Boolean | onOff | ) |
Sets whether the action is visible in the interface.
onOff | If true, the action will be displayed in menus and toolbars that it has been added to. If false, the action will not be displayed in any menus or toolbars. |
void DzAction::toggle | ( | ) |
Toggles the action programatically.
void DzAction::toggled | ( | Boolean | checked | ) | [signal] |
Signature: "toggled(bool)"
Emitted when a toggle action changes state. checked
is the new action state, true for on, false for off.
void DzAction::trigger | ( | ) |
Activates the action programatically.
void DzAction::triggered | ( | Boolean | checked | ) | [signal] |
Signature: "triggered(bool)"
Emitted when an action is activated by the user; for example, when the user clicks a menu option, toolbar button, or presses an action's shortcut key combination, or when trigger() was called. Notably, it is not emitted when setChecked() or toggle() is called. checked
is true if the action is checked, or false if the action is unchecked.
The action group that this action belongs to (Read Only)
The menu that this action is added to by default, if the user has not chosen a custom location (Read Only)
The default keyboard shortcut (hotkey) that is associated with this action (Read Only)
The toolBar that this action is added to by default, if the user has not chosen a custom location (Read Only)
The user-readable description of the action.
The image file that is used as the icon for this action.