AzToolsFramework::ActionOverride Struct Reference

#include <ActionBus.h>

Public Member Functions
	ActionOverride (const AZ::Crc32 uri, QKeySequence keySequence, const QString &title, const QString &statusTip, const AZStd::function< void()> &callback)
	Constructor to create an ActionOverride with all properties set.
ActionOverride &	SetUri (const AZ::Crc32 uri)
	Set the URI associated with this ActionOverride.
ActionOverride &	SetKeySequence (const QKeySequence keySequence)
	Set the KeySequence (shortcut) associated with this ActionOverride.
ActionOverride &	SetTitle (const QString &title)
ActionOverride &	SetTip (const QString &tip)
ActionOverride &	SetCallback (const AZStd::function< void()> &callback)
	Set the function to call for this ActionOverride.
ActionOverride &	SetEntityComponentIdPair (const AZ::EntityComponentIdPair &entityCompoentIdPair)

Public Attributes
AZ::Crc32	m_uri
	Unique identifier for a particular action/shortcut.
QKeySequence	m_keySequence
	The shortcut bound to this particular action.
QString	m_title
	The title of the action to appear in the edit menu.
QString	m_statusTip
	The tool/status tip to appear when mouse is hovered over the edit menu action.
AZStd::function< void()>	m_callback = nullptr
	The operation to happen when the action is invoked.
AZ::EntityComponentIdPair	m_entityIdComponentPair { AZ::EntityId(), AZ::InvalidComponentId }

Detailed Description

Specific Action properties to be sent to a type implementing ActionOverrideRequests. The actions will be added and stored and will remain active until they are removed.

Member Function Documentation

SetEntityComponentIdPair()

ActionOverride & AzToolsFramework::ActionOverride::SetEntityComponentIdPair ( const AZ::EntityComponentIdPair &  entityCompoentIdPair )

inline

Set the Entity and Component this ActionOverride is associated with.

Note

This is important to call for actions associated with a specific entity/component.

SetTip()

ActionOverride & AzToolsFramework::ActionOverride::SetTip ( const QString &  tip )

inline

Set the tooltip associated with this ActionOverride. Will appear in the Edit menu bar with mouse hover.

SetTitle()

ActionOverride & AzToolsFramework::ActionOverride::SetTitle ( const QString &  title )

inline

Set the title associated with this ActionOverride. Will appear in the Edit menu bar.

Member Data Documentation

m_entityIdComponentPair

AZ::EntityComponentIdPair AzToolsFramework::ActionOverride::m_entityIdComponentPair { AZ::EntityId(), AZ::InvalidComponentId }

The Entity and Component Id this Action is associated with.

---

The documentation for this struct was generated from the following file:

• Code/Framework/AzToolsFramework/AzToolsFramework/Viewport/ActionBus.h