HPS::ComponentHighlightEvent Class Reference
#include <sprk.h>
Inheritance diagram for HPS::ComponentHighlightEvent:

Public Types | |
enum | Action { None = 0, Highlight, Unhighlight } |
![]() | |
enum | Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed } |
Public Member Functions | |
Event * | Clone () const |
ComponentHighlightEvent () | |
ComponentHighlightEvent (Action in_action, ComponentPath const &in_path=ComponentPath(), HighlightOptionsKit const &in_options=HighlightOptionsKit()) | |
ComponentHighlightEvent (Event const &in_event) | |
![]() | |
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 |
Public Attributes | |
Action | action |
HighlightOptionsKit | options |
ComponentPath | path |
Additional Inherited Members | |
![]() | |
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 |
Detailed Description
The ComponentHighlightEvent class is the event that will be triggered for each highlight or unhighlight call.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ComponentHighlightEvent object.
|
inline |
This constructor converts an Event Object to a ComponentHighlightEvent object.
Member Function Documentation
|
inlinevirtual |
Allocates and returns a copy of this ComponentHighlightEvent.
- Returns
- A copy of this ComponentHighlightEvent.
Implements HPS::Event.
The documentation for this class was generated from the following file:
- include/sprk.h