Konsole::CharacterColor

Search for usage in LXR

Konsole::CharacterColor Class Reference

#include <CharacterColor.h>

Public Member Functions

constexpr CharacterColor ()
 
constexpr CharacterColor (quint8 colorSpace, int co)
 
constexpr QColor color (std::span< const ColorEntry > palette) const
 
constexpr bool isValid () const
 
void setIntensive ()
 

Detailed Description

Describes the color of a single character in the terminal.

Definition at line 140 of file CharacterColor.h.

Constructor & Destructor Documentation

◆ CharacterColor() [1/2]

Konsole::CharacterColor::CharacterColor ( )
inlineconstexpr

Constructs a new CharacterColor whoose color and color space are undefined.

Definition at line 146 of file CharacterColor.h.

◆ CharacterColor() [2/2]

Konsole::CharacterColor::CharacterColor ( quint8 colorSpace,
int co )
inlineconstexpr

Constructs a new CharacterColor using the specified colorSpace and with color value co.

The meaning of co depends on the colorSpace used.

TODO : Document how co relates to colorSpace

TODO : Add documentation about available color spaces.

Definition at line 164 of file CharacterColor.h.

Member Function Documentation

◆ color()

QColor Konsole::CharacterColor::color ( std::span< const ColorEntry > palette) const
inlineconstexpr

Returns the color within the specified color palette.

The palette is only used if this color is one of the 16 system colors, otherwise it is ignored.

Definition at line 268 of file CharacterColor.h.

◆ isValid()

bool Konsole::CharacterColor::isValid ( ) const
inlineconstexpr

Returns true if this character color entry is valid.

Definition at line 194 of file CharacterColor.h.

◆ setIntensive()

void Konsole::CharacterColor::setIntensive ( )
inline

Set the value of this color from a normal system color to the corresponding intensive system color if it's not already an intensive system color.

This is only applicable if the color is using the COLOR_SPACE_DEFAULT or COLOR_SPACE_SYSTEM color spaces.

Definition at line 288 of file CharacterColor.h.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:04:23 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.