Rich Text Processing¶
An overview of Qt’s rich text processing, editing and display features.
The Scribe framework provides a set of classes for reading and manipulating structured rich text documents. Unlike previous rich text support in Qt, the new classes are centered around the QTextDocument class rather than raw textual information. This enables the developer to create and modify structured rich text documents without having to prepare content in an intermediate markup format.
The information within a document can be accessed via two complementary interfaces: A cursor-based interface is used for editing, and a read-only hierarchical interface provides a high level overview of the document structure. The main advantage of the cursor-based interface is that the text can be edited using operations that mimic a user’s interaction with an editor, without losing the underlying structure of the document. The read-only hierarchical interface is most useful when performing operations such as searching and document export.
This document is divided up into chapters for convenient reference:
Rich Text Document Structure outlines the different kinds of elements in a
QTextDocument, and describes how they are arranged in a document structure.The QTextCursor Interface explains how rich text documents can be edited using the cursor-based interface.
Document Layouts briefly explains the role of document layouts.
Common Rich Text Editing Tasks examines some common tasks that involve reading or manipulating rich text documents.
Advanced Rich Text Processing examines advanced rich text editing tasks.
Supported HTML Subset lists the HTML tags supported by
QTextDocument.
Rich Text Processing APIs¶
Qt provides an extensive collection of classes for parsing, rendering manipulating and editing rich text.
The QAbstractTextDocumentLayout class is an abstract base class used to implement custom layouts for QTextDocuments.
The QFont class specifies a query for a font used for drawing text.
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can use the class to query a document’s current formatting or user data.
The QTextCursor class offers an API to access and modify QTextDocuments.
The QTextDocument class holds formatted text.
The QTextDocumentFragment class represents a piece of formatted text from a QTextDocument.
The QTextDocumentWriter class provides a format-independent interface for writing a QTextDocument to files or other devices.
The QTextLength class encapsulates the different types of length used in a QTextDocument.
The QTextFormat class provides formatting information for a QTextDocument.
The QTextCharFormat class provides formatting information for characters in a QTextDocument.
The QTextBlockFormat class provides formatting information for blocks of text in a QTextDocument.
The QTextListFormat class provides formatting information for lists in a QTextDocument.
The QTextFrameFormat class provides formatting information for frames in a QTextDocument.
The QTextTableFormat class provides formatting information for tables in a QTextDocument.
The QTextImageFormat class provides formatting information for images in a QTextDocument.
The QTextTableCellFormat class provides formatting information for table cells in a QTextDocument.
The QTextInlineObject class represents an inline object in a QAbstractTextDocumentLayout and its implementations.
The QTextLayout class is used to lay out and render text.
The QTextLine class represents a line of text inside a QTextLayout.
The QTextList class provides a decorated list of items in a QTextDocument.
The QTextObject class is a base class for different kinds of objects that can group parts of a QTextDocument together.
The QTextBlockGroup class provides a container for text blocks within a QTextDocument.
The QTextFrame class represents a frame in a QTextDocument.
QTextFrame.iteratorThe iterator class provides an iterator for reading the contents of a QTextFrame.
The QTextBlockUserData class is used to associate custom data with blocks of text.
The QTextBlock class provides a container for text fragments in a QTextDocument.
QTextBlock.iteratorThe QTextBlock::iterator class provides an iterator for reading the contents of a QTextBlock.
The QTextFragment class holds a piece of text in a QTextDocument with a single QTextCharFormat.
The QTextOption class provides a description of general rich text properties.
The QTextTableCell class represents the properties of a cell in a QTextTable.
The QTextTable class represents a table in a QTextDocument.