Konsole::Character Class Reference

#include <Character.h>

Public Member Functions
	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 _real=true)
bool	equalsFormat (const Character &other) const
ColorEntry::FontWeight	fontWeight (const ColorEntry *base) const
bool	isLineChar () const
bool	isSpace () const

Public Attributes
CharacterColor	backgroundColor
quint16	character
CharacterColor	foregroundColor
bool	isRealCharacter
quint8	rendition

Friends
bool	operator!= (const Character &a, const Character &b)
bool	operator== (const Character &a, const Character &b)

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 77 of file Character.h.

Constructor & Destructor Documentation

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, bool  _real = true  )

inlineexplicit

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.
_real	Indicate whether this character really exists, or exists simply as place holder.

Definition at line 91 of file Character.h.

Member Function Documentation

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 181 of file Character.h.

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 188 of file Character.h.

bool Konsole::Character::isLineChar ( ) const

inline

Definition at line 154 of file Character.h.

bool Konsole::Character::isSpace ( ) const

inline

Definition at line 162 of file Character.h.

Friends And Related Function Documentation

bool operator!= ( const Character &  a, const Character &  b  )

friend

Compares two characters and returns true if they have different unicode character values, renditions or colors.

Definition at line 176 of file Character.h.

bool operator== ( const Character &  a, const Character &  b  )

friend

Compares two characters and returns true if they have the same unicode character value, rendition and colors.

Definition at line 171 of file Character.h.

Member Data Documentation

CharacterColor Konsole::Character::backgroundColor

The color used to draw this character's background.

Definition at line 117 of file Character.h.

quint16 Konsole::Character::character

The unicode character value for this character.

if RE_EXTENDED_CHAR is set, character 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 108 of file Character.h.

CharacterColor Konsole::Character::foregroundColor

The foreground color used to draw this character.

Definition at line 114 of file Character.h.

bool Konsole::Character::isRealCharacter

Indicate whether this character really exists, or exists simply as place holder.

TODO: this boolean filed can be further improved to become a enum filed, which indicates different roles:

RealCharacter: a character which really exists PlaceHolderCharacter: a character which exists as place holder TabStopCharacter: a special place holder for HT("\t")

Definition at line 128 of file Character.h.

quint8 Konsole::Character::rendition

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

Definition at line 111 of file Character.h.

---

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

• Character.h