![]() |
Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
Customizes the environment in which keymapping is performed. More...
#include <IKeymapEnvironment.h>
Public Member Functions | |
virtual | ~IKeymapEnvironment ()=default |
virtual int | GetWindowID () const =0 |
Get the window ID for which actions should be translated. | |
virtual void | SetWindowID (int windowId)=0 |
Set the window ID. | |
virtual int | GetFallthrough (int windowId) const =0 |
Get the fallthrough window to when a key definition is missing. | |
virtual bool | UseGlobalFallthrough () const =0 |
Specify if the global keymap should be used when the window and fallback window are undefined. | |
virtual bool | UseEasterEgg () const =0 |
Specify if the agent should monitor for easter egg presses. | |
Customizes the environment in which keymapping is performed.
By overriding GetWindowID() and GetFallthrough(), an agent can customize the behavior of the keymap by forcing a window and preventing the use of a fallback window, respectively.
An agent can also inform the keymap that it isn't accepting input currently, allowing the input to fall through to the next input handler.
|
virtualdefault |
Get the fallthrough window to when a key definition is missing.
windowId | The window ID |
Implemented in KODI::GAME::CPortInput, and KODI::KEYMAP::CKeymapEnvironment.
|
pure virtual |
Get the window ID for which actions should be translated.
Implemented in KODI::GAME::CPortInput, and KODI::KEYMAP::CKeymapEnvironment.
Set the window ID.
The | window ID, used for translating actions |
Implemented in KODI::GAME::CPortInput, and KODI::KEYMAP::CKeymapEnvironment.
|
pure virtual |
Specify if the agent should monitor for easter egg presses.
Implemented in KODI::GAME::CPortInput, and KODI::KEYMAP::CKeymapEnvironment.
|
pure virtual |
Specify if the global keymap should be used when the window and fallback window are undefined.
Implemented in KODI::GAME::CPortInput, and KODI::KEYMAP::CKeymapEnvironment.