Inheritance diagram for HPS.KeyboardState:
HPS.Object

Public Member Functions

void Assign (HPS.KeyboardState in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.KeyboardState in_that)
 
HPS.KeyboardEvent GetActiveEvent ()
 
HPS.Key [] GetEventPath ()
 
HPS.WindowKey GetEventSource ()
 
override int GetHashCode ()
 
ulong GetKeyboardCodeCount ()
 
HPS.KeyboardCode [] GetKeyboardCodes ()
 
bool GetKeyState (HPS.KeyboardCode in_key_code)
 
HPS.ModifierKeys GetModifierKeys ()
 
 KeyboardState ()
 
 KeyboardState (HPS.KeyboardState in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Key[] in_path, HPS.KeyboardEvent in_event, HPS.KeyboardCode[] in_keyboard_codes, HPS.ModifierKeys in_modifiers)
 
void Set (HPS.Key[] in_path, HPS.KeyboardEvent in_event, HPS.KeyboardCode[] in_keyboard_codes)
 
void SetActiveEvent (HPS.KeyboardEvent in_event)
 
void SetEventPath (HPS.Key[] in_path)
 
void SetKeyboardCodes (HPS.KeyboardCode[] in_keyboard_codes)
 
void SetModifierKeys (HPS.ModifierKeys in_modifiers)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.KeyboardState a, HPS.KeyboardState b)
 
static bool operator== (HPS.KeyboardState a, HPS.KeyboardState b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The KeyboardState class represents the state of a keyboard for a particular event.

Constructor & Destructor Documentation

◆ KeyboardState() [1/2]

HPS.KeyboardState.KeyboardState ( )
inline

The default constructor creates an empty KeyboardState object.

◆ KeyboardState() [2/2]

HPS.KeyboardState.KeyboardState ( HPS.KeyboardState  in_that)
inline

The copy constructor creates a new KeyboardState object that contains the same settings as the source KeyboardState.

Parameters
in_thatThe source KeyboardState to copy.

Member Function Documentation

◆ Assign()

void HPS.KeyboardState.Assign ( HPS.KeyboardState  in_that)
inline

Copies the source KeyboardState into this KeyboardState.

Parameters
in_thatThe source KeyboardState to copy.

◆ Equals()

bool HPS.KeyboardState.Equals ( HPS.KeyboardState  in_that)
inline

Check if the source KeyboardState is equivalent to this KeyboardState.

Parameters
in_thatThe source KeyboardState to compare to this KeyboardState.
Returns
true if the objects are equivalent, false otherwise.

◆ GetActiveEvent()

HPS.KeyboardEvent HPS.KeyboardState.GetActiveEvent ( )
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.

◆ GetEventPath()

HPS.Key [] HPS.KeyboardState.GetEventPath ( )
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.

◆ GetEventSource()

HPS.WindowKey HPS.KeyboardState.GetEventSource ( )
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.

◆ GetKeyboardCodeCount()

ulong HPS.KeyboardState.GetKeyboardCodeCount ( )
inline

Get the number of keys currently down in this KeyboardState.

Returns
Number of active and inactive keyboard codes.

◆ GetKeyboardCodes()

HPS.KeyboardCode [] HPS.KeyboardState.GetKeyboardCodes ( )
inline

Get the list of keyboard codes for keys currently down in this KeyboardState.

Returns
The list of active and inactive keyboard codes.

◆ GetKeyState()

bool HPS.KeyboardState.GetKeyState ( HPS.KeyboardCode  in_key_code)
inline

Get the state of a specific keyboard code for this KeyboardState.

Parameters
in_key_codeThe keyboard code for which to query the action.
Returns
true if the key is down, false otherwise.

◆ GetModifierKeys()

HPS.ModifierKeys HPS.KeyboardState.GetModifierKeys ( )
inline

Get an object representing the state of modifier keys for this KeyboardState.

Returns
An object representing the state of modifier keys.

◆ ObjectType()

override HPS.Type HPS.KeyboardState.ObjectType ( )
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.

◆ Set() [1/2]

void HPS.KeyboardState.Set ( HPS.Key []  in_path,
HPS.KeyboardEvent  in_event,
HPS.KeyboardCode []  in_keyboard_codes,
HPS.ModifierKeys  in_modifiers 
)
inline

Sets the properties of this KeyboardState.

Parameters
in_pathThe list of keys up to the window which had focus for this keyboard event.
in_eventThe keyboard event.
in_keyboard_codesThe list of keyboard codes for keys currently down during this keyboard event.
in_modifiersThe state of modifier keys for this keyboard event.

◆ Set() [2/2]

void HPS.KeyboardState.Set ( HPS.Key []  in_path,
HPS.KeyboardEvent  in_event,
HPS.KeyboardCode []  in_keyboard_codes 
)
inline

Sets the properties of this KeyboardState.

Parameters
in_pathThe list of keys up to the window which had focus for this keyboard event.
in_eventThe keyboard event.
in_keyboard_codesThe list of keyboard codes for keys currently down during this keyboard event.

◆ SetActiveEvent()

void HPS.KeyboardState.SetActiveEvent ( HPS.KeyboardEvent  in_event)
inline

Sets the active event for this KeyboardState.

Parameters
in_eventThe action for this KeyboardState.

◆ SetEventPath()

void HPS.KeyboardState.SetEventPath ( HPS.Key []  in_path)
inline

Sets the relevant list of keys up to the window which had focus for this keyboard event.

Parameters
in_pathThe relevant list of keys up to the window which had focus when the keyboard event represented by this KeyboardState underwent the active action.

◆ SetKeyboardCodes()

void HPS.KeyboardState.SetKeyboardCodes ( HPS.KeyboardCode []  in_keyboard_codes)
inline

Sets the list of keyboard codes for keys currently down in this KeyboardState.

Parameters
in_keyboard_codesThe list of keyboard codes for keys currently down during this keyboard event.

◆ SetModifierKeys()

void HPS.KeyboardState.SetModifierKeys ( HPS.ModifierKeys  in_modifiers)
inline

Sets an object representing the state of modifier keys for this KeyboardState.

Parameters
in_modifiersAn 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