
Classes | |
class | EventUnknown |
Public Types | |
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... | |
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 (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 Protected Member Functions | |
static void | DtorCallback (IntPtr p) |
Protected Attributes | |
bool | cMemOwn |
HandleRef | cptr |
Static Protected Attributes | |
static Dictionary< IntPtr, Event > | cachedObjects = new Dictionary<IntPtr, Event>() |
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
Detailed Description
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.
Member Enumeration Documentation
enum HPS.Event.Status : uint |
Constructor & Destructor Documentation
|
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.
Member Function Documentation
|
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.HandlesOperator.GeometryTransformedEvent, HPS.MarkupOperator.MarkupInsertedEvent, HPS.AnnotationOperator.AnnotationInsertedEvent, HPS.MouseEvent, HPS.KeyboardEvent, HPS.TouchEvent, HPS.TextInputEvent, HPS.HighlightEvent, HPS.ComponentHighlightEvent, HPS.ErrorEvent, HPS.InformationEvent, HPS.WarningEvent, HPS.ViewDetachedEvent, HPS.CameraChangedEvent, HPS.StandAloneWindowEvent, HPS.FilterActivationEvent, HPS.ImportStatusEvent, HPS.CaptureActivationEvent, HPS.LayoutDetachedEvent, HPS.ModelDetachedEvent, 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.
- Returns
- A cookie representing the freshen category. Zero indicates a non-freshening event.
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.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Event.cs