DzAction Class Reference
[Interface Components]

Class that implements a user action. More...

List of all members.

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)"


Detailed Description

Class that implements a user action.

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.

See also:
DzActionMgr::getAction(), DzActionMgr::findAction()


Member Function Documentation

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.

See also:
trigger()

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.

Parameters:
onOff If true, the action's toggle state is set on, otherwise, its toggle state is set off.
See also:
setOff()

DzAction::setDisabled ( Boolean  onOff  ) 

Disables/Enables the action in the interface.

Parameters:
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.
See also:
setEnabled()

DzAction::setEnabled ( Boolean  onOff  ) 

Enables/Disables the action in the interface.

Parameters:
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.
See also:
setDisabled()

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.

Parameters:
onOff If true, the action's toggle state is set off, otherwise, its toggle state is set on.
See also:
setChecked()

void DzAction::setVisible ( Boolean  onOff  ) 

Sets whether the action is visible in the interface.

Parameters:
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.

See also:
trigger()

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.

See also:
toggle()

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.


Member Data Documentation

String DzAction::actionGroup

The action group that this action belongs to (Read Only)

String DzAction::defaultMenu

The menu that this action is added to by default, if the user has not chosen a custom location (Read Only)

String DzAction::defaultShortcut

The default keyboard shortcut (hotkey) that is associated with this action (Read Only)

String DzAction::defaultToolBar

The toolBar that this action is added to by default, if the user has not chosen a custom location (Read Only)

String DzAction::description

The user-readable description of the action.

String DzAction::iconFile

The image file that is used as the icon for this action.


Generated on Thu Sep 24 12:21:10 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.