cosmos::term::ColorSpec Class Reference

Complete color specification for ANSI terminals. More...

#include <colors.hxx>

Inheritance diagram for cosmos::term::ColorSpec:

Public Member Functions
	ColorSpec (const TermColor color, const ColorKind kind, const ColorIntensity intensity)
TermColor	getColor () const
bool	isBright () const
bool	isNormal () const
bool	isFrontColor () const
bool	isBackColor () const

Protected Attributes
TermColor	m_color
ColorKind	m_kind = ColorKind::FRONT
ColorIntensity	m_intensity = ColorIntensity::NORMAL

Detailed Description

Complete color specification for ANSI terminals.

This type carries a complete color specification:

• basic color value
• FRONT or BACK color
• NORMAL or BRIGHT intensity

It can be used to permanently change the color setting of the terminal and is also used for FeatureBase to build more complex color mechanisms.

Definition at line 81 of file colors.hxx.

Constructor & Destructor Documentation

ColorSpec()

cosmos::term::ColorSpec::ColorSpec ( const TermColor color, const ColorKind kind, const ColorIntensity intensity )

inline

Definition at line 84 of file colors.hxx.

                                                                                               :
                m_color(color), m_kind(kind), m_intensity(intensity) {}

Member Function Documentation

getColor()

TermColor cosmos::term::ColorSpec::getColor ( ) const

inline

Definition at line 87 of file colors.hxx.

{ return m_color; }

isBackColor()

bool cosmos::term::ColorSpec::isBackColor ( ) const

inline

Definition at line 91 of file colors.hxx.

{ return !isFrontColor(); }

isBright()

bool cosmos::term::ColorSpec::isBright ( ) const

inline

Definition at line 88 of file colors.hxx.

{ return m_intensity == ColorIntensity::BRIGHT; }

isFrontColor()

bool cosmos::term::ColorSpec::isFrontColor ( ) const

inline

Definition at line 90 of file colors.hxx.

{ return m_kind == ColorKind::FRONT; }

isNormal()

bool cosmos::term::ColorSpec::isNormal ( ) const

inline

Definition at line 89 of file colors.hxx.

{ return !isBright(); }

Member Data Documentation

m_color

TermColor cosmos::term::ColorSpec::m_color

protected

Definition at line 95 of file colors.hxx.

m_intensity

ColorIntensity cosmos::term::ColorSpec::m_intensity = ColorIntensity::NORMAL

protected

Definition at line 97 of file colors.hxx.

m_kind

ColorKind cosmos::term::ColorSpec::m_kind = ColorKind::FRONT

protected

Definition at line 96 of file colors.hxx.

---

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

• include/io/colors.hxx