#include <hps.h>

Public Types | |
enum | Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed } |
Public Member Functions | |
virtual Event * | Clone () 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
◆ Status
|
strong |
Constructor & Destructor Documentation
◆ Event()
|
inline |
A constructor for generating events from built-in or custom event ID's.
Member Function Documentation
◆ Clone()
|
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::Stream::ImportCompletedEvent, HPS::Stream::ExportStartedEvent, HPS::KeyboardEvent, HPS::MouseEvent, HPS::TouchEvent, HPS::InputEvent, HPS::HideKeyboardEvent, HPS::ShowKeyboardEvent, HPS::ImportStatusEvent, HPS::UpdateCompletedEvent, HPS::TextInputEvent, HPS::FocusLostEvent, HPS::StandAloneWindowEvent, HPS::ErrorEvent, HPS::WarningEvent, HPS::InformationEvent, HPS::HighlightEvent, HPS::TimerTickEvent, HPS::Exchange::CommonMeasurementOperator::MeasurementDeletedEvent, HPS::Exchange::CommonMeasurementOperator::MeasurementInsertedEvent, HPS::SmoothTransitionCompleteEvent, HPS::CaptureActivationEvent, HPS::FilterActivationEvent, HPS::ComponentHighlightEvent, HPS::ComponentIsolatedEvent, HPS::ComponentHiddenEvent, HPS::ComponentShownEvent, HPS::ComponentResetEvent, HPS::MeasurementOperator::MeasurementEvent, HPS::HandlesOperator::GeometryTransformedEvent, HPS::AnnotationOperator::AnnotationInsertedEvent, HPS::CameraChangedEvent, HPS::ModelDeletedEvent, HPS::ModelDetachedEvent, HPS::ViewDeletedEvent, HPS::ViewDetachedEvent, HPS::MarkupOperator::MarkupInsertedEvent, HPS::LayoutDeletedEvent, HPS::LayoutDetachedEvent, HPS::CanvasDeletedEvent, and HPS::HCA::RequestIdEvent.
◆ Drop()
|
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::Stream::ImportCompletedEvent, HPS::Stream::ExportStartedEvent, HPS::MouseEvent, HPS::TouchEvent, HPS::TimerTickEvent, HPS::SmoothTransitionCompleteEvent, and HPS::CameraChangedEvent.
◆ 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::Stream::ImportCompletedEvent, HPS::Stream::ExportStartedEvent, HPS::MouseEvent, HPS::TimerTickEvent, and HPS::CameraChangedEvent.
◆ GetChannel()
|
inline |
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()
|
inline |
Returns the time an event was injected into the event queue.
◆ 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:
- include/hps.h