Customizes the environment in which keymapping is performed. More...
#include <IKeymapEnvironment.h>
Public Member Functions | |
| virtual int | GetWindowID () const =0 |
| Get the window ID for which actions should be translated. More... | |
| virtual void | SetWindowID (int windowId)=0 |
| Set the window ID. More... | |
| virtual int | GetFallthrough (int windowId) const =0 |
| Get the fallthrough window to when a key definition is missing. More... | |
| 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. | |
Detailed Description
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.
Member Function Documentation
◆ GetFallthrough()
|
pure virtual |
Get the fallthrough window to when a key definition is missing.
- Parameters
-
windowId The window ID
- Returns
- The window ID, or -1 for no fallthrough
Implemented in KODI::GAME::CPortInput, and KODI::KEYMAP::CKeymapEnvironment.
◆ GetWindowID()
|
pure virtual |
Get the window ID for which actions should be translated.
- Returns
- The window ID
Implemented in KODI::GAME::CPortInput, and KODI::KEYMAP::CKeymapEnvironment.
◆ SetWindowID()
|
pure virtual |
Set the window ID.
- Parameters
-
The window ID, used for translating actions
Implemented in KODI::GAME::CPortInput, and KODI::KEYMAP::CKeymapEnvironment.
The documentation for this class was generated from the following file:
- xbmc/input/keymaps/interfaces/IKeymapEnvironment.h
