#include <ActionManagerInterface.h>
Inherited by AzToolsFramework::ActionManager [private]
.
Public Member Functions | |
AZ_RTTI (ActionManagerInterface, "{2E2A421E-0842-4F90-9F5C-DDE0C4F820DE}") | |
virtual ActionManagerOperationResult | RegisterActionContext (const AZStd::string &contextIdentifier, const ActionContextProperties &properties)=0 |
virtual bool | IsActionContextRegistered (const AZStd::string &contextIdentifier) const =0 |
virtual ActionManagerOperationResult | RegisterActionContextMode (const AZStd::string &actionContextIdentifier, const AZStd::string &modeIdentifier)=0 |
virtual ActionManagerOperationResult | RegisterAction (const AZStd::string &contextIdentifier, const AZStd::string &actionIdentifier, const ActionProperties &properties, AZStd::function< void()> handler)=0 |
virtual ActionManagerOperationResult | RegisterCheckableAction (const AZStd::string &contextIdentifier, const AZStd::string &actionIdentifier, const ActionProperties &properties, AZStd::function< void()> handler, AZStd::function< bool()> checkStateCallback)=0 |
virtual bool | IsActionRegistered (const AZStd::string &actionIdentifier) const =0 |
virtual ActionManagerGetterResult | GetActionName (const AZStd::string &actionIdentifier)=0 |
virtual ActionManagerOperationResult | SetActionName (const AZStd::string &actionIdentifier, const AZStd::string &name)=0 |
virtual ActionManagerGetterResult | GetActionDescription (const AZStd::string &actionIdentifier)=0 |
virtual ActionManagerOperationResult | SetActionDescription (const AZStd::string &actionIdentifier, const AZStd::string &description)=0 |
virtual ActionManagerGetterResult | GetActionCategory (const AZStd::string &actionIdentifier)=0 |
virtual ActionManagerOperationResult | SetActionCategory (const AZStd::string &actionIdentifier, const AZStd::string &category)=0 |
virtual ActionManagerGetterResult | GetActionIconPath (const AZStd::string &actionIdentifier)=0 |
virtual ActionManagerOperationResult | SetActionIconPath (const AZStd::string &actionIdentifier, const AZStd::string &iconPath)=0 |
virtual int | GenerateActionAlphabeticalSortKey (const AZStd::string &actionIdentifier)=0 |
virtual ActionManagerBooleanResult | IsActionEnabled (const AZStd::string &actionIdentifier) const =0 |
virtual ActionManagerOperationResult | TriggerAction (const AZStd::string &actionIdentifier)=0 |
virtual ActionManagerOperationResult | InstallEnabledStateCallback (const AZStd::string &actionIdentifier, AZStd::function< bool()> enabledStateCallback)=0 |
virtual ActionManagerOperationResult | UpdateAction (const AZStd::string &actionIdentifier)=0 |
virtual ActionManagerOperationResult | RegisterActionUpdater (const AZStd::string &actionUpdaterIdentifier)=0 |
virtual ActionManagerOperationResult | AddActionToUpdater (const AZStd::string &actionUpdaterIdentifier, const AZStd::string &actionIdentifier)=0 |
virtual ActionManagerOperationResult | TriggerActionUpdater (const AZStd::string &actionUpdaterIdentifier)=0 |
virtual ActionManagerOperationResult | RegisterWidgetAction (const AZStd::string &widgetActionIdentifier, const WidgetActionProperties &properties, AZStd::function< QWidget *()> generator)=0 |
virtual bool | IsWidgetActionRegistered (const AZStd::string &widgetActionIdentifier) const =0 |
virtual ActionManagerGetterResult | GetWidgetActionName (const AZStd::string &widgetActionIdentifier)=0 |
virtual ActionManagerOperationResult | SetWidgetActionName (const AZStd::string &widgetActionIdentifier, const AZStd::string &name)=0 |
virtual ActionManagerGetterResult | GetWidgetActionCategory (const AZStd::string &widgetActionIdentifier)=0 |
virtual ActionManagerOperationResult | SetWidgetActionCategory (const AZStd::string &widgetActionIdentifier, const AZStd::string &category)=0 |
virtual ActionManagerOperationResult | AssignModeToAction (const AZStd::string &modeIdentifier, const AZStd::string &actionIdentifier)=0 |
virtual ActionManagerBooleanResult | IsActionActiveInCurrentMode (const AZStd::string &actionIdentifier) const =0 |
virtual ActionManagerOperationResult | SetActiveActionContextMode (const AZStd::string &actionContextIdentifier, const AZStd::string &modeIdentifier)=0 |
virtual ActionManagerGetterResult | GetActiveActionContextMode (const AZStd::string &actionContextIdentifier) const =0 |
ActionManagerInterface Interface to register and trigger actions in the Editor.
|
pure virtual |
Adds an action identifier to the updater's list.
actionUpdaterIdentifier | The identifier for the updater to add the action to. |
actionIdentifier | The identifier for the action to add the updater's list. |
|
pure virtual |
Sets an additional mode for an action via its identifier.
modeIdentifier | The action context mode identifier to add to the action. |
actionIdentifier | The action to set the mode to. |
|
pure virtual |
Generates a sort key from the action's name that can be used to sort alphabetically.
actionIdentifier | The action identifier to query. |
|
pure virtual |
Get an Action's category via its identifier.
actionIdentifier | The action identifier to get the value from. |
|
pure virtual |
Get an Action's description via its identifier.
actionIdentifier | The action identifier to get the value from. |
|
pure virtual |
Get an Action's icon path via its identifier.
actionIdentifier | The action identifier to get the value from. |
|
pure virtual |
Get an Action's name via its identifier.
actionIdentifier | The action identifier to get the value from. |
|
pure virtual |
Gets the active mode for an action context via its identifier.
actionContextIdentifier | The action context to get the active mode of. |
|
pure virtual |
Get a Widget Action's category via its identifier.
widgetActionIdentifier | The widget action identifier to get the value from. |
|
pure virtual |
Get a Widget Action's name via its identifier.
widgetActionIdentifier | The widget action identifier to get the value from. |
|
pure virtual |
Installs an enabled state callback to an action that will set its enabled state when the action is updated. An action can only have a single enabled state callback. The function will fail if called multiple times.
actionIdentifier | The identifier for the action to install the callback to. |
|
pure virtual |
Returns whether the Action is active in the Mode its Action Context is currently in.
actionIdentifier | The action to query. |
|
pure virtual |
Returns whether an action context with the identifier queried is registered to the Action Manager.
contextIdentifier | The identifier for the action context to query. |
|
pure virtual |
Returns the enabled state for the action.
actionIdentifier | The action identifier to query. |
|
pure virtual |
Returns whether an action with the identifier queried is registered to the Action Manager.
actionIdentifier | The identifier for the action to query. |
|
pure virtual |
Returns whether a widget action with the identifier queried is registered to the Action Manager.
widgetActionIdentifier | The identifier for the widget action to query. |
|
pure virtual |
Register a new Action to the Action Manager.
contextIdentifier | The identifier for the action context the newly registered action should be added to. |
actionIdentifier | The identifier for the newly registered action. |
properties | The properties object for the newly registered action. |
handler | The handler function that should be called when the action is triggered. |
|
pure virtual |
Register a new Action Context to the Action Manager.
contextIdentifier | The identifier for the newly registered action context. |
properties | The properties object for the newly registered action context. |
|
pure virtual |
Register a new Mode for an Action Context to the Action Manager.
actionContextIdentifier | The identifier for the action context the newly registered mode should be added to. |
modeIdentifier | The new value for the category property of the widget action. |
|
pure virtual |
Register a new Action Updater to the Action Manager. An Action Updater stores a list of Action identifiers that will be updated when the Updater condition is met. The system that registers the Action Updater is expected to trigger the TriggerActionUpdater function appropriately.
actionUpdaterIdentifier | The identifier for the newly registered action updater. |
|
pure virtual |
Register a new Checkable Action to the Action Manager.
contextIdentifier | The identifier for the action context the newly registered action should be added to. |
actionIdentifier | The identifier for the newly registered action. |
properties | The properties object for the newly registered action. |
handler | The handler function that should be called when the action is triggered. |
checkStateCallback | The handler function that will be called when the action's checked state needs to be updated. Returns a boolean that will be used to set the checked value of the action. |
|
pure virtual |
Register a new Widget Action to the Action Manager.
widgetActionIdentifier | The identifier for the newly registered widget action. |
properties | The properties object for the newly registered widget action. |
generator | The generator function that will be called to create the widget when invoked. |
|
pure virtual |
Set an Action's category via its identifier.
actionIdentifier | The action identifier to set the value to. |
category | The new value for the category property of the action. |
|
pure virtual |
Set an Action's description via its identifier.
actionIdentifier | The action identifier to set the value to. |
description | The new value for the description property of the action. |
|
pure virtual |
Set an Action's icon path via its identifier.
actionIdentifier | The action identifier to set the value to. |
iconPath | The new value for the icon path property of the action. |
|
pure virtual |
Set an Action's name via its identifier.
actionIdentifier | The action identifier to set the value to. |
name | The new value for the name property of the action. |
|
pure virtual |
Sets the active mode for an action context via its identifier.
actionContextIdentifier | The action context to set the active mode to. |
modeIdentifier | The action context mode identifier to set as active. |
|
pure virtual |
Set a Widget Action's category via its identifier.
widgetActionIdentifier | The widget action identifier to set the value to. |
category | The new value for the category property of the widget action. |
|
pure virtual |
Set a Widget Action's name via its identifier.
widgetActionIdentifier | The widget action identifier to set the value to. |
name | The new value for the name property of the widget action. |
|
pure virtual |
Trigger an Action via its identifier.
actionIdentifier | The identifier for the action to trigger. |
|
pure virtual |
Trigger an update on all actions registered to the Action Updater.
actionUpdaterIdentifier | The identifier for the action updater to trigger an update on. |
|
pure virtual |
Update the state of an Action via its identifier. This will update both the enabled and checked state.
actionIdentifier | The identifier for the action to update. |