
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. This will throw an exception if there is no active action 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. This will throw an exception if there is no event path for this KeyboardState. More... | |
HPS.WindowKey | 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. 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 in this KeyboardState. 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 (if the object is derived, this does not give the true type of the derived object). More... | |
void | Set (HPS.Key[] in_path, HPS.KeyboardEvent in_event, HPS.KeyboardCode[] in_keyboard_codes, HPS.ModifierKeys in_modifiers) |
Sets the properties of this KeyboardState. More... | |
void | Set (HPS.Key[] in_path, HPS.KeyboardEvent in_event, HPS.KeyboardCode[] in_keyboard_codes) |
Sets the properties of this KeyboardState. More... | |
void | SetActiveEvent (HPS.KeyboardEvent in_event) |
Sets the active event for this KeyboardState. More... | |
void | SetEventPath (HPS.Key[] in_path) |
Sets the relevant list of keys up to the window which had focus for this keyboard event. More... | |
void | SetKeyboardCodes (HPS.KeyboardCode[] in_keyboard_codes) |
Sets the list of keyboard codes for keys currently down in this KeyboardState. More... | |
void | SetModifierKeys (HPS.ModifierKeys in_modifiers) |
Sets an object representing the state of modifier keys for this KeyboardState. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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 |
Detailed Description
The KeyboardState class represents the state of a keyboard for a particular event.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty KeyboardState object.
|
inline |
The copy constructor creates a new KeyboardState object that contains the same settings as the source KeyboardState.
- Parameters
-
in_that The source KeyboardState to copy.
Member Function Documentation
|
inline |
Copies the source KeyboardState into this KeyboardState.
- Parameters
-
in_that The source KeyboardState to copy.
|
inline |
Check if the source KeyboardState is equivalent to this KeyboardState.
- Parameters
-
in_that The source KeyboardState to compare to this KeyboardState.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Get the active event for this KeyboardState. This will throw an exception if there is no active action for this KeyboardState.
- Returns
- The action for the active keyboard codes for this KeyboardState.
|
inline |
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.
- Returns
- The relevant list of keys up to the window which had focus when the keys represented by this KeyboardState were pressed or released.
|
inline |
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.
- Returns
- The window which had focus when the keys represented by this KeyboardState were pressed or released.
|
inline |
Get the number of keys currently down in this KeyboardState.
- Returns
- Number of active and inactive keyboard codes.
|
inline |
Get the list of keyboard codes for keys currently down in this KeyboardState.
- Returns
- The list of active and inactive keyboard codes.
|
inline |
Get the state of a specific keyboard code for this KeyboardState.
- Parameters
-
in_key_code The keyboard code for which to query the action.
- Returns
- true if the key is down, false otherwise.
|
inline |
Get an object representing the state of modifier keys for this KeyboardState.
- Returns
- An object representing the state of modifier keys.
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inline |
Sets the properties of this KeyboardState.
- Parameters
-
in_path The list of keys up to the window which had focus for this keyboard event. in_event The keyboard event. in_keyboard_codes The list of keyboard codes for keys currently down during this keyboard event. in_modifiers The state of modifier keys for this keyboard event.
|
inline |
Sets the properties of this KeyboardState.
- Parameters
-
in_path The list of keys up to the window which had focus for this keyboard event. in_event The keyboard event. in_keyboard_codes The list of keyboard codes for keys currently down during this keyboard event.
|
inline |
Sets the active event for this KeyboardState.
- Parameters
-
in_event The action for this KeyboardState.
|
inline |
Sets the relevant list of keys up to the window which had focus for this keyboard event.
- Parameters
-
in_path The relevant list of keys up to the window which had focus when the keyboard event represented by this KeyboardState underwent the active action.
|
inline |
Sets the list of keyboard codes for keys currently down in this KeyboardState.
- Parameters
-
in_keyboard_codes The list of keyboard codes for keys currently down during this keyboard event.
|
inline |
Sets an object representing the state of modifier keys for this KeyboardState.
- Parameters
-
in_modifiers An object representing the state of modifier keys.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.KeyboardState.cs