Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
HPS.InputEvent Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 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)
 
override HPS.Event Clone ()
 Allocates and returns a copy of this InputEvent. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
virtual bool Equals (HPS.InputEvent in_that)
 Check if the source object is equivalent to this object. More...
 
HPS.ModifierKeys GetModifierKeys ()
 Queries which modifier keys are active More...
 
- Public Member Functions inherited from HPS.Event
IntPtr GetClassID ()
 
 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)
 
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...
 
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...
 
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...
 
delegate IntPtr EventDelegate_0 ()
 
delegate bool EventDelegate_1 (IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 ()
 
delegate void DtorDelegate (IntPtr cPtr)
 

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 ()
 
- Protected Member Functions inherited from HPS.Event
void DtorCallback (IntPtr p)
 
virtual IntPtr GetNonDirectorClassID ()
 

Properties

HPS.ModifierKeys ModifierKeyState [get, set]
 

Additional Inherited Members

- Public Types inherited from HPS.Event
enum  Status { Status.InProgress = 0, Status.Completed = 1, Status.Failed = 2 }
 Event Status - returned from a notifier to give the status of the event. More...
 
- Protected Attributes inherited from HPS.Event
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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 <ref refid="class_h_p_s_1_1_event" kindref="compound">Event</ref>.

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: