TerminalCharacterDecoder Class Reference

Base class for terminal character decoders. More...

#include "TerminalCharacterDecoder.h"

Inheritance diagram for TerminalCharacterDecoder:

Public Member Functions
virtual	~TerminalCharacterDecoder ()
virtual void	begin (QTextStream *output)=0
	Begin decoding characters. More...
virtual void	decodeLine (const Character *const characters, int count, LineProperty properties)=0
	Converts a line of terminal characters with associated properties into a text string and writes the string into an output QTextStream. More...
virtual void	end ()=0
	End decoding. More...

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 40 of file TerminalCharacterDecoder.h.

Constructor & Destructor Documentation

~TerminalCharacterDecoder()

virtual TerminalCharacterDecoder::~TerminalCharacterDecoder ( )

inlinevirtual

Definition at line 43 of file TerminalCharacterDecoder.h.

Member Function Documentation

begin()

virtual void TerminalCharacterDecoder::begin ( QTextStream *  output )

pure virtual

Begin decoding characters.

The resulting text is appended to output.

Implemented in HTMLDecoder, and PlainTextDecoder.

decodeLine()

virtual void TerminalCharacterDecoder::decodeLine ( const Character *const  characters, int  count, 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

characters	An array of characters of length count.
properties	Additional properties which affect all characters in the line
output	The output stream which receives the decoded text

Implemented in HTMLDecoder, and PlainTextDecoder.

Referenced by Screen::copyLineToStream().

end()

virtual void TerminalCharacterDecoder::end ( )

pure virtual

End decoding.

Implemented in HTMLDecoder, and PlainTextDecoder.

---

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

• libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.h