KeyboardEvent

class HPS::KeyboardEvent : public HPS::InputEvent 

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

Public Types

enum Action

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

Values:

enumerator None: Key is not currently pressed, nor was it just released.

enumerator KeyDown: Key was pressed.

enumerator KeyUp: Key was released.

Public Functions

inline virtual Event *Clone() const

Allocates and returns a copy of this KeyboardEvent.

Returns: A copy of this KeyboardEvent.

inline virtual bool Equals(InputEvent const &in_that) const

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.

inline virtual bool Equals(KeyboardEvent const &in_that) const

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.

inline KeyboardEvent(): The default constructor creates a KeyboardEvent object with no current action nor any keyboard codes.

inline KeyboardEvent(Event const &in_event)

This constructor converts an Event Object to a MouseEvent object.

Parameters: in_event – The Event Object to be converted.

inline 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.

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.

inline KeyboardEvent(KeyboardEvent::Action in_action, ModifierKeys in_modifiers = ModifierKeys())

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.

inline 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.

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.

inline virtual bool operator!=(KeyboardEvent const &in_that) const

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.

inline virtual bool operator==(KeyboardEvent const &in_that) const

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.

inline void SetKeyboardCodes(HPS::KeyboardCodeArray const &in_keyboardcodes)

Sets the keyboard codes for this KeyboardEvent.

Parameters: in_keyboardcodes – Array of the keyboard codes for this KeyboardEvent.

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

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.

~KeyboardEvent()

Public Members

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

HPS::KeyboardCodeArray KeyboardCodes: Array of keyboard codes for this KeyboardEvent.