#include <hps.h>

Inheritance diagram for HPS::Event:
HPS::AnnotationOperator::AnnotationInsertedEvent HPS::CameraChangedEvent HPS::CanvasDeletedEvent HPS::CaptureActivationEvent HPS::ComponentHiddenEvent HPS::ComponentHighlightEvent HPS::ComponentIsolatedEvent HPS::ComponentResetEvent HPS::ComponentShownEvent HPS::ErrorEvent HPS::Exchange::CommonMeasurementOperator::MeasurementDeletedEvent HPS::Exchange::CommonMeasurementOperator::MeasurementInsertedEvent HPS::FilterActivationEvent HPS::FocusLostEvent HPS::HandlesOperator::GeometryTransformedEvent HPS::HCA::RequestIdEvent 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 : uint32_t { 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


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

◆ Status

enum HPS::Event::Status : uint32_t

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


Event is still in progress.


Event has completed.


Event failed.

Constructor & Destructor Documentation

◆ Event()

HPS::Event::Event ( intptr_t  in_channel = 0)

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

Member Function Documentation

◆ Clone()

◆ Drop()

virtual bool HPS::Event::Drop ( Event const *  in_that_event) const

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::Stream::ImportCompletedEvent, HPS::Stream::ExportStartedEvent, HPS::MouseEvent, HPS::TouchEvent, HPS::TimerTickEvent, HPS::SmoothTransitionCompleteEvent, and HPS::CameraChangedEvent.

◆ Freshen()

virtual intptr_t HPS::Event::Freshen ( ) const

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.

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

Reimplemented in HPS::Stream::ImportCompletedEvent, HPS::Stream::ExportStartedEvent, HPS::MouseEvent, HPS::TimerTickEvent, and HPS::CameraChangedEvent.

◆ GetChannel()

intptr_t HPS::Event::GetChannel ( ) const

Returns the channel ID assigned to an event.

◆ GetClassID()

intptr_t HPS::Event::GetClassID ( ) const

Returns a unique identifier that is shared by all objects of the same class.

◆ GetTimeStamp()

Time HPS::Event::GetTimeStamp ( ) const

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

◆ IsConsumable()

bool HPS::Event::IsConsumable ( ) const

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: