InputEvent

class HPS::InputEvent : public HPS::Event 

The InputEvent class is the base class for input events such as MouseEvent, TouchEvent, and KeyboardEvent. It contains functionality which is common to all input event types, namely the state of modifier keys.

Subclassed by HPS::KeyboardEvent, HPS::MouseEvent, HPS::TouchEvent

Public Functions

inline virtual Event *Clone() const

Allocates and returns a copy of this InputEvent.

Returns: A copy of this InputEvent.

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

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.

inline ModifierKeys GetModifierKeys() const

Queries which modifier keys are active

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

inline InputEvent(): This constructor creates a default InputEvent object.

inline InputEvent(ModifierKeys const &in_modifiers)

This constructor creates a new InputEvent with the specified modifier keys initialized.

Parameters: in_modifiers – The modifier keys associated with the new Event.

inline virtual bool operator!=(InputEvent 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==(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.

~InputEvent()

Public Members

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