CButtonTranslator Class Reference

#include <ButtonTranslator.h>

Public Member Functions
	CButtonTranslator ()
	CButtonTranslator (const CButtonTranslator &)=delete
CButtonTranslator const &	operator= (CButtonTranslator const &)=delete
virtual	~CButtonTranslator ()
bool	AddDevice (const std::string &strDevice)
bool	RemoveDevice (const std::string &strDevice)
bool	Load ()
	loads Keymap.xml More...
void	Clear ()
	clears the maps More...
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, IButtonMapper *mapper)
void	UnregisterMapper (IButtonMapper *mapper)

Friends
class	EVENTCLIENT::CEventButtonState

Detailed Description

singleton class to map from buttons to actions Warning: not threadsafe!

Constructor & Destructor Documentation

CButtonTranslator() [1/2]

CButtonTranslator::CButtonTranslator

(

)

CButtonTranslator() [2/2]

CButtonTranslator::CButtonTranslator ( const CButtonTranslator &  )

delete

~CButtonTranslator()

CButtonTranslator::~CButtonTranslator ( )

virtual

Member Function Documentation

AddDevice()

bool CButtonTranslator::AddDevice

(

const std::string &

strDevice

)

Clear()

void CButtonTranslator::Clear

(

)

clears the maps

GetAction()

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

Obtain the action configured for a given window and key.

Parameters

window	the window id
key	the key to query the action for
fallback	if 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

window	id of the current window
key	to search a mapping for

Returns

true if a longpress mapping exists

Load()

bool CButtonTranslator::Load

(

)

loads Keymap.xml

operator=()

CButtonTranslator const & CButtonTranslator::operator= ( CButtonTranslator const &  )

delete

RegisterMapper()

void CButtonTranslator::RegisterMapper	(	const std::string &	device,
		IButtonMapper *	mapper
	)

RemoveDevice()

bool CButtonTranslator::RemoveDevice

(

const std::string &

strDevice

)

UnregisterMapper()

void CButtonTranslator::UnregisterMapper

(

IButtonMapper *

mapper

)

Friends And Related Function Documentation

EVENTCLIENT::CEventButtonState

friend class EVENTCLIENT::CEventButtonState

friend

---

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

• ButtonTranslator.h
• ButtonTranslator.cpp