Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AzToolsFramework::HotKeyManagerInterface Class Referenceabstract

#include <HotKeyManagerInterface.h>

Inherited by AzToolsFramework::HotKeyManager.

Public Member Functions

 AZ_RTTI (HotKeyManagerInterface, "{B6414B8D-E2F4-4B30-8E29-4707657FDC93}")
 
virtual HotKeyManagerOperationResult AssignWidgetToActionContext (const AZStd::string &contextIdentifier, QWidget *widget)=0
 
virtual HotKeyManagerOperationResult RemoveWidgetFromActionContext (const AZStd::string &contextIdentifier, QWidget *widget)=0
 
virtual HotKeyManagerOperationResult SetActionHotKey (const AZStd::string &actionIdentifier, const AZStd::string &hotKey)=0
 

Detailed Description

HotKeyManagerInterface Interface to manage hotkeys in the Editor.

Member Function Documentation

◆ AssignWidgetToActionContext()

virtual HotKeyManagerOperationResult AzToolsFramework::HotKeyManagerInterface::AssignWidgetToActionContext ( const AZStd::string &  contextIdentifier,
QWidget *  widget 
)
pure virtual

Assign an owning widget to an Action Context. This allows actions registered to that Action Context to be triggered by shortcuts when the events reach that widget.

Parameters
contextIdentifierThe identifier of the action context to assign the widget to.
widgetThe widget to assign to the action context.
Returns
A successful outcome object, or a string with a message detailing the error in case of failure.

Implemented in AzToolsFramework::HotKeyManager.

◆ RemoveWidgetFromActionContext()

virtual HotKeyManagerOperationResult AzToolsFramework::HotKeyManagerInterface::RemoveWidgetFromActionContext ( const AZStd::string &  contextIdentifier,
QWidget *  widget 
)
pure virtual

Remove an owning widget from an Action Context.

Parameters
contextIdentifierThe identifier of the action context to remove the widget from.
widgetThe widget to remove from the action context.
Returns
A successful outcome object, or a string with a message detailing the error in case of failure.

Implemented in AzToolsFramework::HotKeyManager.

◆ SetActionHotKey()

virtual HotKeyManagerOperationResult AzToolsFramework::HotKeyManagerInterface::SetActionHotKey ( const AZStd::string &  actionIdentifier,
const AZStd::string &  hotKey 
)
pure virtual

Set an Action's HotKey via its identifier.

Parameters
actionIdentifierThe action identifier to set the hotkey to.
hotKeyThe new key combination to bind the action to.
Returns
A successful outcome object, or a string with a message detailing the error in case of failure.

Implemented in AzToolsFramework::HotKeyManager.

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