#include <HotKeyManagerInterface.h>
Inherited by AzToolsFramework::HotKeyManager.
HotKeyManagerInterface Interface to manage hotkeys in the Editor.
◆ 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
-
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.
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
-
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.
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
-
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.
Implemented in AzToolsFramework::HotKeyManager.
The documentation for this class was generated from the following file:
- Code/Framework/AzToolsFramework/AzToolsFramework/ActionManager/HotKey/HotKeyManagerInterface.h