chatterino::HighlightResult Struct Reference

#include <HighlightController.hpp>

Public Member Functions
	HighlightResult (bool _alert, bool _playSound, boost::optional< QUrl > _customSoundUrl, std::shared_ptr< QColor > _color, bool _showInMentions)
bool	operator== (const HighlightResult &other) const
bool	operator!= (const HighlightResult &other) const
bool	empty () const
	Returns true if no side-effect has been enabled. More...
bool	full () const
	Returns true if all side-effects have been enabled. More...

Static Public Member Functions
static HighlightResult	emptyResult ()
	Construct an empty HighlightResult with all side-effects disabled. More...

Public Attributes
bool	alert {false}
	true if highlight should trigger the taskbar to flash More...
bool	playSound {false}
	true if highlight should play a notification sound More...
boost::optional< QUrl >	customSoundUrl {}
	Can be set to a different sound that should play when this highlight is activated. More...
std::shared_ptr< QColor >	color {}
	set if highlight should set a background color More...
bool	showInMentions {false}
	true if highlight should show message in the /mentions split More...

Friends
std::ostream &	operator<< (std::ostream &os, const HighlightResult &result)

Constructor & Destructor Documentation

HighlightResult()

chatterino::HighlightResult::HighlightResult ( bool  _alert, bool  _playSound, boost::optional< QUrl >  _customSoundUrl, std::shared_ptr< QColor >  _color, bool  _showInMentions  )

inline

Member Function Documentation

empty()

bool chatterino::HighlightResult::empty ( ) const

inline

Returns true if no side-effect has been enabled.

emptyResult()

static HighlightResult chatterino::HighlightResult::emptyResult ( )

inlinestatic

Construct an empty HighlightResult with all side-effects disabled.

Here is the caller graph for this function:

full()

bool chatterino::HighlightResult::full ( ) const

inline

Returns true if all side-effects have been enabled.

operator!=()

bool chatterino::HighlightResult::operator!= ( const HighlightResult &  other ) const

inline

operator==()

bool chatterino::HighlightResult::operator== ( const HighlightResult &  other ) const

inline

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const HighlightResult &  result  )

friend

Member Data Documentation

alert

bool chatterino::HighlightResult::alert {false}

true if highlight should trigger the taskbar to flash

color

std::shared_ptr<QColor> chatterino::HighlightResult::color {}

set if highlight should set a background color

customSoundUrl

boost::optional<QUrl> chatterino::HighlightResult::customSoundUrl {}

Can be set to a different sound that should play when this highlight is activated.

May only be set if playSound is true

playSound

bool chatterino::HighlightResult::playSound {false}

true if highlight should play a notification sound

showInMentions

bool chatterino::HighlightResult::showInMentions {false}

true if highlight should show message in the /mentions split

---

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

• /var/chatterino-doxygen/chatterino2/src/controllers/highlights/HighlightController.hpp