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

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

#include <IKeymap.h>

Inheritance diagram for IKeymap:
CKeymap

Public Member Functions

virtual ~IKeymap ()=default
 
virtual std::string ControllerID () const =0
 The controller ID. More...
 
virtual const IKeymapEnvironment * Environment () const =0
 Access properties of the keymapping environment. More...
 
virtual const KODI::JOYSTICK::KeymapActionGroup & GetActions (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

Constructor & Destructor Documentation

◆ ~IKeymap()

virtual IKeymap::~IKeymap ( )
virtualdefault

Member Function Documentation

◆ ControllerID()

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

The controller ID.

This is required because key names are specific to each controller

Implemented in CKeymap.

◆ Environment()

virtual const IKeymapEnvironment * IKeymap::Environment ( ) const
pure virtual

Access properties of the keymapping environment.

Implemented in CKeymap.

◆ GetActions()

virtual const KODI::JOYSTICK::KeymapActionGroup & 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 CKeymap.

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