• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Konsole

Konsole::Character

Konsole::Character Class Reference

#include <Character.h>

List of all members.


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 56 of file 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 isBold (const ColorEntry *base) const
bool isTransparent (const ColorEntry *palette) const

Public Attributes

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

Friends

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

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 
) [inline]

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


Member Function Documentation

bool Konsole::Character::isBold ( 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 143 of file Character.h.

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 135 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 127 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 119 of file Character.h.


Member Data Documentation

union { ... }

CharacterColor Konsole::Character::backgroundColor

The color used to draw this character's background.

Definition at line 93 of file Character.h.

quint16 Konsole::Character::character

The unicode character value for this character.

Definition at line 76 of file Character.h.

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

CharacterColor Konsole::Character::foregroundColor

The foreground color used to draw this character.

Definition at line 91 of file Character.h.

quint8 Konsole::Character::rendition

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

Definition at line 88 of file Character.h.


The documentation for this class was generated from the following file:
  • Character.h

Konsole

Skip menu "Konsole"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • Konsole
  • Libraries
  •   libkonq
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal