API Search || Global Search

More...

Inheritance diagram for HPS.KeyboardState:
HPS.Object

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. This does not necessarily give the true type of the underlying 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...
 
- Public Member Functions inherited from HPS.Object
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. 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 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

HPS.KeyboardState.KeyboardState ( )
inline

The default constructor creates an empty KeyboardState object.

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

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

Copies the source KeyboardState into this KeyboardState.

Parameters
in_thatThe source KeyboardState to copy.
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.
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.
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.
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.
ulong HPS.KeyboardState.GetKeyboardCodeCount ( )
inline

Get the number of keys currently down in this KeyboardState.

Returns
    Number of active and inactive keyboard codes.
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.
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.
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.
override HPS.Type HPS.KeyboardState.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
    The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

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.
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.
void HPS.KeyboardState.SetActiveEvent ( HPS.KeyboardEvent  in_event)
inline

Sets the active event for this KeyboardState.

Parameters
in_eventThe action for this KeyboardState.
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.
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.
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