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

Konsole

Konsole::ColorEntry

Konsole::ColorEntry Class Reference

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

#include <CharacterColor.h>

List of all members.


Public Types

enum  FontWeight { Bold, Normal, UseCurrentFormat }

Public Member Functions

 ColorEntry ()
 ColorEntry (QColor c, bool tr, FontWeight weight=UseCurrentFormat)
void operator= (const ColorEntry &rhs)

Public Attributes

QColor color
FontWeight fontWeight
bool 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 47 of file CharacterColor.h.


Member Enumeration Documentation

enum Konsole::ColorEntry::FontWeight

Specifies the weight to use when drawing text with this color.

Enumerator:
Bold  Always draw text in this color with a bold weight.

Normal  Always draw text in this color with a normal weight.

UseCurrentFormat  Use the current font weight set by the terminal application.

This is the default behavior.

Definition at line 51 of file CharacterColor.h.


Constructor & Destructor Documentation

Konsole::ColorEntry::ColorEntry ( QColor  c,
bool  tr,
FontWeight  weight = UseCurrentFormat 
) [inline]

Constructs a new color palette entry.

Parameters:
c The color value for this entry.
tr Specifies that the color should be transparent when used as a background color.
b Specifies that text drawn with this color should be bold.

Definition at line 71 of file CharacterColor.h.

Konsole::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 78 of file CharacterColor.h.


Member Function Documentation

void Konsole::ColorEntry::operator= ( const ColorEntry &  rhs  )  [inline]

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

Definition at line 83 of file CharacterColor.h.


Member Data Documentation

QColor Konsole::ColorEntry::color

The color value of this entry for display.

Definition at line 91 of file CharacterColor.h.

FontWeight Konsole::ColorEntry::fontWeight

Specifies the font weight to use when drawing text with this color.

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

Definition at line 102 of file CharacterColor.h.

bool Konsole::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 97 of file CharacterColor.h.


The documentation for this class was generated from the following file:
  • CharacterColor.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.7
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