REFERENCE MANUAL
The KeyboardEvent class is the event generated for each key press and release. More...
Public Types | |
enum | Action { Action.None = 0, Action.KeyDown = 1, Action.KeyUp = 2 } |
Enumeration of various states keyboard codes can have for a KeyboardEvent. More... | |
![]() | |
enum | Status { Status.InProgress = 0, Status.Completed = 1, Status.Failed = 2 } |
Event Status - returned from a notifier to give the status of the event. More... | |
Public Member Functions | |
override HPS.Event | Clone () |
Allocates and returns a copy of this KeyboardEvent. More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
virtual bool | Equals (HPS.KeyboardEvent in_that) |
Check if the source object is equivalent to this object. More... | |
override int | GetHashCode () |
KeyboardEvent () | |
The default constructor creates a KeyboardEvent object with no current action nor any keyboard codes. More... | |
KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.ModifierKeys in_modifiers) | |
This constructor creates a KeyboardEvent object for a given action without any keyboard codes. More... | |
KeyboardEvent (HPS.KeyboardEvent.Action in_action) | |
This constructor creates a KeyboardEvent object for a given action without any keyboard codes. More... | |
KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.KeyboardCode[] in_keyboardcodes, HPS.ModifierKeys in_modifiers) | |
This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes. More... | |
KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.KeyboardCode[] in_keyboardcodes) | |
This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes. More... | |
KeyboardEvent (HPS.Event in_event) | |
This constructor converts an EventObject to a MouseEvent object. More... | |
KeyboardEvent (HPS.KeyboardEvent in_that) | |
void | SetKeyboardCodes (HPS.KeyboardCode[] in_keyboardcodes) |
Sets the keyboard codes for this KeyboardEvent. More... | |
![]() | |
override bool | Equals (System.Object obj) |
virtual bool | Equals (HPS.InputEvent in_that) |
Check if the source object is equivalent to this object. More... | |
override int | GetHashCode () |
HPS.ModifierKeys | GetModifierKeys () |
Query whether a particular modifier key is active for this InputEvent. More... | |
![]() | |
virtual bool | Drop (HPS.Event in_that_event) |
This optional function is used to determine if the current event can be dropped based on the following event in the queue. More... | |
delegate void | DtorDelegate (IntPtr cPtr) |
Event (IntPtr in_channel) | |
A constructor for generating events from built-in or custom event ID's. More... | |
Event () | |
A constructor for generating events from built-in or custom event ID's. More... | |
Event (HPS.Event in_that) | |
delegate IntPtr | EventDelegate_0 () |
delegate bool | EventDelegate_1 (IntPtr in_that_event) |
delegate IntPtr | EventDelegate_2 () |
virtual IntPtr | Freshen () |
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 | GetChannel () |
Returns the channel ID assigned to an event. More... | |
IntPtr | GetClassID () |
double | GetTimeStamp () |
Returns the time an event was injected into the event queue. More... | |
bool | IsConsumable () |
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 bool | operator!= (HPS.KeyboardEvent a, HPS.KeyboardEvent b) |
static bool | operator== (HPS.KeyboardEvent a, HPS.KeyboardEvent b) |
![]() | |
static bool | operator!= (HPS.InputEvent a, HPS.InputEvent b) |
static bool | operator== (HPS.InputEvent a, HPS.InputEvent b) |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
void | DtorCallback (IntPtr p) |
virtual IntPtr | GetNonDirectorClassID () |
Properties | |
HPS.KeyboardEvent.Action | CurrentAction [get, set] |
HPS.KeyboardCode[] | KeyboardCodes [get, set] |
![]() | |
HPS.ModifierKeys | ModifierKeyState [get, set] |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The KeyboardEvent class is the event generated for each key press and release.
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. |
HPS.KeyboardEvent.KeyboardEvent | ( | ) |
The default constructor creates a KeyboardEvent object with no current action nor any keyboard codes.
HPS.KeyboardEvent.KeyboardEvent | ( | HPS.KeyboardEvent.Action | in_action, |
HPS.ModifierKeys | in_modifiers | ||
) |
This constructor creates a KeyboardEvent object for a given action without any keyboard codes.
in_action | Action of the keys for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>. |
HPS.KeyboardEvent.KeyboardEvent | ( | HPS.KeyboardEvent.Action | in_action | ) |
This constructor creates a KeyboardEvent object for a given action without any keyboard codes.
in_action | Action of the keys for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>. |
HPS.KeyboardEvent.KeyboardEvent | ( | HPS.KeyboardEvent.Action | in_action, |
HPS.KeyboardCode[] | in_keyboardcodes, | ||
HPS.ModifierKeys | in_modifiers | ||
) |
This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.
in_action | Action of the keys for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>. |
in_keyboardcode_count | Size of the following array. |
in_keyboardcodes | Array of the keyboard codes for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>. |
HPS.KeyboardEvent.KeyboardEvent | ( | HPS.KeyboardEvent.Action | in_action, |
HPS.KeyboardCode[] | in_keyboardcodes | ||
) |
This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.
in_action | Action of the keys for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>. |
in_keyboardcode_count | Size of the following array. |
in_keyboardcodes | Array of the keyboard codes for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>. |
HPS.KeyboardEvent.KeyboardEvent | ( | HPS.Event | in_event | ) |
This constructor converts an EventObject to a MouseEvent object.
|
virtual |
Allocates and returns a copy of this KeyboardEvent.
Reimplemented from HPS.InputEvent.
|
virtual |
Check if the source object is equivalent to this object.
void HPS.KeyboardEvent.SetKeyboardCodes | ( | HPS.KeyboardCode[] | in_keyboardcodes | ) |
Sets the keyboard codes for this KeyboardEvent.
in_keyboardcode_count | Size of the following array. |
in_keyboardcodes | Array of the keyboard codes for this <ref refid="class_h_p_s_1_1_keyboard_event" kindref="compound">KeyboardEvent</ref>. |