stmg::KeyActionEvent Class Reference

Inheritance diagram for stmg::KeyActionEvent:

Public Member Functions
	KeyActionEvent (int64_t nTimeUsec, const shared_ptr< stmi::Accessor > &refAccessor, const shared_ptr< stmi::Capability > &refCapability, stmi::Event::AS_KEY_INPUT_TYPE eType, int32_t nKeyAction) noexcept
stmi::Event::AS_KEY_INPUT_TYPE	getType () const noexcept
int32_t	getKeyAction () const noexcept
shared_ptr< stmi::Capability >	getCapability () const noexcept override
	Returns the capability that generated this event. More...
Public Member Functions inherited from stmi::Event
virtual	~Event () noexcept=default
int64_t	getTimeUsec () const noexcept
	Returns the time this event originated. More...
int32_t	getCapabilityId () const noexcept
	Returns the id of the capability that generated this event. More...
const shared_ptr< Accessor > &	getAccessor () const noexcept
	Returns the accessor that helped generate this event. More...
virtual bool	getAsKey (HARDWARE_KEY &eKey, AS_KEY_INPUT_TYPE &eType, bool &bMoreThanOne) const noexcept
	Tells whether the event can simulate hardware keys. More...
virtual std::vector< std::pair< HARDWARE_KEY, AS_KEY_INPUT_TYPE > >	getAsKeys () const noexcept
	All the keys this event simulates. More...
const Class &	getEventClass () const noexcept
	Get the registered class of the event instance. More...

Static Public Member Functions
static const stmi::Event::Class &	getClass () noexcept
Static Public Member Functions inherited from stmi::Event
static bool	isEventClassIdRegistered (const std::string &sEventClassId) noexcept
	Tells whether the given event class id is registered. More...
static Class	getEventClassIdClass (const std::string &sEventClassId) noexcept
	Gets the event class with given class id. More...

Static Public Attributes
static const char *const	s_sClassId

Protected Member Functions
void	setType (stmi::Event::AS_KEY_INPUT_TYPE eType) noexcept
void	setKeyAction (int32_t nKeyAction) noexcept
void	setCapability (const shared_ptr< stmi::Capability > &refCapability) noexcept
	Sets the capability of the key action event. More...
Protected Member Functions inherited from stmi::Event
	Event (const Class &oClass, int64_t nTimeUsec, int32_t nCapabilityId, const shared_ptr< Accessor > &refAccessor) noexcept
	Constructor to be called from subclasses. More...
	Event (const Class &oClass, int64_t nTimeUsec, int32_t nCapabilityId) noexcept
	Constructor to be called from subclasses (with empty accessor). More...
void	setTimeUsec (int64_t nTimeUsec) noexcept
	Set the event time. More...
void	setCapabilityId (int32_t nCapabilityId) noexcept
	Set the capability id. More...
void	setAccessor (const shared_ptr< Accessor > &refAccessor) noexcept
	Set the accessor. More...

Additional Inherited Members
Public Types inherited from stmi::Event
enum	AS_KEY_INPUT_TYPE { AS_KEY_PRESS = 1, AS_KEY_RELEASE = 2, AS_KEY_RELEASE_CANCEL = 3 }
	Key simulation type. More...
Static Protected Member Functions inherited from stmi::Event
static bool	isEventTypeRegistered (const std::type_info &oEventType) noexcept
	Tells whether an event type was registered. More...
static const std::type_info &	getEventClassIdType (const std::string &sEventClassId, bool &bRegistered) noexcept
	Gets the type of the registered event subclass associated with class id. More...
static std::string	getEventTypeClassId (const std::type_info &oType) noexcept
	Gets the class id of the given type. More...

Constructor & Destructor Documentation

KeyActionEvent()

stmg::KeyActionEvent::KeyActionEvent ( int64_t  nTimeUsec, const shared_ptr< stmi::Accessor > &  refAccessor, const shared_ptr< stmi::Capability > &  refCapability, stmi::Event::AS_KEY_INPUT_TYPE  eType, int32_t  nKeyAction  )

noexcept

Member Function Documentation

getCapability()

shared_ptr<stmi::Capability> stmg::KeyActionEvent::getCapability ( ) const

inlineoverridevirtualnoexcept

Returns the capability that generated this event.

The Event subclass implementation keeps only a weak_ptr on the capability to avoid reference cycles.

Returns

The capability or null if the capability was deleted.

Implements stmi::Event.

getClass()

static const stmi::Event::Class& stmg::KeyActionEvent::getClass ( )

staticnoexcept

getKeyAction()

int32_t stmg::KeyActionEvent::getKeyAction ( ) const

inlinenoexcept

getType()

stmi::Event::AS_KEY_INPUT_TYPE stmg::KeyActionEvent::getType ( ) const

inlinenoexcept

setCapability()

void stmg::KeyActionEvent::setCapability ( const shared_ptr< stmi::Capability > &  refCapability )

protectednoexcept

Sets the capability of the key action event.

Parameters

refCapability

Cannot be null.

setKeyAction()

void stmg::KeyActionEvent::setKeyAction ( int32_t  nKeyAction )

protectednoexcept

setType()

void stmg::KeyActionEvent::setType ( stmi::Event::AS_KEY_INPUT_TYPE  eType )

protectednoexcept

Member Data Documentation

s_sClassId

const char* const stmg::KeyActionEvent::s_sClassId

static