#include <hps.h>
|
static void | operator delete (void *in_ptr, size_t in_size) throw () |
|
static void * | operator new (size_t in_size) |
|
|
intptr_t | channel |
|
bool | consumable |
|
|
class | HPSI::EventDispatcherImpl |
|
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.
◆ Status
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.
|
◆ Event()
HPS::Event::Event |
( |
intptr_t |
in_channel = 0 | ) |
|
|
inline |
A constructor for generating events from built-in or custom event ID's.
◆ Clone()
virtual Event* HPS::Event::Clone |
( |
| ) |
const |
|
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::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::MarkupOperator::MarkupInsertedEvent, HPS::CameraChangedEvent, HPS::ModelDeletedEvent, HPS::ModelDetachedEvent, HPS::ViewDeletedEvent, HPS::ViewDetachedEvent, HPS::LayoutDeletedEvent, HPS::LayoutDetachedEvent, HPS::CanvasDeletedEvent, and HPS::HCA::RequestIdEvent.
◆ Drop()
virtual bool HPS::Event::Drop |
( |
Event const * |
in_that_event | ) |
const |
|
inlinevirtual |
◆ Freshen()
virtual intptr_t HPS::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 HPS::MouseEvent, HPS::TimerTickEvent, and HPS::CameraChangedEvent.
◆ GetChannel()
intptr_t HPS::Event::GetChannel |
( |
| ) |
const |
|
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()
Time HPS::Event::GetTimeStamp |
( |
| ) |
const |
|
inline |
Returns the time an event was injected into the event queue.
◆ IsConsumable()
bool HPS::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: