Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::KEYMAP::CWindowKeymap Class Reference

#include <WindowKeymap.h>

Inheritance diagram for KODI::KEYMAP::CWindowKeymap:
KODI::KEYMAP::IWindowKeymap

Public Member Functions

 CWindowKeymap (const std::string &controllerId)
 
std::string ControllerID () const override
 The controller ID.
 
void MapAction (int windowId, const std::string &keyName, KeymapAction action) override
 Add an action to the keymap for a given key name and window ID.
 
const KeymapActionGroupGetActions (int windowId, const std::string &keyName) const override
 Get the actions for a given key name and window ID.
 
- Public Member Functions inherited from KODI::KEYMAP::IWindowKeymap
virtual ~IWindowKeymap ()=default
 

Constructor & Destructor Documentation

◆ CWindowKeymap()

CWindowKeymap::CWindowKeymap ( const std::string & controllerId)
explicit

Member Function Documentation

◆ ControllerID()

std::string KODI::KEYMAP::CWindowKeymap::ControllerID ( ) const
inlineoverridevirtual

The controller ID.

This is required because key names are specific to each controller

Implements KODI::KEYMAP::IWindowKeymap.

◆ GetActions()

const KeymapActionGroup & CWindowKeymap::GetActions ( int windowId,
const std::string & keyName ) const
overridevirtual

Get the actions for a given key name and window ID.

Parameters
windowIdThe window ID to look up
keyNameThe key name created by CJoystickUtils::MakeKeyName()
Returns
A list of actions associated with the given key for the given window

Implements KODI::KEYMAP::IWindowKeymap.

◆ MapAction()

void CWindowKeymap::MapAction ( int windowId,
const std::string & keyName,
KeymapAction action )
overridevirtual

Add an action to the keymap for a given key name and window ID.

Parameters
windowIdThe window ID to look up
keyNameThe key name created by CJoystickUtils::MakeKeyName()
actionThe action to map

Implements KODI::KEYMAP::IWindowKeymap.


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