QwColor Class Reference

A color changing class for the output stream. More...

#include <QwColor.h>

Collaboration diagram for QwColor:

Public Member Functions
	QwColor (const Qw::EQwColor f=Qw::kDefaultForeground, const Qw::EQwColor b=Qw::kDefaultBackground)
	Default constructor.
virtual	~QwColor ()

Static Protected Member Functions
static QwColorMap	CreateColorMap ()

Static Protected Attributes
static QwColorMap	kColorMap = QwColor::CreateColorMap()

Private Attributes
Qw::EQwColor	foreground
	Foreground color.

Friends
std::ostream &	operator<< (std::ostream &out, const QwColor &color)
	Output stream operator.

Detailed Description

A color changing class for the output stream.

This class changes the color in the output stream by inserting 'magic' escape sequences that are interpreted by smart terminals. On dumb terminals this will probably just print garbage. To use the color, a QwColor object should be streamed to the output stream:

QwMessage << "Hello, " << QwColor(Qw::kRed) << "Qweak!" << QwLog::endl;

Definition at line 102 of file QwColor.h.

Constructor & Destructor Documentation

QwColor()

QwColor::QwColor ( const Qw::EQwColor f = Qw::kDefaultForeground, const Qw::EQwColor b = Qw::kDefaultBackground )

inline

Default constructor.

Definition at line 107 of file QwColor.h.

    : foreground(f) { };

References foreground, Qw::kDefaultBackground, and Qw::kDefaultForeground.

Referenced by operator<<.

Here is the caller graph for this function:

~QwColor()

virtual QwColor::~QwColor ( )

inlinevirtual

Definition at line 109 of file QwColor.h.

{ };

Member Function Documentation

CreateColorMap()

static QwColorMap QwColor::CreateColorMap ( )

inlinestaticprotected

Definition at line 116 of file QwColor.h.

                                       {
      QwColorMap map;
      map[Qw::kBlack]   = BLACK;
      map[Qw::kRed]     = RED;
      map[Qw::kGreen]   = GREEN;
      map[Qw::kBrown]   = BROWN;
      map[Qw::kBlue]    = BLUE;
      map[Qw::kMagenta] = MAGENTA;
      map[Qw::kCyan]    = CYAN;
      map[Qw::kWhite]   = WHITE;
      //
      map[Qw::kBold]    = BOLD;
      //
      map[Qw::kBoldRed]     = BOLDRED;
      map[Qw::kBoldGreen]   = BOLDGREEN;
      map[Qw::kBoldBrown]   = BOLDBROWN;
      map[Qw::kBoldBlue]    = BOLDBLUE;
      map[Qw::kBoldMagenta] = BOLDMAGENTA;
      map[Qw::kBoldCyan]    = BOLDCYAN;
      map[Qw::kBoldWhite]   = BOLDWHITE;
      //
      map[Qw::kBackRed]   = BACKRED;
      map[Qw::kBackGreen] = BACKGREEN;
      map[Qw::kBackBlue]  = BACKBLUE;
      //
      map[Qw::kDefaultForeground]   = "\033[39m";
      map[Qw::kDefaultBackground]   = "\033[49m";
      //
      map[Qw::kNormal] = NORMAL;
      return map;
    };

References BACKBLUE, BACKGREEN, BACKRED, BLACK, BLUE, BOLD, BOLDBLUE, BOLDBROWN, BOLDCYAN, BOLDGREEN, BOLDMAGENTA, BOLDRED, BOLDWHITE, BROWN, CYAN, GREEN, Qw::kBackBlue, Qw::kBackGreen, Qw::kBackRed, Qw::kBlack, Qw::kBlue, Qw::kBold, Qw::kBoldBlue, Qw::kBoldBrown, Qw::kBoldCyan, Qw::kBoldGreen, Qw::kBoldMagenta, Qw::kBoldRed, Qw::kBoldWhite, Qw::kBrown, Qw::kCyan, Qw::kDefaultBackground, Qw::kDefaultForeground, Qw::kGreen, Qw::kMagenta, Qw::kNormal, Qw::kRed, Qw::kWhite, MAGENTA, NORMAL, RED, and WHITE.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, const QwColor & color )

friend

Output stream operator.

Definition at line 156 of file QwColor.h.

{
  return out << color.kColorMap[color.foreground];
}

References foreground, kColorMap, and QwColor().

Field Documentation

foreground

Qw::EQwColor QwColor::foreground

private

Foreground color.

Definition at line 151 of file QwColor.h.

Referenced by operator<<, and QwColor().

kColorMap

QwColorMap QwColor::kColorMap = QwColor::CreateColorMap()

staticprotected

Definition at line 147 of file QwColor.h.

Referenced by operator<<.

---

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

• QwColor.h
• QwColor.cc