Event

class HPS.Event : IDisposable

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.

Subclassed by HPS.AnnotationOperator.AnnotationInsertedEvent, HPS.CameraChangedEvent, HPS.CanvasDeletedEvent, HPS.CaptureActivationEvent, HPS.ComponentHiddenEvent, HPS.ComponentHighlightEvent, HPS.ComponentIsolatedEvent, HPS.ComponentResetEvent, HPS.ComponentShownEvent, HPS.ErrorEvent, HPS.Event.EventUnknown, HPS.Exchange.CommonMeasurementOperator.MeasurementDeletedEvent, HPS.Exchange.CommonMeasurementOperator.MeasurementInsertedEvent, HPS.FilterActivationEvent, HPS.FocusLostEvent, HPS.HCA.RequestIdEvent, HPS.HandlesOperator.GeometryTransformedEvent, HPS.HideKeyboardEvent, HPS.HighlightEvent, HPS.ImportStatusEvent, HPS.InformationEvent, HPS.InputEvent, HPS.LayoutDeletedEvent, HPS.LayoutDetachedEvent, HPS.MarkupOperator.MarkupInsertedEvent, HPS.MeasurementOperator.MeasurementEvent, HPS.ModelDeletedEvent, HPS.ModelDetachedEvent, HPS.ShowKeyboardEvent, HPS.SmoothTransitionCompleteEvent, HPS.StandAloneWindowEvent, HPS.Stream.ExportStartedEvent, HPS.Stream.ImportCompletedEvent, HPS.TextInputEvent, HPS.TimerTickEvent, HPS.UpdateCompletedEvent, HPS.ViewDeletedEvent, HPS.ViewDetachedEvent, HPS.WarningEvent

Public Types

enum Status

Event Status - returned from a notifier to give the status of the event.

Values:

InProgress

Event is still in progress.

Completed

Event has completed.

Failed

Event failed.

Public Functions

string ClassName ()

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.

void Dispose ()

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.

delegate void DtorDelegate (IntPtr cPtr)

Event ()

A constructor for generating events from built-in or custom event ID’s.

Event (HPS.Event in_that)

Event (IntPtr in_channel)

A constructor for generating events from built-in or custom event ID’s.

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.

Return:A cookie representing the freshen category. Zero indicates a non-freshening event.

IntPtr GetChannel ()

Returns the channel ID assigned to an event.

IntPtr GetClassID ()

double GetTimeStamp ()

Returns the time an event was injected into the event queue.

bool IsConsumable ()

Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway.