REFERENCE MANUAL
The KeyboardState class represents the state of a keyboard for a particular event. More...
Public Member Functions | |
void | Assign (HPS.KeyboardState in_that) |
Copies the source KeyboardState into this KeyboardState. More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.KeyboardState in_that) |
Check if the source KeyboardState is equivalent to this KeyboardState. More... | |
HPS.KeyboardEvent | GetActiveEvent () |
Get the active event for this KeyboardState. More... | |
HPS.Key[] | GetEventPath () |
Get the relevant list of keys up to the window which had focus when the keys represented by this KeyboardState were pressed or released. More... | |
HPS.WindowKey | GetEventSource () |
Get the window which had focus when the keys represented by this KeyboardState were pressed or released. More... | |
override int | GetHashCode () |
ulong | GetKeyboardCodeCount () |
Get the number of keys currently down in this KeyboardState. More... | |
HPS.KeyboardCode[] | GetKeyboardCodes () |
Get the list of keyboard codes for keys currently down. More... | |
bool | GetKeyState (HPS.KeyboardCode in_key_code) |
Get the state of a specific keyboard code for this KeyboardState. More... | |
HPS.ModifierKeys | GetModifierKeys () |
Get an object representing the state of modifier keys for this KeyboardState. More... | |
KeyboardState () | |
The default constructor creates an empty KeyboardState object. More... | |
KeyboardState (HPS.KeyboardState in_that) | |
The copy constructor creates a new KeyboardState object that contains the same settings as the source KeyboardState. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.KeyboardState a, HPS.KeyboardState b) |
static bool | operator== (HPS.KeyboardState a, HPS.KeyboardState b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The KeyboardState class represents the state of a keyboard for a particular event.
HPS.KeyboardState.KeyboardState | ( | ) |
The default constructor creates an empty KeyboardState object.
HPS.KeyboardState.KeyboardState | ( | HPS.KeyboardState | in_that | ) |
The copy constructor creates a new KeyboardState object that contains the same settings as the source KeyboardState.
in_that | The source <ref refid="class_h_p_s_1_1_keyboard_state" kindref="compound">KeyboardState</ref> to copy. |
void HPS.KeyboardState.Assign | ( | HPS.KeyboardState | in_that | ) |
Copies the source KeyboardState into this KeyboardState.
in_that | The source <ref refid="class_h_p_s_1_1_keyboard_state" kindref="compound">KeyboardState</ref> to copy. |
bool HPS.KeyboardState.Equals | ( | HPS.KeyboardState | in_that | ) |
Check if the source KeyboardState is equivalent to this KeyboardState.
HPS.KeyboardEvent HPS.KeyboardState.GetActiveEvent | ( | ) |
Get the active event for this KeyboardState.
This will throw an exception if there is no active action for this KeyboardState.
HPS.Key [] HPS.KeyboardState.GetEventPath | ( | ) |
Get the relevant list of keys up to the window which had focus when the keys represented by this KeyboardState were pressed or released.
This will throw an exception if there is no event path for this KeyboardState.
HPS.WindowKey HPS.KeyboardState.GetEventSource | ( | ) |
Get the window which had focus when the keys represented by this KeyboardState were pressed or released.
This will throw an exception if there is no event source for this KeyboardState.
ulong HPS.KeyboardState.GetKeyboardCodeCount | ( | ) |
Get the number of keys currently down in this KeyboardState.
HPS.KeyboardCode [] HPS.KeyboardState.GetKeyboardCodes | ( | ) |
Get the list of keyboard codes for keys currently down.
bool HPS.KeyboardState.GetKeyState | ( | HPS.KeyboardCode | in_key_code | ) |
Get the state of a specific keyboard code for this KeyboardState.
in_key_code | The keyboard code for which to query the action. |
HPS.ModifierKeys HPS.KeyboardState.GetModifierKeys | ( | ) |
Get an object representing the state of modifier keys for this KeyboardState.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.