xbmc
Public Member Functions | List of all members
KODI::KEYMAP::IKeymap Class Referenceabstract

Interface for mapping buttons to Kodi actions. More...

#include <IKeymap.h>

Inheritance diagram for KODI::KEYMAP::IKeymap:
Inheritance graph
[legend]

Public Member Functions

virtual std::string ControllerID () const =0
 The controller ID. More...
 
virtual const IKeymapEnvironmentEnvironment () const =0
 Access properties of the keymapping environment.
 
virtual const KeymapActionGroupGetActions (const std::string &keyName) const =0
 Get the actions for a given key name. More...
 

Detailed Description

Interface for mapping buttons to Kodi actions.

See also
CJoystickUtils::MakeKeyName

Member Function Documentation

◆ ControllerID()

virtual std::string KODI::KEYMAP::IKeymap::ControllerID ( ) const
pure virtual

The controller ID.

This is required because key names are specific to each controller

Implemented in KODI::KEYMAP::CKeymap.

◆ GetActions()

virtual const KeymapActionGroup& KODI::KEYMAP::IKeymap::GetActions ( const std::string &  keyName) const
pure virtual

Get the actions for a given key name.

Parameters
keyNameThe key name created by CJoystickUtils::MakeKeyName()
Returns
A list of actions associated with the given key

Implemented in KODI::KEYMAP::CKeymap.


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