class HPS::HighlightEvent : public HPS::Event

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

Public Types

enum Action


enumerator None
enumerator Highlight
enumerator Unhighlight

Public Functions

inline virtual Event *Clone() const

Allocates and returns a copy of this HighlightEvent.


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.


in_event – The Event Object to be converted.


Public Members

Action action
HighlightOptionsKit options
SelectionResults results