HPS::ComponentHighlightEvent Class Reference

The ComponentHighlightEvent class is the event that will be triggered for each highlight or unhighlight call. More...

#include <sprk.h>

Inheritance diagram for HPS::ComponentHighlightEvent:

Collaboration diagram for HPS::ComponentHighlightEvent:

Public Types
enum	Action {   Action::None = 0,   Action::Highlight,   Action::Unhighlight }
enum	Status : uint32_t {   Status::InProgress,   Status::Completed,   Status::Failed }
	Event Status - returned from a notifier to give the status of the event. More...

Public Member Functions
	ComponentHighlightEvent ()
	The default constructor creates an empty ComponentHighlightEvent object. More...
	ComponentHighlightEvent (Action in_action, ComponentPath const &in_path=ComponentPath(), HighlightOptionsKit const &in_options=HighlightOptionsKit())
	ComponentHighlightEvent (Event const &in_event)
	This constructor converts an Event Object to a ComponentHighlightEvent object. More...
	~ComponentHighlightEvent ()
Event *	Clone () const
	Allocates and returns a copy of this ComponentHighlightEvent. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
virtual bool	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. More...
virtual intptr_t	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. More...
intptr_t	GetChannel () const
	Returns the channel ID assigned to an event. More...
Time	GetTimeStamp () const
	Returns the time an event was injected into the event queue. More...
bool	IsConsumable () const
	Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More...

Static Public Member Functions
static void *	operator new (size_t in_size)
static void	operator delete (void *in_ptr, size_t in_size) throw ()

Public Attributes
Action	action
ComponentPath	path
HighlightOptionsKit	options

Protected Attributes
intptr_t	channel
bool	consumable

Detailed Description

The ComponentHighlightEvent class is the event that will be triggered for each highlight or unhighlight call.

Member Enumeration Documentation

Action

enum HPS::ComponentHighlightEvent::Action

strong

Enumerator
None
Highlight
Unhighlight

Status

enum HPS::Event::Status : uint32_t

stronginherited

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

ComponentHighlightEvent() [1/3]

HPS::ComponentHighlightEvent::ComponentHighlightEvent ( )

inline

The default constructor creates an empty ComponentHighlightEvent object.

ComponentHighlightEvent() [2/3]

HPS::ComponentHighlightEvent::ComponentHighlightEvent ( Action  in_action, ComponentPath const &  in_path = ComponentPath(), HighlightOptionsKit const &  in_options = HighlightOptionsKit()  )

inline

ComponentHighlightEvent() [3/3]

HPS::ComponentHighlightEvent::ComponentHighlightEvent ( Event const &  in_event )

inline

This constructor converts an Event Object to a ComponentHighlightEvent object.

Parameters

in_event

The Event Object to be converted.

Here is the call graph for this function:

~ComponentHighlightEvent()

HPS::ComponentHighlightEvent::~ComponentHighlightEvent

(

)

Member Function Documentation

Clone()

Event* HPS::ComponentHighlightEvent::Clone ( ) const

inlinevirtual

Allocates and returns a copy of this ComponentHighlightEvent.

Returns

A copy of this ComponentHighlightEvent.

Implements HPS::Event.

Drop()

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

inlinevirtualinherited

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

Freshen()

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

inlinevirtualinherited

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

inlineinherited

Returns the channel ID assigned to an event.

Here is the caller graph for this function:

GetClassID()

intptr_t HPS::Event::GetClassID ( ) const

inherited

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

Here is the caller graph for this function:

GetTimeStamp()

Time HPS::Event::GetTimeStamp ( ) const

inlineinherited

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

IsConsumable()

bool HPS::Event::IsConsumable ( ) const

inlineinherited

Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway.

operator delete()

static void HPS::Event::operator delete ( void *  in_ptr, size_t  in_size  ) throw ( )

inlinestaticinherited

Here is the call graph for this function:

operator new()

static void* HPS::Event::operator new ( size_t  in_size )

inlinestaticinherited

Here is the call graph for this function:

Member Data Documentation

action

Action HPS::ComponentHighlightEvent::action

channel

intptr_t HPS::Event::channel

protectedinherited

consumable

bool HPS::Event::consumable

protectedinherited

options

HighlightOptionsKit HPS::ComponentHighlightEvent::options

path

ComponentPath HPS::ComponentHighlightEvent::path

---

The documentation for this class was generated from the following file:

• sprk.h