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

Konsole

Konsole::PlainTextDecoder

Konsole::PlainTextDecoder Class Reference

A terminal character decoder which produces plain text, ignoring colours and other appearance-related properties of the original characters. More...

#include <TerminalCharacterDecoder.h>

Inheritance diagram for Konsole::PlainTextDecoder:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual void begin (QTextStream *output)
virtual void decodeLine (const Character *const characters, int count, LineProperty properties)
virtual void end ()
QList< int > linePositions () const
 PlainTextDecoder ()
void setRecordLinePositions (bool record)
void setTrailingWhitespace (bool enable)
bool trailingWhitespace () const

Detailed Description

A terminal character decoder which produces plain text, ignoring colours and other appearance-related properties of the original characters.

Definition at line 70 of file TerminalCharacterDecoder.h.


Constructor & Destructor Documentation

PlainTextDecoder::PlainTextDecoder (  ) 

Definition at line 35 of file TerminalCharacterDecoder.cpp.


Member Function Documentation

void PlainTextDecoder::begin ( QTextStream *  output  )  [virtual]

Begin decoding characters.

The resulting text is appended to output.

Implements Konsole::TerminalCharacterDecoder.

Definition at line 50 of file TerminalCharacterDecoder.cpp.

void PlainTextDecoder::decodeLine ( const Character *const   characters,
int  count,
LineProperty  properties 
) [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

Implements Konsole::TerminalCharacterDecoder.

Definition at line 69 of file TerminalCharacterDecoder.cpp.

void PlainTextDecoder::end (  )  [virtual]

End decoding.

Implements Konsole::TerminalCharacterDecoder.

Definition at line 56 of file TerminalCharacterDecoder.cpp.

QList< int > PlainTextDecoder::linePositions (  )  const

Returns of character positions in the output stream at which new lines where added.

Returns an empty if setTrackLinePositions() is false or if the output device is not a string.

Definition at line 65 of file TerminalCharacterDecoder.cpp.

void PlainTextDecoder::setRecordLinePositions ( bool  record  ) 

Enables recording of character positions at which new lines are added.

See linePositions()

Definition at line 61 of file TerminalCharacterDecoder.cpp.

void PlainTextDecoder::setTrailingWhitespace ( bool  enable  ) 

Set whether trailing whitespace at the end of lines should be included in the output.

Defaults to true.

Definition at line 42 of file TerminalCharacterDecoder.cpp.

bool PlainTextDecoder::trailingWhitespace (  )  const

Returns whether trailing whitespace at the end of lines is included in the output.

Definition at line 46 of file TerminalCharacterDecoder.cpp.


The documentation for this class was generated from the following files:
  • TerminalCharacterDecoder.h
  • TerminalCharacterDecoder.cpp

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