User Tools

Site Tools


DzAction

Properties

Methods

DAZ Script
voidhover ()
voidsetChecked ( Boolean onOff )
voidsetDisabled ( Boolean onOff )
voidsetEnabled ( Boolean onOff )
voidsetOff ( Boolean onOff )
voidsetVisible ( Boolean onOff )
voidtoggle ()
voidtrigger ()

Signals

voidchanged ()
voidenabled ( Boolean onOff )
voidhovered ()
voidpreExecute ()
voidtoggled ( Boolean checked )
voidtriggered ( Boolean checked )

Detailed Description

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:

Properties


String : actionGroup

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


Boolean : autoRepeat

TODO: Add description.


Boolean : checkable

TODO: Add description.


Boolean : checked

TODO: Add description.


String : defaultMenu

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


Array : defaultMenus

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

Since:

  • 4.6.2.62

String : defaultShortcut

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


String : defaultToolBar

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


Array : defaultToolBars

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

Since:

  • 4.6.2.62

String : description

The user-readable description of the action.


Boolean : enabled

Emitted when an action is enabled or disabled. onOff is true if the action was enabled, false if it was disabled.


String : iconFile

The image file that is used as the icon for this action (if any).


String : iconText

TODO: Add description.


Boolean : iconVisibleInMenu

TODO: Add description.


String : shortcut

TODO: Add description.


String : statusTip

TODO: Add description.


Number : styleIcon

The standard pixmap that is used as the icon for this action (if any).

Since:

  • 4.11.0.43

String : text

TODO: Add description.


String : toolTip

TODO: Add description.


Boolean : visible

TODO: Add description.


String : whatsThis

TODO: Add description.

Methods


void : hover()

Activates the action in the 'Hover' state programatically.

See Also:


void : setChecked( Boolean onOff )

Sets the action's toggle state.

Parameter(s):

  • onOff - If true, the action's toggle state is set on, otherwise, its toggle state is set off.

See Also:


void : setDisabled( Boolean onOff )

Disables/Enables the action in the interface.

Parameter(s):

  • onOff - If true, the action will be 'grayed out' in menus, and the user will be unable to activate it. If false, the action will be enabled.

See Also:


void : setEnabled( Boolean onOff )

Enables/Disables the action in the interface.

Parameter(s):

  • 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:


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

Parameter(s):

  • onOff - If true, the action's toggle state is set off, otherwise, its toggle state is set on.

See Also:


void : setVisible( Boolean onOff )

Sets whether the action is visible in the interface.

Parameter(s):

  • 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 : toggle()

Toggles the action programatically.

See Also:


void : trigger()

Activates the action programatically.

See Also:

Signals


void : changed()

Signature:“changed()”

Emitted when an action has changed.


void : enabled( Boolean onOff )

TODO: Add description.


void : hovered()

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 : preExecute()

Signature:“preExecute()”

Emitted immediately before executeAction() is called.

Since:

  • 4.6.3.32

void : toggled( Boolean checked )

Signature:“toggled(bool)”

Emitted when a toggle action changes state. checked is the new action state, true for on, false for off.


void : triggered( Boolean checked )

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.