The Event class is the common base class of all events. An event can be an error, input event, or a custom event. Events occur asynchronously and are processed in order from an event queue. More...
Classes | |
class | EventUnknown |
Public Types | |
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... | |
Public Member Functions | |
abstract HPS.Event | Clone () |
This function is used to copy custom events classes. Users that create custom event classes must override this function to provide the proper copying behavior. More... | |
virtual void | Dispose () |
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 () |
delegate bool | EventDelegate_1 (IntPtr in_that_event) |
delegate IntPtr | EventDelegate_2 () |
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... | |
Protected Member Functions | |
virtual void | deleteCptr () |
void | DtorCallback (IntPtr p) |
virtual IntPtr | GetNonDirectorClassID () |
Protected Attributes | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The Event class is the common base class of all events. An event can be an error, input event, or a custom event. Events occur asynchronously and are processed in order from an event queue.
enum HPS.Event.Status |
|
inline |
A constructor for generating events from built-in or custom event ID's.
|
inline |
A constructor for generating events from built-in or custom event ID's.
|
pure virtual |
This function is used to copy custom events classes. Users that create custom event classes must override this function to provide the proper copying behavior.
Implemented in HPS.Exchange.CommonMeasurementOperator.MeasurementDeletedEvent, HPS.Exchange.CommonMeasurementOperator.MeasurementInsertedEvent, HPS.MarkupOperator.MarkupInsertedEvent, HPS.MouseEvent, HPS.KeyboardEvent, HPS.TouchEvent, HPS.TextInputEvent, HPS.HighlightEvent, HPS.ComponentHighlightEvent, HPS.ErrorEvent, HPS.InformationEvent, HPS.WarningEvent, HPS.ViewDetachedEvent, HPS.FilterActivationEvent, HPS.StandAloneWindowEvent, HPS.CameraChangedEvent, HPS.CaptureActivationEvent, HPS.LayoutDetachedEvent, HPS.ModelDetachedEvent, HPS.ImportStatusEvent, HPS.SmoothTransitionCompleteEvent, HPS.UpdateCompletedEvent, HPS.CanvasDeletedEvent, HPS.LayoutDeletedEvent, HPS.ModelDeletedEvent, HPS.ViewDeletedEvent, HPS.InputEvent, HPS.HideKeyboardEvent, HPS.ShowKeyboardEvent, HPS.TimerTickEvent, and HPS.FocusLostEvent.
|
inlinevirtual |
This optional function is used to determine if the current event can be dropped based on the following event in the queue.
Reimplemented in HPS.MouseEvent, HPS.TouchEvent, HPS.SmoothTransitionCompleteEvent, HPS.TimerTickEvent, and HPS.CameraChangedEvent.
|
inlinevirtual |
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.
Reimplemented in HPS.MouseEvent, HPS.TimerTickEvent, and HPS.CameraChangedEvent.
|
inline |
Returns the channel ID assigned to an event.
|
inline |
Returns the time an event was injected into the event queue.
|
inline |
Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway.