Inheritance diagram for HPS.KeyboardEvent:
HPS.InputEvent HPS.Event

Public Types

enum  Action : uint { Action.None = 0x00000000, Action.KeyDown = 0x00000001, Action.KeyUp = 0x00000002 }
 
- Public Types inherited from HPS.Event
enum  Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 }
 

Public Member Functions

override HPS.Event Clone ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
override bool Equals (HPS.InputEvent in_that)
 
virtual bool Equals (HPS.KeyboardEvent in_that)
 
override int GetHashCode ()
 
 KeyboardEvent ()
 
 KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.ModifierKeys in_modifiers)
 
 KeyboardEvent (HPS.KeyboardEvent.Action in_action)
 
 KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.KeyboardCode[] in_keyboardcodes, HPS.ModifierKeys in_modifiers)
 
 KeyboardEvent (HPS.KeyboardEvent.Action in_action, HPS.KeyboardCode[] in_keyboardcodes)
 
 KeyboardEvent (HPS.Event in_event)
 
 KeyboardEvent (HPS.KeyboardEvent in_that)
 
void SetKeyboardCodes (HPS.KeyboardCode[] in_keyboardcodes)
 
- Public Member Functions inherited from HPS.InputEvent
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierKeys ()
 
 InputEvent ()
 
 InputEvent (HPS.ModifierKeys in_modifiers)
 
 InputEvent (HPS.InputEvent in_that)
 
- Public Member Functions inherited from HPS.Event
virtual bool Drop (HPS.Event in_that_event)
 
delegate void DtorDelegate (IntPtr cPtr)
 
 Event (IntPtr in_channel)
 
 Event ()
 
 Event (HPS.Event in_that)
 
virtual IntPtr Freshen ()
 
IntPtr GetChannel ()
 
IntPtr GetClassID ()
 
double GetTimeStamp ()
 
bool IsConsumable ()
 

Static Public Member Functions

static bool operator!= (HPS.KeyboardEvent a, HPS.KeyboardEvent b)
 
static bool operator== (HPS.KeyboardEvent a, HPS.KeyboardEvent b)
 
- Static Public Member Functions inherited from HPS.InputEvent
static bool operator!= (HPS.InputEvent a, HPS.InputEvent b)
 
static bool operator== (HPS.InputEvent a, HPS.InputEvent b)
 

Protected Member Functions

override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

Properties

HPS.KeyboardEvent.Action CurrentAction [get, set]
 
HPS.KeyboardCode [] KeyboardCodes [get, set]
 
- Properties inherited from HPS.InputEvent
HPS.ModifierKeys ModifierKeyState [get, set]
 

Additional Inherited Members

- Static Protected Member Functions inherited from HPS.Event
static void DtorCallback (IntPtr p)
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
- Static Protected Attributes inherited from HPS.Event
static Dictionary< IntPtr, EventcachedObjects = new Dictionary<IntPtr, Event>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

The KeyboardEvent class is the event generated for each key press and release.

Member Enumeration Documentation

◆ Action

enum HPS.KeyboardEvent.Action : uint
strong

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.

Constructor & Destructor Documentation

◆ KeyboardEvent() [1/6]

HPS.KeyboardEvent.KeyboardEvent ( )
inline

The default constructor creates a KeyboardEvent object with no current action nor any keyboard codes.

◆ KeyboardEvent() [2/6]

HPS.KeyboardEvent.KeyboardEvent ( HPS.KeyboardEvent.Action  in_action,
HPS.ModifierKeys  in_modifiers 
)
inline

This constructor creates a KeyboardEvent object for a given action without any keyboard codes.

Parameters
in_actionAction of the keys for this KeyboardEvent.
in_modifiersThe modifier keys for this KeyboardEvent.

◆ KeyboardEvent() [3/6]

HPS.KeyboardEvent.KeyboardEvent ( HPS.KeyboardEvent.Action  in_action)
inline

This constructor creates a KeyboardEvent object for a given action without any keyboard codes.

Parameters
in_actionAction of the keys for this KeyboardEvent.

◆ KeyboardEvent() [4/6]

HPS.KeyboardEvent.KeyboardEvent ( HPS.KeyboardEvent.Action  in_action,
HPS.KeyboardCode []  in_keyboardcodes,
HPS.ModifierKeys  in_modifiers 
)
inline

This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.

Parameters
in_actionAction of the keys for this KeyboardEvent.
in_keyboardcodesArray of the keyboard codes for this KeyboardEvent.
in_modifiersThe modifier keys for this KeyboardEvent.

◆ KeyboardEvent() [5/6]

HPS.KeyboardEvent.KeyboardEvent ( HPS.KeyboardEvent.Action  in_action,
HPS.KeyboardCode []  in_keyboardcodes 
)
inline

This constructor creates a KeyboardEvent object for a given action with a list of keyboard codes.

Parameters
in_actionAction of the keys for this KeyboardEvent.
in_keyboardcodesArray of the keyboard codes for this KeyboardEvent.

◆ KeyboardEvent() [6/6]

HPS.KeyboardEvent.KeyboardEvent ( HPS.Event  in_event)
inline

This constructor converts an EventObject to a MouseEvent object.

Parameters
in_eventThe EventObject to be converted.

Member Function Documentation

◆ Clone()

override HPS.Event HPS.KeyboardEvent.Clone ( )
inlinevirtual

Allocates and returns a copy of this KeyboardEvent.

Returns
A copy of this KeyboardEvent.

Reimplemented from HPS.InputEvent.

◆ Equals() [1/2]

override bool HPS.KeyboardEvent.Equals ( HPS.InputEvent  in_that)
inlinevirtual

Check if the source object is equivalent to this object.

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

Reimplemented from HPS.InputEvent.

◆ Equals() [2/2]

virtual bool HPS.KeyboardEvent.Equals ( HPS.KeyboardEvent  in_that)
inlinevirtual

Check if the source object is equivalent to this object.

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

◆ SetKeyboardCodes()

void HPS.KeyboardEvent.SetKeyboardCodes ( HPS.KeyboardCode []  in_keyboardcodes)
inline

Sets the keyboard codes for this KeyboardEvent.

Parameters
in_keyboardcodesArray of the keyboard codes for this KeyboardEvent.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.KeyboardEvent.cs