REFERENCE MANUAL
#include <hps.h>
Public Types | |
enum | Status { 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 |
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.
|
strong |
|
inline |
A constructor for generating events from built-in or custom event ID's.
|
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 KeyboardEvent, MouseEvent, TouchEvent, InputEvent, ImportStatusEvent, UpdateCompletedEvent, FocusLostEvent, StandAloneWindowEvent, ErrorEvent, WarningEvent, InformationEvent, HighlightEvent, TimerTickEvent, SmoothTransitionCompleteEvent, CaptureActivationEvent, FilterActivationEvent, ComponentHighlightEvent, ModelDeletedEvent, ModelDetachedEvent, ViewDeletedEvent, ViewDetachedEvent, LayoutDeletedEvent, LayoutDetachedEvent, and CanvasDeletedEvent.
|
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.
|
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.
Reimplemented in MouseEvent, and TimerTickEvent.
|
inline |
Returns the channel ID assigned to an event.
Referenced by CanvasDeletedEvent::CanvasDeletedEvent(), CaptureActivationEvent::CaptureActivationEvent(), ComponentHighlightEvent::ComponentHighlightEvent(), ErrorEvent::ErrorEvent(), FilterActivationEvent::FilterActivationEvent(), HighlightEvent::HighlightEvent(), InformationEvent::InformationEvent(), KeyboardEvent::KeyboardEvent(), LayoutDeletedEvent::LayoutDeletedEvent(), LayoutDetachedEvent::LayoutDetachedEvent(), ModelDeletedEvent::ModelDeletedEvent(), ModelDetachedEvent::ModelDetachedEvent(), MouseEvent::MouseEvent(), StandAloneWindowEvent::StandAloneWindowEvent(), TimerTickEvent::TimerTickEvent(), TouchEvent::TouchEvent(), ViewDeletedEvent::ViewDeletedEvent(), ViewDetachedEvent::ViewDetachedEvent(), and WarningEvent::WarningEvent().
intptr_t Event::GetClassID | ( | ) | const |
Returns a unique identifier that can be used to identify which class an object is.
|
inline |
Returns the time an event was injected into the event queue.
|
inline |
Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway.