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

Public Member Functions

override HPS.Event Clone ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.InputEvent in_that)
 
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.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.ModifierKeys ModifierKeyState [get, set]
 

Additional Inherited Members

- Public Types inherited from HPS.Event
enum  Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 }
 
- 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 InputEvent class is the base class for input events such as MouseEvent, TouchEvent, and KeyboardEvent. It contains functionality which is common to all input event types, namely the state of modifier keys.

Constructor & Destructor Documentation

◆ InputEvent() [1/2]

HPS.InputEvent.InputEvent ( )
inline

This constructor creates a default InputEvent object.

◆ InputEvent() [2/2]

HPS.InputEvent.InputEvent ( HPS.ModifierKeys  in_modifiers)
inline

This constructor creates a new InputEvent with the specified modifier keys initialized.

Parameters
in_modifiersThe modifier keys associated with the new Event.

Member Function Documentation

◆ Clone()

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

Allocates and returns a copy of this InputEvent.

Returns
A copy of this InputEvent.

Implements HPS.Event.

Reimplemented in HPS.MouseEvent, HPS.KeyboardEvent, and HPS.TouchEvent.

◆ Equals()

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

Check if the source object is equivalent to this object.

Returns
true if the objects are equivalent, false otherwise.

Reimplemented in HPS.MouseEvent, HPS.KeyboardEvent, and HPS.TouchEvent.

◆ GetModifierKeys()

HPS.ModifierKeys HPS.InputEvent.GetModifierKeys ( )
inline

Queries which modifier keys are active

Returns
A ModifierKeys object, which represents which modifier keys are active

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