The KeyboardEvent class is the event generated for each key press and release. More...

#include <hps.h>

Inheritance diagram for HPS::KeyboardEvent:

Collaboration diagram for HPS::KeyboardEvent:

[legend]

Public Types
enum	Action : uint32_t { Action::None, Action::KeyDown, Action::KeyUp }
	Enumeration of various states keyboard codes can have for a KeyboardEvent. More...

enum	Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
	Event Status - returned from a notifier to give the status of the event. More...

Public Member Functions
	KeyboardEvent ()
	The default constructor creates a KeyboardEvent object with no current action nor any keyboard codes. More...

	KeyboardEvent (KeyboardEvent::Action in_action, ModifierKeys in_modifiers=ModifierKeys())
	This constructor creates a KeyboardEvent object for a given action without any keyboard codes. More...

	KeyboardEvent (KeyboardEvent::Action in_action, size_t in_keyboardcode_count, HPS::KeyboardCode const in_keyboardcodes[], ModifierKeys in_modifiers=ModifierKeys())
	This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes. More...

	KeyboardEvent (KeyboardEvent::Action in_action, KeyboardCodeArray const &in_keyboardcodes, ModifierKeys in_modifiers=ModifierKeys())
	This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes. More...

	KeyboardEvent (Event const &in_event)
	This constructor converts an Event Object to a MouseEvent object. More...

	~KeyboardEvent ()

Event *	Clone () const
	Allocates and returns a copy of this KeyboardEvent. More...

virtual bool	Equals (InputEvent const &in_that) const
	Check if the source object is equivalent to this object. More...

virtual bool	Equals (KeyboardEvent const &in_that) const
	Check if the source object is equivalent to this object. More...

virtual bool	operator== (KeyboardEvent const &in_that) const
	Check if the source object is equivalent to this object. More...

virtual bool	operator!= (KeyboardEvent const &in_that) const
	Check if the source object is not equivalent to this object. More...

void	SetKeyboardCodes (size_t in_keyboardcode_count, HPS::KeyboardCode const in_keyboardcodes[])
	Sets the keyboard codes for this KeyboardEvent. More...

void	SetKeyboardCodes (HPS::KeyboardCodeArray const &in_keyboardcodes)
	Sets the keyboard codes for this KeyboardEvent. More...

virtual bool	operator== (InputEvent const &in_that) const
	Check if the source object is equivalent to this object. More...

virtual bool	operator!= (InputEvent const &in_that) const
	Check if the source object is not equivalent to this object. More...

ModifierKeys	GetModifierKeys () const
	Queries which modifier keys are active. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

virtual bool	Drop (Event const *in_that_event) const
	This optional function is used to determine if the current event can be dropped based on the following event in the queue. More...

virtual intptr_t	Freshen () const
	This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available. More...

intptr_t	GetChannel () const
	Returns the channel ID assigned to an event. More...

Time	GetTimeStamp () const
	Returns the time an event was injected into the event queue. More...

bool	IsConsumable () const
	Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More...

Static Public Member Functions
static void *	operator new (size_t in_size)

static void	operator delete (void *in_ptr, size_t in_size) throw ()

Public Attributes
HPS::KeyboardCodeArray	KeyboardCodes
	Array of keyboard codes for this KeyboardEvent. More...

HPS::KeyboardEvent::Action	CurrentAction
	The action for the keyboard codes for this KeyboardEvent. More...

ModifierKeys	ModifierKeyState
	The modifier keys which are active for this InputEvent. More...

Protected Attributes
intptr_t	channel

bool	consumable

Detailed Description

The KeyboardEvent class is the event generated for each key press and release.

Member Enumeration Documentation

◆ Action

enum HPS::KeyboardEvent::Action : uint32_t

strong

Enumeration of various states keyboard codes can have for a KeyboardEvent.

Enumerator
None	Key is not currently pressed, nor was it just released.
KeyDown	Key was pressed.
KeyUp	Key was released.

◆ Status

enum HPS::Event::Status : uint32_t

stronginherited

Event Status - returned from a notifier to give the status of the event.

Enumerator
InProgress	Event is still in progress.
Completed	Event has completed.
Failed	Event failed.

Constructor & Destructor Documentation

◆ KeyboardEvent() [1/5]

HPS::KeyboardEvent::KeyboardEvent ( )

inline

The default constructor creates a KeyboardEvent object with no current action nor any keyboard codes.

◆ KeyboardEvent() [2/5]

HPS::KeyboardEvent::KeyboardEvent	(	KeyboardEvent::Action	in_action,
		ModifierKeys	in_modifiers = `ModifierKeys()`
	)

inline

This constructor creates a KeyboardEvent object for a given action without any keyboard codes.

Parameters

in_action	Action of the keys for this KeyboardEvent.
in_modifiers	The modifier keys for this KeyboardEvent.

◆ KeyboardEvent() [3/5]

HPS::KeyboardEvent::KeyboardEvent	(	KeyboardEvent::Action	in_action,
		size_t	in_keyboardcode_count,
		HPS::KeyboardCode const	in_keyboardcodes[],
		ModifierKeys	in_modifiers = `ModifierKeys()`
	)

inline

This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.

Parameters

in_action	Action of the keys for this KeyboardEvent.
in_keyboardcode_count	Size of the following array.
in_keyboardcodes	Array of the keyboard codes for this KeyboardEvent.
in_modifiers	The modifier keys for this KeyboardEvent.

◆ KeyboardEvent() [4/5]

HPS::KeyboardEvent::KeyboardEvent	(	KeyboardEvent::Action	in_action,
		KeyboardCodeArray const &	in_keyboardcodes,
		ModifierKeys	in_modifiers = `ModifierKeys()`
	)

inline

This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.

Parameters

in_action	Action of the keys for this KeyboardEvent.
in_keyboardcodes	Array of the keyboard codes for this KeyboardEvent.
in_modifiers	The modifier keys for this KeyboardEvent.

◆ KeyboardEvent() [5/5]

HPS::KeyboardEvent::KeyboardEvent ( Event const & in_event )

inline

This constructor converts an Event Object to a MouseEvent object.

Parameters

in_event The Event Object to be converted.

Here is the call graph for this function:

◆ ~KeyboardEvent()

HPS::KeyboardEvent::~KeyboardEvent ( )

Member Function Documentation

◆ Clone()

Event* HPS::KeyboardEvent::Clone ( ) const

inlinevirtual

Allocates and returns a copy of this KeyboardEvent.

Returns: A copy of this KeyboardEvent.

Reimplemented from HPS::InputEvent.

◆ Drop()

virtual bool HPS::Event::Drop ( Event const * in_that_event ) const

inlinevirtualinherited

This optional function is used to determine if the current event can be dropped based on the following event in the queue.

Reimplemented in HPS::MouseEvent, HPS::TouchEvent, HPS::TimerTickEvent, HPS::SmoothTransitionCompleteEvent, and HPS::CameraChangedEvent.

◆ Equals() [1/2]

virtual bool HPS::KeyboardEvent::Equals ( InputEvent const & in_that ) const

inlinevirtual

Check if the source object is equivalent to this object.

Parameters

in_kit The source object to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

Reimplemented from HPS::InputEvent.

Here is the call graph for this function:

◆ Equals() [2/2]

virtual bool HPS::KeyboardEvent::Equals ( KeyboardEvent const & in_that ) const

inlinevirtual

Check if the source object is equivalent to this object.

Parameters

in_that The source object to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

Here is the call graph for this function:

◆ Freshen()

virtual intptr_t HPS::Event::Freshen ( ) const

inlinevirtualinherited

This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available.

Returns: A cookie representing the freshen category. Zero indicates a non-freshening event.

Reimplemented in HPS::MouseEvent, HPS::TimerTickEvent, and HPS::CameraChangedEvent.

◆ GetChannel()

intptr_t HPS::Event::GetChannel ( ) const

inlineinherited

Returns the channel ID assigned to an event.

Here is the caller graph for this function:

◆ GetClassID()

intptr_t HPS::Event::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Here is the caller graph for this function:

◆ GetModifierKeys()

ModifierKeys HPS::InputEvent::GetModifierKeys ( ) const

inlineinherited

Queries which modifier keys are active.

Returns: A ModifierKeys object, which represents which modifier keys are active

◆ GetTimeStamp()

Time HPS::Event::GetTimeStamp ( ) const

inlineinherited

Returns the time an event was injected into the event queue.

◆ IsConsumable()

bool HPS::Event::IsConsumable ( ) const

inlineinherited

Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway.

◆ operator delete()

static void HPS::Event::operator delete	(	void *	in_ptr,
		size_t	in_size
	)
throw	(
	)

inlinestaticinherited

Here is the call graph for this function:

◆ operator new()

static void* HPS::Event::operator new ( size_t in_size )

inlinestaticinherited

Here is the call graph for this function:

◆ operator!=() [1/2]

virtual bool HPS::InputEvent::operator!= ( InputEvent const & in_that ) const

inlinevirtualinherited

Check if the source object is not equivalent to this object.

Parameters

in_that The source object to compare to this object.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator!=() [2/2]

virtual bool HPS::KeyboardEvent::operator!= ( KeyboardEvent const & in_that ) const

inlinevirtual

Check if the source object is not equivalent to this object.

Parameters

in_that The source object to compare to this object.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator==() [1/2]

virtual bool HPS::InputEvent::operator== ( InputEvent const & in_that ) const

inlinevirtualinherited

Check if the source object is equivalent to this object.

Parameters

in_that The source object to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ operator==() [2/2]

virtual bool HPS::KeyboardEvent::operator== ( KeyboardEvent const & in_that ) const

inlinevirtual

Check if the source object is equivalent to this object.

Parameters

in_that The source object to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ SetKeyboardCodes() [1/2]

void HPS::KeyboardEvent::SetKeyboardCodes	(	size_t	in_keyboardcode_count,
		HPS::KeyboardCode const	in_keyboardcodes[]
	)

inline

Sets the keyboard codes for this KeyboardEvent.

Parameters

in_keyboardcode_count	Size of the following array.
in_keyboardcodes	Array of the keyboard codes for this KeyboardEvent.

◆ SetKeyboardCodes() [2/2]

void HPS::KeyboardEvent::SetKeyboardCodes ( HPS::KeyboardCodeArray const & in_keyboardcodes )

inline

Sets the keyboard codes for this KeyboardEvent.

Parameters

in_keyboardcodes Array of the keyboard codes for this KeyboardEvent.

Member Data Documentation

◆ channel

intptr_t HPS::Event::channel

protectedinherited

◆ consumable

bool HPS::Event::consumable

protectedinherited

◆ CurrentAction

HPS::KeyboardEvent::Action HPS::KeyboardEvent::CurrentAction

The action for the keyboard codes for this KeyboardEvent.

◆ KeyboardCodes

HPS::KeyboardCodeArray HPS::KeyboardEvent::KeyboardCodes

Array of keyboard codes for this KeyboardEvent.

◆ ModifierKeyState

ModifierKeys HPS::InputEvent::ModifierKeyState

inherited

The modifier keys which are active for this InputEvent.

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

hps.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Action

◆ Status

Constructor & Destructor Documentation

◆ KeyboardEvent() [1/5]

◆ KeyboardEvent() [2/5]

◆ KeyboardEvent() [3/5]

◆ KeyboardEvent() [4/5]

◆ KeyboardEvent() [5/5]

◆ ~KeyboardEvent()

Member Function Documentation

◆ Clone()

◆ Drop()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ Freshen()

◆ GetChannel()

◆ GetClassID()

◆ GetModifierKeys()

◆ GetTimeStamp()

◆ IsConsumable()

◆ operator delete()

◆ operator new()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ SetKeyboardCodes() [1/2]

◆ SetKeyboardCodes() [2/2]

Member Data Documentation

◆ channel

◆ consumable

◆ CurrentAction

◆ KeyboardCodes

◆ ModifierKeyState