Konsole::TerminalCharacterDecoder

Search for usage in LXR

Konsole::TerminalCharacterDecoder Class Referenceabstract

#include <TerminalCharacterDecoder.h>

Inheritance diagram for Konsole::TerminalCharacterDecoder:

Public Member Functions

virtual void begin (QTextStream *output)=0
 
virtual void decodeLine (std::span< const Character > characters, LineProperty properties)=0
 
virtual void end ()=0
 

Detailed Description

Base class for terminal character decoders.

The decoder converts lines of terminal characters which consist of a unicode character, foreground and background colours and other appearance-related properties into text strings.

Derived classes may produce either plain text with no other colour or appearance information, or they may produce text which incorporates these additional properties.

Definition at line 44 of file TerminalCharacterDecoder.h.

Constructor & Destructor Documentation

◆ ~TerminalCharacterDecoder()

virtual Konsole::TerminalCharacterDecoder::~TerminalCharacterDecoder ( )
inlinevirtual

Definition at line 47 of file TerminalCharacterDecoder.h.

Member Function Documentation

◆ begin()

virtual void Konsole::TerminalCharacterDecoder::begin ( QTextStream * output)
pure virtual

Begin decoding characters.

The resulting text is appended to output.

Implemented in Konsole::PlainTextDecoder.

◆ decodeLine()

virtual void Konsole::TerminalCharacterDecoder::decodeLine ( std::span< const Character > characters,
LineProperty properties )
pure virtual

Converts a line of terminal characters with associated properties into a text string and writes the string into an output QTextStream.

Parameters
charactersAn array of characters of length count.
countThe number of characters
propertiesAdditional properties which affect all characters in the line

Implemented in Konsole::PlainTextDecoder.

◆ end()

virtual void Konsole::TerminalCharacterDecoder::end ( )
pure virtual

End decoding.

Implemented in Konsole::PlainTextDecoder.


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.