#include <HotKeyManager.h>
Inherits AzToolsFramework::HotKeyManagerInterface, and AzToolsFramework::HotKeyManagerInternalInterface.
|
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 |
|
| 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 |
|
HotKey Manager class definition. Handles Editor HotKeys and allows access across tools.
◆ 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
-
contextIdentifier | The identifier of the action context to assign the widget to. |
widget | The 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
-
contextIdentifier | The identifier of the action context to remove the widget from. |
widget | The 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
-
actionIdentifier | The action identifier to set the hotkey to. |
hotKey | The 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:
- Code/Framework/AzToolsFramework/AzToolsFramework/ActionManager/HotKey/HotKeyManager.h