HPS::ComponentHighlightEvent Class Reference

#include <sprk.h>

Inheritance diagram for HPS::ComponentHighlightEvent:
HPS::Event

Public Types

enum  Action { None = 0, Highlight, Unhighlight }
 
- Public Types inherited from HPS::Event
enum  Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
 

Public Member Functions

EventClone () const override
 
 ComponentHighlightEvent ()
 
ComponentHighlightEvent (Action in_action, HPS::Canvas const &in_canvas, size_t in_layer=0, ComponentPath const &in_path=ComponentPath(), HighlightOptionsKit const &in_options=HighlightOptionsKit())
 
 ComponentHighlightEvent (Event const &in_event)
 
- Public Member Functions inherited from HPS::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
 
HPS::Canvas canvas
 
size_t layer
 
HighlightOptionsKit options
 
ComponentPath path
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Event
static void operator delete (void *in_ptr, size_t in_size) throw ()
 
static void * operator new (size_t in_size)
 
- Protected Attributes inherited from HPS::Event
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

◆ ComponentHighlightEvent() [1/2]

HPS::ComponentHighlightEvent::ComponentHighlightEvent ( )
inline

The default constructor creates an empty ComponentHighlightEvent object.

◆ ComponentHighlightEvent() [2/2]

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

This constructor converts an Event Object to a ComponentHighlightEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

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

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: