xbmc
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
KODI::KEYMAP::CButtonTranslator Class Reference

Singleton class to map from buttons to actions. More...

#include <ButtonTranslator.h>

Public Member Functions

 CButtonTranslator (const CButtonTranslator &)=delete
 
CButtonTranslator const & operator= (CButtonTranslator const &)=delete
 
bool AddDevice (const std::string &strDevice)
 
bool RemoveDevice (const std::string &strDevice)
 
bool Load ()
 loads Keymap.xml
 
void Clear ()
 clears the maps
 
bool HasLongpressMapping (int window, const CKey &key)
 Finds out if a longpress mapping exists for this key. More...
 
CAction GetAction (int window, const CKey &key, bool fallback=true)
 Obtain the action configured for a given window and key. More...
 
void RegisterMapper (const std::string &device, IKeyMapper *mapper)
 
void UnregisterMapper (const IKeyMapper *mapper)
 

Static Public Member Functions

static uint32_t TranslateString (const std::string &strMap, const std::string &strButton)
 

Friends

class EVENTCLIENT::CEventButtonState
 

Detailed Description

Singleton class to map from buttons to actions.

Warning: not threadsafe!

Member Function Documentation

◆ GetAction()

CAction CButtonTranslator::GetAction ( int  window,
const CKey key,
bool  fallback = true 
)

Obtain the action configured for a given window and key.

Parameters
windowthe window id
keythe key to query the action for
fallbackif no action is directly configured for the given window, obtain the action from fallback window, if exists or from global config as last resort
Returns
the action matching the key

◆ HasLongpressMapping()

bool CButtonTranslator::HasLongpressMapping ( int  window,
const CKey key 
)

Finds out if a longpress mapping exists for this key.

Parameters
windowid of the current window
keyto search a mapping for
Returns
true if a longpress mapping exists

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