< Home

< Table of Contents

REFERENCE MANUAL

Event Class Referenceabstract

#include <hps.h>

Inheritance diagram for Event:
CanvasDeletedEvent CaptureActivationEvent ComponentHighlightEvent ErrorEvent FilterActivationEvent FocusLostEvent HighlightEvent ImportStatusEvent InformationEvent InputEvent LayoutDeletedEvent LayoutDetachedEvent ModelDeletedEvent ModelDetachedEvent SmoothTransitionCompleteEvent StandAloneWindowEvent TimerTickEvent UpdateCompletedEvent ViewDeletedEvent ViewDetachedEvent WarningEvent

Public Types

enum  Status { Status::InProgress, Status::Completed, Status::Failed }
 

Public Member Functions

virtual EventClone () const =0
 
virtual bool Drop (Event const *in_that_event) const
 
 Event (intptr_t in_channel=0)
 
virtual intptr_t Freshen () const
 
intptr_t GetChannel () const
 
intptr_t GetClassID () const
 
Time GetTimeStamp () const
 
bool IsConsumable () const
 

Static Public Member Functions

static void operator delete (void *in_ptr, size_t in_size) throw ()
 
static void * operator new (size_t in_size)
 

Protected Attributes

intptr_t channel
 
bool consumable
 

Friends

class HPSI::EventDispatcherImpl
 

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 Event::Status
strong

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

Event::Event ( intptr_t  in_channel = 0)
inline

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

Member Function Documentation

virtual Event* Event::Clone ( ) const
pure virtual
virtual bool Event::Drop ( Event const *  in_that_event) const
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 MouseEvent, TouchEvent, TimerTickEvent, and SmoothTransitionCompleteEvent.

virtual intptr_t Event::Freshen ( ) const
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 MouseEvent, and TimerTickEvent.

intptr_t Event::GetClassID ( ) const

Returns a unique identifier that can be used to identify which class an object is.

Time Event::GetTimeStamp ( ) const
inline

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

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