#include <hps.h>
|
static void | operator delete (void *in_ptr, size_t in_size) throw () |
|
static void * | operator new (size_t in_size) |
|
intptr_t | channel |
|
bool | consumable |
|
The KeyboardEvent class is the event generated for each key press and release.
◆ Action
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.
|
◆ 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]
This constructor creates a KeyboardEvent object for a given action without any keyboard codes.
- Parameters
-
◆ KeyboardEvent() [3/5]
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]
This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.
- Parameters
-
◆ KeyboardEvent() [5/5]
HPS::KeyboardEvent::KeyboardEvent |
( |
Event const & |
in_event | ) |
|
|
inline |
◆ Clone()
Event* HPS::KeyboardEvent::Clone |
( |
| ) |
const |
|
inlinevirtual |
◆ 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_that | The source object to compare to this object. |
- Returns
- true if the objects are equivalent, false otherwise.
Reimplemented from HPS::InputEvent.
◆ 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.
◆ operator!=()
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==()
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]
The documentation for this class was generated from the following file: