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.
Classes | Public Member Functions | List of all members
AzToolsFramework::HotKeyManager Class Referencefinal

#include <HotKeyManager.h>

Inherits AzToolsFramework::HotKeyManagerInterface, and AzToolsFramework::HotKeyManagerInternalInterface.

Public Member Functions

HotKeyManagerOperationResult AssignWidgetToActionContext (const AZStd::string &contextIdentifier, QWidget *widget) override
 
HotKeyManagerOperationResult RemoveWidgetFromActionContext (const AZStd::string &contextIdentifier, QWidget *widget) override
 
HotKeyManagerOperationResult SetActionHotKey (const AZStd::string &actionIdentifier, const AZStd::string &hotKey) override
 
void Reset () override
 
- Public Member Functions inherited from AzToolsFramework::HotKeyManagerInterface
 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

HotKey Manager class definition. Handles Editor HotKeys and allows access across tools.

Member Function Documentation

◆ AssignWidgetToActionContext()

HotKeyManagerOperationResult AzToolsFramework::HotKeyManager::AssignWidgetToActionContext ( const AZStd::string &  contextIdentifier,
QWidget *  widget 
)
overridevirtual

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.

Implements AzToolsFramework::HotKeyManagerInterface.

◆ RemoveWidgetFromActionContext()

HotKeyManagerOperationResult AzToolsFramework::HotKeyManager::RemoveWidgetFromActionContext ( const AZStd::string &  contextIdentifier,
QWidget *  widget 
)
overridevirtual

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.

Implements AzToolsFramework::HotKeyManagerInterface.

◆ SetActionHotKey()

HotKeyManagerOperationResult AzToolsFramework::HotKeyManager::SetActionHotKey ( const AZStd::string &  actionIdentifier,
const AZStd::string &  hotKey 
)
overridevirtual

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.

Implements AzToolsFramework::HotKeyManagerInterface.

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