Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CWindowKeymap Class Reference

#include <WindowKeymap.h>

Inheritance diagram for CWindowKeymap:
IWindowKeymap

Public Member Functions

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

Constructor & Destructor Documentation

◆ CWindowKeymap()

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

Member Function Documentation

◆ ControllerID()

virtual std::string CWindowKeymap::ControllerID ( ) const
inlineoverridevirtual

The controller ID.

This is required because key names are specific to each controller

Implements IWindowKeymap.

◆ GetActions()

const JOYSTICK::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 IWindowKeymap.

◆ MapAction()

void CWindowKeymap::MapAction ( int  windowId,
const std::string &  keyName,
KODI::JOYSTICK::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 IWindowKeymap.


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