More...

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

Public Member Functions

override HPS.Event Clone ()
 Allocates and returns a copy of this InputEvent. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.InputEvent in_that)
 Check if the source object is equivalent to this object. More...
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierKeys ()
 Queries which modifier keys are active More...
 
 InputEvent ()
 This constructor creates a default InputEvent object. More...
 
 InputEvent (HPS.ModifierKeys in_modifiers)
 This constructor creates a new InputEvent with the specified modifier keys initialized. More...
 
 InputEvent (HPS.InputEvent in_that)
 
delegate IntPtr InputEventDelegate_0 (IntPtr cPtr)
 
delegate bool InputEventDelegate_1 (IntPtr cPtr, IntPtr in_that)
 
delegate bool InputEventDelegate_2 (IntPtr cPtr, IntPtr in_that_event)
 
delegate IntPtr InputEventDelegate_3 (IntPtr cPtr)
 
- Public Member Functions inherited from HPS.Event
virtual bool Drop (HPS.Event in_that_event)
 This optional function is used to determine if the current event can be dropped based on the following event in the queue. More...
 
delegate void DtorDelegate (IntPtr cPtr)
 
 Event (IntPtr in_channel)
 A constructor for generating events from built-in or custom event ID's. More...
 
 Event ()
 A constructor for generating events from built-in or custom event ID's. More...
 
 Event (HPS.Event in_that)
 
delegate IntPtr EventDelegate_0 (IntPtr cPtr)
 
delegate bool EventDelegate_1 (IntPtr cPtr, IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 (IntPtr cPtr)
 
virtual IntPtr Freshen ()
 This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available. More...
 
IntPtr GetChannel ()
 Returns the channel ID assigned to an event. More...
 
IntPtr GetClassID ()
 
double GetTimeStamp ()
 Returns the time an event was injected into the event queue. More...
 
bool IsConsumable ()
 Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More...
 

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 }
 Event Status - returned from a notifier to give the status of the event. More...
 
- 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

HPS.InputEvent.InputEvent ( )
inline

This constructor creates a default InputEvent object.

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

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.

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.
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