Overview

Sample Code

Programming Guide

API Reference

Support

HPS.Event Class Referenceabstract

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

Inheritance diagram for HPS.Event:
HPS.CameraChangedEvent HPS.CanvasDeletedEvent HPS.CaptureActivationEvent HPS.ComponentHighlightEvent HPS.ErrorEvent HPS.Exchange.CommonMeasurementOperator.MeasurementDeletedEvent HPS.Exchange.CommonMeasurementOperator.MeasurementInsertedEvent HPS.FilterActivationEvent HPS.FocusLostEvent HPS.HideKeyboardEvent HPS.HighlightEvent HPS.ImportStatusEvent HPS.InformationEvent HPS.InputEvent HPS.LayoutDeletedEvent HPS.LayoutDetachedEvent HPS.MarkupOperator.MarkupInsertedEvent HPS.ModelDeletedEvent HPS.ModelDetachedEvent HPS.ShowKeyboardEvent HPS.SmoothTransitionCompleteEvent HPS.StandAloneWindowEvent HPS.TextInputEvent HPS.TimerTickEvent HPS.UpdateCompletedEvent HPS.ViewDeletedEvent HPS.ViewDetachedEvent HPS.WarningEvent

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
 

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

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

Enumerator
InProgress 

Event is still in progress.

Completed 

Event has completed.

Failed 

Event failed.

Constructor & Destructor Documentation

HPS.Event.Event ( IntPtr  in_channel)
inline

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

HPS.Event.Event ( )
inline

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

Member Function Documentation

virtual bool HPS.Event.Drop ( HPS.Event  in_that_event)
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.

virtual IntPtr HPS.Event.Freshen ( )
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.

IntPtr HPS.Event.GetChannel ( )
inline

Returns the channel ID assigned to an event.

double HPS.Event.GetTimeStamp ( )
inline

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

bool HPS.Event.IsConsumable ( )
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: