Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | List of all members
CKeymapEnvironment Class Reference

#include <KeymapEnvironment.h>

Inheritance diagram for CKeymapEnvironment:
IKeymapEnvironment

Public Member Functions

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

Constructor & Destructor Documentation

◆ ~CKeymapEnvironment()

virtual CKeymapEnvironment::~CKeymapEnvironment ( )
virtualdefault

Member Function Documentation

◆ GetFallthrough()

int CKeymapEnvironment::GetFallthrough ( int  windowId) const
overridevirtual

Get the fallthrough window to when a key definition is missing.

Parameters
windowIdThe window ID
Returns
The window ID, or -1 for no fallthrough

Implements IKeymapEnvironment.

◆ GetWindowID()

virtual int CKeymapEnvironment::GetWindowID ( ) const
inlineoverridevirtual

Get the window ID for which actions should be translated.

Returns
The window ID

Implements IKeymapEnvironment.

◆ SetWindowID()

virtual void CKeymapEnvironment::SetWindowID ( int  windowId)
inlineoverridevirtual

Set the window ID.

Parameters
Thewindow ID, used for translating actions

Implements IKeymapEnvironment.

◆ UseEasterEgg()

virtual bool CKeymapEnvironment::UseEasterEgg ( ) const
inlineoverridevirtual

Specify if the agent should monitor for easter egg presses.

Implements IKeymapEnvironment.

◆ UseGlobalFallthrough()

virtual bool CKeymapEnvironment::UseGlobalFallthrough ( ) const
inlineoverridevirtual

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

Implements IKeymapEnvironment.

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