File indexing completed on 2024-04-28 05:31:41

 /*
     KSysGuard, the KDE System Guard
 
     SPDX-FileCopyrightText: 2008 John Tapsell <tapsell@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 
 */
 
 #ifndef _KTextEditVT_h_
 #define _KTextEditVT_h_
 
 #include <QTextEdit>
 
 #include "processui_export.h"
 
 /*
  *    \class KTextEditVT
  *   \brief The KTextEditVT class provides a widget that is used to edit and display
  *   both plain and rich text with the additional function of being able to
  *   programmatically append VT100 formatted text.  For example to display the output
  *   from console programs.
  *
  *    This class can be used to display the output of VT100 formatted text with
  *    ANSI escape code - for example output from the command 'ls --color'.
  *
  *    Only a very limited number of ansi escapes sequences will have an affect.  Unrecognised
  *    ansi escape sequences will be ignored and not displayed.  Patches are welcome to support
  *    more of the sequences.
  *
  *    This output can be then be inserted at the current cursor position by calling
  *    insertVTText(string);
  *
  *    For example:
  *
  *    \code
  *      insertVTText(QString("Hi") + QChar(08) + "ello");
  *    \endcode
  *
  *    will insert the text  "Hello" at the current character position.
  *    (Character 08 is the literal backspace character.  Treated as equivalent to character 127)
  */
 class PROCESSUI_EXPORT KTextEditVT : public QTextEdit
 {
     Q_OBJECT
     Q_PROPERTY(bool parseAnsiEscapeCodes READ parseAnsiEscapeCodes WRITE setParseAnsiEscapeCodes)
 
 public:
     explicit KTextEditVT(QWidget *parent);
 
     /** Whether to parse ANSI display code.  If turned off the escape sequence will be shown literally. */
     bool parseAnsiEscapeCodes() const;
 
 public Q_SLOTS:
     /** Set whether to parse ANSI display code.  If turned off the escape sequence will be shown literally. */
     void setParseAnsiEscapeCodes(bool displayall);
     /** Insert the given string at the current position based on the current state.
      *  This is interpreted in a VT100 encoding.  Backspace and delete will delete the previous character,
      *  escape sequences can move the cursor and set the current color etc.
      *
      *  This just calls insertVTChar for each character in the string
      */
     void insertVTText(const QByteArray &string);
     /** Insert the given string at the current position based on the current state.
      *  This is interpreted in a VT100 encoding.  Backspace and delete will delete the previous character,
      *  escape sequences can move the cursor and set the current color etc.
      *
      *  This just calls insertVTChar for each character in the string
      */
     void insertVTText(const QString &string);
 
     /** Insert the given character at the current position based on the current state.
      *  This is interpreted in a VT100 encoding.  Backspace and delete will delete the previous character,
      *  escape sequences can move the cursor and set the current color etc.
      */
     void insertVTChar(const QChar &c);
 
 private:
     bool mParseAnsi;
 
     bool escape_sequence;
     bool escape_CSI;
     bool escape_OSC;
     int escape_number1;
     int escape_number2;
     bool escape_number_separator;
     QChar escape_code;
 };
 
 #endif