HighlightEvent

class HighlightEvent : public HPS::Event

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

Public Types

enum class Action : uint32_t

Values:

enumerator None

enumerator Highlight

enumerator Unhighlight

Public Functions

inline virtual char const *ClassName() const override

inline virtual Event *Clone() const override

Allocates and returns a copy of this HighlightEvent.

Returns:A copy of this HighlightEvent.

inline HighlightEvent()

The default constructor creates an empty HighlightEvent object.

inline HighlightEvent(Action in_action, SelectionResults const &in_results = SelectionResults(), HighlightOptionsKit const &in_options = HighlightOptionsKit())

inline HighlightEvent(Event const &in_event)

This constructor converts an Event Object to a HighlightEvent object.

Parameters:in_event – The Event Object to be converted.

~HighlightEvent()

Public Members

Action action

HighlightOptionsKit options

SelectionResults results