stmi::KeyEvent Class Reference

Event generated when the state of a key is changed. More...

Inheritance diagram for stmi::KeyEvent:

Public Types
enum	KEY_INPUT_TYPE { KEY_PRESS = AS_KEY_PRESS, KEY_RELEASE = AS_KEY_RELEASE, KEY_RELEASE_CANCEL = AS_KEY_RELEASE_CANCEL }
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...

Public Member Functions
	KeyEvent (int64_t nTimeUsec, const shared_ptr< Accessor > &refAccessor, const shared_ptr< KeyCapability > &refKeyCapability, KEY_INPUT_TYPE eType, HARDWARE_KEY eKey) noexcept
	Constructor. More...
KEY_INPUT_TYPE	getType () const noexcept
HARDWARE_KEY	getKey () const noexcept
shared_ptr< KeyCapability >	getKeyCapability () const noexcept
	The key capability that generated the event. More...
shared_ptr< Capability >	getCapability () const noexcept override
	Returns the capability that generated this event. More...
bool	getAsKey (HARDWARE_KEY &eKey, AS_KEY_INPUT_TYPE &eType, bool &bMoreThanOne) const noexcept override
	Returns the key. 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 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 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 (KEY_INPUT_TYPE eType) noexcept
	Sets the type. More...
void	setKey (HARDWARE_KEY eKey) noexcept
	Sets the key. More...
void	setKeyCapability (const shared_ptr< KeyCapability > &refKeyCapability) noexcept
	Sets the capability. 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
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...

Detailed Description

Event generated when the state of a key is changed.

Note that the reference to the capability that generated this event is weak.

Member Enumeration Documentation

KEY_INPUT_TYPE

enum stmi::KeyEvent::KEY_INPUT_TYPE

See also

Same as Event::AS_KEY_INPUT_TYPE

Enumerator
KEY_PRESS
KEY_RELEASE
KEY_RELEASE_CANCEL

Constructor & Destructor Documentation

KeyEvent()

stmi::KeyEvent::KeyEvent ( int64_t  nTimeUsec, const shared_ptr< Accessor > &  refAccessor, const shared_ptr< KeyCapability > &  refKeyCapability, KEY_INPUT_TYPE  eType, HARDWARE_KEY  eKey  )

noexcept

Constructor.

Parameters

nTimeUsec	Time from epoch in microseconds.
refAccessor	The accessor used to generate the event. Can be null.
refKeyCapability	The capability that generated this event. Cannot be null.
eType	The action type.
eKey	The key involved.

Member Function Documentation

getAsKey()

bool stmi::KeyEvent::getAsKey ( HARDWARE_KEY &  eKey, AS_KEY_INPUT_TYPE &  eType, bool &  bMoreThanOne  ) const

overridevirtualnoexcept

Returns the key.

Parameters

eKey	Same as getKey().
eType	Analogous to getType().
bMoreThanOne	Always false.

Returns

Always true.

Reimplemented from stmi::Event.

getCapability()

shared_ptr<Capability> stmi::KeyEvent::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 Event::Class& stmi::KeyEvent::getClass ( )

inlinestaticnoexcept

getKey()

HARDWARE_KEY stmi::KeyEvent::getKey ( ) const

inlinenoexcept

getKeyCapability()

shared_ptr<KeyCapability> stmi::KeyEvent::getKeyCapability ( ) const

inlinenoexcept

The key capability that generated the event.

Returns

The capability or null if the capability was deleted.

getType()

KEY_INPUT_TYPE stmi::KeyEvent::getType ( ) const

inlinenoexcept

setKey()

void stmi::KeyEvent::setKey ( HARDWARE_KEY  eKey )

inlineprotectednoexcept

Sets the key.

Parameters

eKey	The key involved.

setKeyCapability()

void stmi::KeyEvent::setKeyCapability ( const shared_ptr< KeyCapability > &  refKeyCapability )

inlineprotectednoexcept

Sets the capability.

Parameters

refKeyCapability

The capability that generated this event. Cannot be null.

setType()

void stmi::KeyEvent::setType ( KEY_INPUT_TYPE  eType )

inlineprotectednoexcept

Sets the type.

Parameters

eType

The action type.

Member Data Documentation

s_sClassId

const char* const stmi::KeyEvent::s_sClassId

static