Extending Qt Creator Manual | AnsiEscapeCodeHandler

Extending Qt Creator Manual 4.6.2

# AnsiEscapeCodeHandler Class

(Utils::AnsiEscapeCodeHandler)

The AnsiEscapeCodeHandler class parses text and extracts ANSI escape codes from it. More...

Header: | #include <AnsiEscapeCodeHandler>

- List of all members, including inherited members

## Public Functions

| AnsiEscapeCodeHandler()
void | endFormatScope()
QList<FormattedText> | parseText(const FormattedText &input)

## Detailed Description

The AnsiEscapeCodeHandler class parses text and extracts ANSI escape codes from it.

In order to preserve color information across text segments, an instance of this class must be stored for the lifetime of a stream. Also, one instance of this class should not handle multiple streams (at least not at the same time).

Its main function is parseText(), which accepts text and default QTextCharFormat. This function is designed to parse text and split colored text to smaller strings, with their appropriate formatting information set inside QTextCharFormat.

Usage:

- Create new instance of AnsiEscapeCodeHandler for a stream.
- To add new text, call parseText() with the text and a default QTextCharFormat. The result of this function is a list of strings with formats set in appropriate QTextCharFormat.

## Member Function Documentation

### AnsiEscapeCodeHandler::AnsiEscapeCodeHandler()

Default constructs an instance of AnsiEscapeCodeHandler.

### void AnsiEscapeCodeHandler::endFormatScope()

### QList<FormattedText> AnsiEscapeCodeHandler::parseText(const FormattedText &input)