KODI::KEYMAP::CKeymapEnvironment Class Reference

#include <KeymapEnvironment.h>

Inheritance diagram for KODI::KEYMAP::CKeymapEnvironment:

Public Member Functions
	~CKeymapEnvironment () override=default
int	GetWindowID () const override
	Get the window ID for which actions should be translated.
void	SetWindowID (int windowId) override
	Set the window ID.
int	GetFallthrough (int windowId) const override
	Get the fallthrough window to when a key definition is missing.
bool	UseGlobalFallthrough () const override
	Specify if the global keymap should be used when the window and fallback window are undefined.
bool	UseEasterEgg () const override
	Specify if the agent should monitor for easter egg presses.
Public Member Functions inherited from KODI::KEYMAP::IKeymapEnvironment
virtual	~IKeymapEnvironment ()=default

Constructor & Destructor Documentation

~CKeymapEnvironment()

KODI::KEYMAP::CKeymapEnvironment::~CKeymapEnvironment ( )

overridedefault

Member Function Documentation

GetFallthrough()

int CKeymapEnvironment::GetFallthrough ( int windowId ) const

overridevirtual

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

Implements KODI::KEYMAP::IKeymapEnvironment.

GetWindowID()

int KODI::KEYMAP::CKeymapEnvironment::GetWindowID ( ) const

inlineoverridevirtual

Get the window ID for which actions should be translated.

Returns

The window ID

Implements KODI::KEYMAP::IKeymapEnvironment.

SetWindowID()

void KODI::KEYMAP::CKeymapEnvironment::SetWindowID ( int windowId )

inlineoverridevirtual

Set the window ID.

Parameters

The	window ID, used for translating actions

Implements KODI::KEYMAP::IKeymapEnvironment.

UseEasterEgg()

bool KODI::KEYMAP::CKeymapEnvironment::UseEasterEgg ( ) const

inlineoverridevirtual

Specify if the agent should monitor for easter egg presses.

Implements KODI::KEYMAP::IKeymapEnvironment.

UseGlobalFallthrough()

bool KODI::KEYMAP::CKeymapEnvironment::UseGlobalFallthrough ( ) const

inlineoverridevirtual

Specify if the global keymap should be used when the window and fallback window are undefined.

Implements KODI::KEYMAP::IKeymapEnvironment.

---

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

• KeymapEnvironment.h
• KeymapEnvironment.cpp