#include <hps.h>
Public Types | |
| enum | Action { Action::None, Action::KeyDown, Action::KeyUp } |
Public Types inherited from HPS::Event | |
| enum | Status { Status::InProgress, Status::Completed, Status::Failed } |
Public Member Functions | |
| KeyboardEvent () | |
| KeyboardEvent (KeyboardEvent::Action in_action, ModifierKeys in_modifiers=ModifierKeys()) | |
| KeyboardEvent (KeyboardEvent::Action in_action, size_t in_keyboardcode_count, HPS::KeyboardCode const in_keyboardcodes[], ModifierKeys in_modifiers=ModifierKeys()) | |
| KeyboardEvent (KeyboardEvent::Action in_action, KeyboardCodeArray const &in_keyboardcodes, ModifierKeys in_modifiers=ModifierKeys()) | |
| KeyboardEvent (Event const &in_event) | |
| Event * | Clone () const |
| virtual bool | Equals (KeyboardEvent const &in_that) const |
| virtual bool | operator== (KeyboardEvent const &in_that) const |
| virtual bool | operator!= (KeyboardEvent const &in_that) const |
| void | SetKeyboardCodes (size_t in_keyboardcode_count, HPS::KeyboardCode const in_keyboardcodes[]) |
| void | SetKeyboardCodes (HPS::KeyboardCodeArray const &in_keyboardcodes) |
Public Member Functions inherited from HPS::InputEvent | |
| InputEvent () | |
| InputEvent (ModifierKeys const &in_modifiers) | |
| virtual bool | Equals (InputEvent const &in_that) const |
| virtual bool | operator== (InputEvent const &in_that) const |
| virtual bool | operator!= (InputEvent const &in_that) const |
| ModifierKeys | GetModifierKeys () const |
Public Member Functions inherited from HPS::Event | |
| Event (intptr_t in_channel=0) | |
| intptr_t | GetClassID () const |
| virtual bool | Drop (Event const *in_that_event) const |
| virtual intptr_t | Freshen () const |
| intptr_t | GetChannel () const |
| Time | GetTimeStamp () const |
| bool | IsConsumable () const |
Public Attributes | |
| HPS::KeyboardCodeArray | KeyboardCodes |
| Array of keyboard codes for this KeyboardEvent. | |
| HPS::KeyboardEvent::Action | CurrentAction |
| The action for the keyboard codes for this KeyboardEvent. | |
Public Attributes inherited from HPS::InputEvent | |
| ModifierKeys | ModifierKeyState |
| The modifier keys which are active for this InputEvent. | |
Additional Inherited Members | |
Static Public Member Functions inherited from HPS::Event | |
| static void * | operator new (size_t in_size) |
| static void | operator delete (void *in_ptr, size_t in_size) throw () |
Protected Attributes inherited from HPS::Event | |
| intptr_t | channel |
| bool | consumable |
The KeyboardEvent class is the event generated for each key press and release.
|
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. |
|
inline |
The default constructor creates a KeyboardEvent object with no current action nor any keyboard codes.
|
inline |
This constructor creates a KeyboardEvent object for a given action without any keyboard codes.
| in_action | Action of the keys for this KeyboardEvent. |
| in_modifier | The modifier keys for this KeyboardEvent. |
|
inline |
This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.
| 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_modifier | The modifier keys for this KeyboardEvent. |
|
inline |
This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.
| in_action | Action of the keys for this KeyboardEvent. |
| in_keyboardcodes | Array of the keyboard codes for this KeyboardEvent. |
| in_modifier | The modifier keys for this KeyboardEvent. |
|
inline |
This constructor converts an Event Object to a MouseEvent object.
|
inlinevirtual |
Allocates and returns a copy of this KeyboardEvent.
Reimplemented from HPS::InputEvent.
|
inlinevirtual |
Check if the source object is equivalent to this object.
| in_kit | The source object to compare to this object. |
|
inlinevirtual |
Check if the source object is not equivalent to this object.
| in_kit | The source object to compare to this object. |
|
inlinevirtual |
Check if the source object is equivalent to this object.
| in_kit | The source object to compare to this object. |
|
inline |
Sets the keyboard codes for this KeyboardEvent.
| in_keyboardcode_count | Size of the following array. |
| in_keyboardcodes | Array of the keyboard codes for this KeyboardEvent. |
|
inline |
Sets the keyboard codes for this KeyboardEvent.
| in_keyboardcodes | Array of the keyboard codes for this KeyboardEvent. |