GNU Octave  3.8.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
ColorEntry Class Reference

An entry in a terminal display's color palette. More...

#include "CharacterColor.h"

Collaboration diagram for ColorEntry:
Collaboration graph
[legend]

Public Member Functions

 ColorEntry (QColor c, bool tr, bool b)
 Constructs a new color palette entry.
 ColorEntry ()
 Constructs a new color palette entry with an undefined color, and with the transparent and bold flags set to false.
void operator= (const ColorEntry &rhs)
 Sets the color, transparency and boldness of this color to those of rhs.

Public Attributes

bool bold
 If true characters drawn using this color should be bold.
QColor color
 The color value of this entry for display.
bool transparent
 If true character backgrounds using this color should be transparent.

Detailed Description

An entry in a terminal display's color palette.

A color palette is an array of 16 ColorEntry instances which map system color indexes (from 0 to 15) into actual colors.

Each entry can be set as bold, in which case any text drawn using the color should be drawn in bold.

Each entry can also be transparent, in which case the terminal display should avoid drawing the background for any characters using the entry as a background.

Definition at line 44 of file CharacterColor.h.

Constructor & Destructor Documentation

ColorEntry::ColorEntry ( QColor  c,
bool  tr,
bool  b 
)
inline

Constructs a new color palette entry.

Parameters
cThe color value for this entry.
trSpecifies that the color should be transparent when used as a background color.
bSpecifies that text drawn with this color should be bold.

Definition at line 54 of file CharacterColor.h.

ColorEntry::ColorEntry ( )
inline

Constructs a new color palette entry with an undefined color, and with the transparent and bold flags set to false.

Definition at line 60 of file CharacterColor.h.

Member Function Documentation

void ColorEntry::operator= ( const ColorEntry rhs)
inline

Sets the color, transparency and boldness of this color to those of rhs.

Definition at line 65 of file CharacterColor.h.

References bold, color, and transparent.

Member Data Documentation

bool ColorEntry::bold

If true characters drawn using this color should be bold.

This is not applicable when the color is used to draw a character's background.

Definition at line 84 of file CharacterColor.h.

Referenced by Character::isBold(), and operator=().

QColor ColorEntry::color
bool ColorEntry::transparent

If true character backgrounds using this color should be transparent.

This is not applicable when the color is used to render text.

Definition at line 79 of file CharacterColor.h.

Referenced by Character::isTransparent(), and operator=().


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