qx::terminal_color Class Reference

Class for colors manipulating in terminal. More...

#include <terminal_color.h>

Public Member Functions
void	write (FILE *pStream) const
	Write terminal color to the specified stream. More...

Static Public Member Functions
static constexpr terminal_color	font (const color &fontColor) noexcept
	Set font color. More...
static constexpr terminal_color	back (const color &bgColor) noexcept
	Set background color. More...
static constexpr terminal_color	reset () noexcept
	Reset all colors. More...
static void	test_colors ()
	Output colors available in qx::color to test if terminal color work.

Detailed Description

Class for colors manipulating in terminal.

Always check which colors are available in your machine, for ex. with qx::terminal_color::test_colors()

Author

Khrapov

Date

13.12.2022

std::cout << qx::terminal_color::font(qx::color::green()) << "green" << qx::terminal_color::reset() << std::endl;

Definition at line 45 of file terminal_color.h.

Member Function Documentation

back()

constexpr terminal_color qx::terminal_color::back ( const color &  bgColor )

staticconstexprnoexcept

Set background color.

Parameters

bgColor

- new background color

Return values

-	terminal_color instance to pass to the ostream

Definition at line 51 of file terminal_color.inl.

font()

constexpr terminal_color qx::terminal_color::font ( const color &  fontColor )

staticconstexprnoexcept

Set font color.

Parameters

fontColor

- new font color

Return values

-	terminal_color instance to pass to the ostream

Definition at line 46 of file terminal_color.inl.

reset()

constexpr terminal_color qx::terminal_color::reset ( )

staticconstexprnoexcept

Reset all colors.

Return values

-	terminal_color instance to pass to the ostream

Definition at line 56 of file terminal_color.inl.

write()

void qx::terminal_color::write ( FILE *  pStream ) const

inline

Write terminal color to the specified stream.

Parameters

pStream

- stream (std::stdout or std::stderr)

Definition at line 61 of file terminal_color.inl.

---

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

• include/qx/logger/terminal_color.h
• include/qx/logger/terminal_color.inl