Konsole::Character Class Reference

#include <Character.h>

Public Member Functions
constexpr	Character (quint16 _c=' ', CharacterColor _f=CharacterColor(COLOR_SPACE_DEFAULT, DEFAULT_FORE_COLOR), CharacterColor _b=CharacterColor(COLOR_SPACE_DEFAULT, DEFAULT_BACK_COLOR), quint8 _r=DEFAULT_RENDITION)
bool	equalsFormat (const Character &other) const
ColorEntry::FontWeight	fontWeight (const ColorEntry *base) const
bool	isTransparent (const ColorEntry *palette) const

Public Attributes
union {
QChar   character
quint16   charSequence
};
CharacterColor	backgroundColor
CharacterColor	foregroundColor
quint8	rendition

Detailed Description

A single character in the terminal which consists of a unicode character value, foreground and background colors and a set of rendition attributes which specify how it should be drawn.

Definition at line 62 of file Character.h.

Constructor & Destructor Documentation

Character()

Konsole::Character::Character ( quint16 _c = ' ', CharacterColor _f = CharacterColor(COLOR_SPACE_DEFAULT, DEFAULT_FORE_COLOR), CharacterColor _b = CharacterColor(COLOR_SPACE_DEFAULT, DEFAULT_BACK_COLOR), quint8 _r = DEFAULT_RENDITION )

inlineconstexpr

Constructs a new character.

Parameters

_c	The unicode character value of this character.
_f	The foreground color used to draw the character.
_b	The color used to draw the character's background.
_r	A set of rendition flags which specify how this character is to be drawn.

Definition at line 73 of file Character.h.

Member Function Documentation

equalsFormat()

bool Konsole::Character::equalsFormat ( const Character & other ) const

inline

returns true if the format (color, rendition flag) of the compared characters is equal

Definition at line 150 of file Character.h.

fontWeight()

ColorEntry::FontWeight Konsole::Character::fontWeight ( const ColorEntry * base ) const

inline

Returns true if this character should always be drawn in bold when it is drawn with the specified palette, independent of whether or not the character has the RE_BOLD rendition flag.

Definition at line 155 of file Character.h.

isTransparent()

bool Konsole::Character::isTransparent ( const ColorEntry * palette ) const

inline

Returns true if this character has a transparent background when it is drawn with the specified palette.

Definition at line 144 of file Character.h.

Member Data Documentation

backgroundColor

CharacterColor Konsole::Character::backgroundColor

The color used to draw this character's background.

Definition at line 103 of file Character.h.

character

QChar Konsole::Character::character

The unicode character value for this character.

Definition at line 86 of file Character.h.

charSequence

quint16 Konsole::Character::charSequence

Experimental addition which allows a single Character instance to contain more than one unicode character.

charSequence is a hash code which can be used to look up the unicode character sequence in the ExtendedCharTable used to create the sequence.

Definition at line 94 of file Character.h.

foregroundColor

CharacterColor Konsole::Character::foregroundColor

The foreground color used to draw this character.

Definition at line 101 of file Character.h.

rendition

quint8 Konsole::Character::rendition

A combination of RENDITION flags which specify options for drawing the character.

Definition at line 98 of file Character.h.

---

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

• Character.h