QTextDocument

PyQt5.QtGui.QTextDocument

Inherits from QObject.

Description

The QTextDocument class holds formatted text.

QTextDocument is a container for structured rich text documents, providing support for styled text and various types of document elements, such as lists, tables, frames, and images. They can be created for use in a QTextEdit, or used independently.

Each document element is described by an associated format object. Each format object is treated as a unique object by QTextDocuments, and can be passed to objectForFormat() to obtain the document element that it is applied to.

A QTextDocument can be edited programmatically using a QTextCursor, and its contents can be examined by traversing the document structure. The entire document structure is stored as a hierarchy of document elements beneath the root frame, found with the rootFrame() function. Alternatively, if you just want to iterate over the textual contents of the document you can use begin(), end(), and findBlock() to retrieve text blocks that you can examine and iterate over.

The layout of a document is determined by the documentLayout(); you can create your own QAbstractTextDocumentLayout subclass and set it using setDocumentLayout() if you want to use your own layout logic. The document’s title and other meta-information can be obtained by calling the metaInformation() function. For documents that are exposed to users through the QTextEdit class, the document title is also available via the QTextEdit::documentTitle() function.

The toPlainText() and toHtml() convenience functions allow you to retrieve the contents of the document as plain text and HTML. The document’s text can be searched using the find() functions.

Undo/redo of operations performed on the document can be controlled using the setUndoRedoEnabled() function. The undo/redo system can be controlled by an editor widget through the undo() and redo() slots; the document also provides contentsChanged, undoAvailable, and redoAvailable signals that inform connected editor widgets about the state of the undo/redo system. The following are the undo/redo operations of a QTextDocument:

• Insertion or removal of characters. A sequence of insertions or removals within the same text block are regarded as a single undo/redo operation.

• Insertion or removal of text blocks. Sequences of insertion or removals in a single operation (e.g., by selecting and then deleting text) are regarded as a single undo/redo operation.

• Text character format changes.

• Text block format changes.

• Text block group format changes.

See also

QTextCursor, Rich Text Processing, Text Object Example.

Classes

FindFlags

MarkdownFeatures

Enums

FindFlag

This enum describes the options available to QTextDocument’s find function. The options can be OR-ed together from the following list:

Member	Value	Description
FindBackward	0x00001	Search backwards instead of forwards.
FindCaseSensitively	0x00002	By default find works case insensitive. Specifying this option changes the behaviour to a case sensitive find operation.
FindWholeWords	0x00004	Makes find match only complete words.

---

MarkdownFeature

TODO

Member	Value	Description
MarkdownDialectCommonMark	TODO	TODO
MarkdownDialectGitHub	TODO	TODO
MarkdownNoHTML	TODO	TODO

---

MetaInformation

This enum describes the different types of meta information that can be added to a document.

See also

metaInformation(), setMetaInformation().

Member	Value	Description
DocumentTitle	0	The title of the document.
DocumentUrl	1	The url of the document. The loadResource() function uses this url as the base when loading relative resources.

---

ResourceType

This enum describes the types of resources that can be loaded by QTextDocument’s loadResource() function.

See also

loadResource().

Member	Value	Description
HtmlResource	1	The resource contains HTML.
ImageResource	2	The resource contains image data. Currently supported data types are Pixmap and Image. If the corresponding variant is of type ByteArray then Qt attempts to load the image using loadFromData(). Icon is currently not supported. The icon needs to be converted to one of the supported types first, for example using pixmap().
MarkdownResource	TODO	TODO
StyleSheetResource	3	The resource contains CSS.
UnknownResource	TODO	TODO
UserResource	100	The first available value for user defined resource types.

---

Stacks

Member	Value	Description
RedoStack	0x02	The redo stack.
UndoAndRedoStacks	UndoStack | RedoStack	Both the undo and redo stacks.
UndoStack	0x01	The undo stack.

Methods

__init__(parent: QObject = None)

Constructs an empty QTextDocument with the given parent.

---

__init__(str, parent: QObject = None)

Constructs a QTextDocument containing the plain (unformatted) text specified, and with the given parent.

---

addResource(int, QUrl, Any)

Adds the resource resource to the resource cache, using type and name as identifiers. type should be a value from ResourceType.

For example, you can add an image as a resource in order to reference it from within the document:

#     document->addResource(QTextDocument::ImageResource,
#         QUrl("mydata://image.png"), QVariant(image));

The image can be inserted into the document using the QTextCursor API:

#     QTextImageFormat imageFormat;
#     imageFormat.setName("mydata://image.png");
#     cursor.insertImage(imageFormat);

Alternatively, you can insert images using the HTML img tag:

#     editor->append("<img src=\"mydata://image.png\" />");

---

adjustSize()

Adjusts the document to a reasonable size.

See also

idealWidth(), textWidth(), size().

---

allFormats() → List[QTextFormat]

Returns a vector of text formats for all the formats used in the document.

---

availableRedoSteps() → int

Returns the number of available redo steps.

See also

isRedoAvailable().

---

availableUndoSteps() → int

Returns the number of available undo steps.

See also

isUndoAvailable().

---

baseUrl() → QUrl

TODO

---

begin() → QTextBlock

Returns the document’s first text block.

See also

firstBlock().

---

blockCount() → int

TODO

---

characterAt(int) → str

Returns the character at position pos, or a null character if the position is out of range.

See also

characterCount().

---

characterCount() → int

Returns the number of characters of this document.

See also

blockCount(), characterAt().

---

clear()

Clears the document.

---

clearUndoRedoStacks(stacks: Stacks = UndoAndRedoStacks)

Clears the stacks specified by stacksToClear.

This method clears any commands on the undo stack, the redo stack, or both (the default). If commands are cleared, the appropriate signals are emitted, undoAvailable or redoAvailable.

See also

undoAvailable, redoAvailable.

---

clone(parent: QObject = None) → QTextDocument

Creates a new QTextDocument that is a copy of this text document. parent is the parent of the returned text document.

---

createObject(QTextFormat) → QTextObject

TODO

---

defaultCursorMoveStyle() → CursorMoveStyle

The default cursor movement style is used by all QTextCursor objects created from the document. The default is LogicalMoveStyle.

See also

setDefaultCursorMoveStyle().

---

defaultFont() → QFont

Returns the default font to be used in the document layout.

See also

setDefaultFont().

---

defaultStyleSheet() → str

See also

setDefaultStyleSheet().

---

defaultTextOption() → QTextOption

The default text option is used on all QTextLayout objects in the document. This allows setting global properties for the document such as the default word wrap mode.

See also

setDefaultTextOption().

---

documentLayout() → QAbstractTextDocumentLayout

Returns the document layout for this document.

See also

setDocumentLayout().

---

documentMargin() → float

See also

setDocumentMargin().

---

drawContents(QPainter, rect: QRectF = QRectF())

Draws the content of the document with painter p, clipped to rect. If rect is a null rectangle (default) then the document is painted unclipped.

---

end() → QTextBlock

This function returns a block to test for the end of the document while iterating over it.

#     for (QTextBlock it = doc->begin(); it != doc->end(); it = it.next())
#         cout << it.text().toStdString() << endl;

The block returned is invalid and represents the block after the last block in the document. You can use lastBlock() to retrieve the last valid block of the document.

See also

lastBlock().

---

find(str, position: int = 0, options: FindFlags = 0) → QTextCursor

TODO

---

find(QRegExp, position: int = 0, options: FindFlags = 0) → QTextCursor

This is an overloaded function.

Finds the next occurrence that matches the given regular expression, expr, within the same paragraph in the document.

The search starts at the given from position, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed. The FindCaseSensitively option is ignored for this overload, use caseSensitivity() instead.

Returns a cursor with the match selected if a match was found; otherwise returns a null cursor.

If the from position is 0 (the default) the search begins from the beginning of the document; otherwise it begins at the specified position.

---

find(QRegularExpression, position: int = 0, options: FindFlags = 0) → QTextCursor

TODO

---

find(str, QTextCursor, options: FindFlags = 0) → QTextCursor

Finds the next occurrence of the string, subString, in the document. The search starts at the position of the given cursor, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed.

Returns a cursor with the match selected if subString was found; otherwise returns a null cursor.

If the given cursor has a selection, the search begins after the selection; otherwise it begins at the cursor’s position.

By default the search is case insensitive, and can match text anywhere in the document.

---

find(QRegExp, QTextCursor, options: FindFlags = 0) → QTextCursor

This is an overloaded function.

Finds the next occurrence that matches the given regular expression, expr, within the same paragraph in the document.

The search starts at the position of the given from cursor, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed. The FindCaseSensitively option is ignored for this overload, use caseSensitivity() instead.

Returns a cursor with the match selected if a match was found; otherwise returns a null cursor.

If the given cursor has a selection, the search begins after the selection; otherwise it begins at the cursor’s position.

By default the search is case insensitive, and can match text anywhere in the document.

---

find(QRegularExpression, QTextCursor, options: FindFlags = 0) → QTextCursor

TODO

---

findBlock(int) → QTextBlock

Returns the text block that contains the pos-th character.

---

findBlockByLineNumber(int) → QTextBlock

Returns the text block that contains the specified lineNumber.

See also

firstLineNumber().

---

findBlockByNumber(int) → QTextBlock

Returns the text block with the specified blockNumber.

See also

blockNumber().

---

firstBlock() → QTextBlock

Returns the document’s first text block.

---

idealWidth() → float

Returns the ideal width of the text document. The ideal width is the actually used width of the document without optional alignments taken into account. It is always <= size().`width() <https://doc.qt.io/qt-5/qml-geopath.html#width>`_.

See also

adjustSize(), textWidth().

---

indentWidth() → float

See also

setIndentWidth().

---

isEmpty() → bool

Returns true if the document is empty; otherwise returns false.

---

isModified() → bool

TODO

---

isRedoAvailable() → bool

Returns true if redo is available; otherwise returns false.

See also

isUndoAvailable(), availableRedoSteps().

---

isUndoAvailable() → bool

Returns true if undo is available; otherwise returns false.

See also

isRedoAvailable(), availableUndoSteps().

---

isUndoRedoEnabled() → bool

TODO

---

lastBlock() → QTextBlock

Returns the document’s last (valid) text block.

---

lineCount() → int

Returns the number of lines of this document (if the layout supports this). Otherwise, this is identical to the number of blocks.

See also

blockCount(), characterCount().

---

loadResource(int, QUrl) → Any

Loads data of the specified type from the resource with the given name.

This function is called by the rich text engine to request data that isn’t directly stored by QTextDocument, but still associated with it. For example, images are referenced indirectly by the name attribute of a QTextImageFormat object.

When called by Qt, type is one of the values of ResourceType.

If the QTextDocument is a child object of a QObject that has an invokable method such as QTextEdit, QTextBrowser or a QTextDocument itself then the default implementation tries to retrieve the data from the parent.

---

markContentsDirty(int, int)

TODO

---

maximumBlockCount() → int

See also

setMaximumBlockCount().

---

metaInformation(MetaInformation) → str

Returns meta information about the document of the type specified by info.

See also

setMetaInformation().

---

object(int) → QTextObject

Returns the text object associated with the given objectIndex.

---

objectForFormat(QTextFormat) → QTextObject

Returns the text object associated with the format f.

---

pageCount() → int

returns the number of pages in this document.

---

pageSize() → QSizeF

See also

setPageSize().

---

print(QPagedPaintDevice)

TODO

---

print_(QPagedPaintDevice)

TODO

---

redo()

This is an overloaded function.

Redoes the last editing operation on the document if isRedoAvailable().

---

redo(QTextCursor)

Redoes the last editing operation on the document if isRedoAvailable().

The provided cursor is positioned at the end of the location where the edition operation was redone.

---

resource(int, QUrl) → Any

Returns data of the specified type from the resource with the given name.

This function is called by the rich text engine to request data that isn’t directly stored by QTextDocument, but still associated with it. For example, images are referenced indirectly by the name attribute of a QTextImageFormat object.

Resources are cached internally in the document. If a resource can not be found in the cache, loadResource() is called to try to load the resource. loadResource() should then use addResource() to add the resource to the cache.

See also

ResourceType.

---

revision() → int

Returns the document’s revision (if undo is enabled).

The revision is guaranteed to increase when a document that is not modified is edited.

See also

revision(), isModified().

---

rootFrame() → QTextFrame

Returns the document’s root frame.

---

setBaseUrl(QUrl)

TODO

---

setDefaultCursorMoveStyle(CursorMoveStyle)

Sets the default cursor movement style to the given style.

See also

defaultCursorMoveStyle().

---

setDefaultFont(QFont)

Sets the default font to use in the document layout.

See also

defaultFont().

---

setDefaultStyleSheet(str)

See also

defaultStyleSheet().

---

setDefaultTextOption(QTextOption)

Sets the default text option to option.

See also

defaultTextOption().

---

setDocumentLayout(QAbstractTextDocumentLayout)

Sets the document to use the given layout. The previous layout is deleted.

See also

documentLayoutChanged.

---

setDocumentMargin(float)

See also

documentMargin().

---

setHtml(str)

Replaces the entire contents of the document with the given HTML-formatted text in the html string. The undo/redo history is reset when this function is called.

The HTML formatting is respected as much as possible; for example, “<b>bold</b> text” will produce text where the first word has a font weight that gives it a bold appearance: “bold text”.

Note: It is the responsibility of the caller to make sure that the text is correctly decoded when a QString containing HTML is created and passed to .

See also

setPlainText(), Supported HTML Subset.

---

setIndentWidth(float)

Sets the width used for text list and text block indenting.

The indent properties of QTextListFormat and QTextBlockFormat specify multiples of this value. The default indent width is 40 .

See also

indentWidth().

---

setMarkdown(str, features: Union[MarkdownFeatures, MarkdownFeature] = MarkdownDialectGitHub)

TODO

---

setMaximumBlockCount(int)

See also

maximumBlockCount().

---

setMetaInformation(MetaInformation, str)

Sets the document’s meta information of the type specified by info to the given string.

See also

metaInformation().

---

setModified(on: bool = True)

See also

isModified().

---

setPageSize(QSizeF)

See also

pageSize().

---

setPlainText(str)

Replaces the entire contents of the document with the given plain text. The undo/redo history is reset when this function is called.

See also

setHtml().

---

setTextWidth(float)

See also

textWidth().

---

setUndoRedoEnabled(bool)

See also

isUndoRedoEnabled().

---

setUseDesignMetrics(bool)

See also

useDesignMetrics().

---

size() → QSizeF

TODO

---

textWidth() → float

See also

setTextWidth().

---

toHtml(encoding: Union[QByteArray, bytes, bytearray] = QByteArray()) → str

Returns a string containing an HTML representation of the document.

The encoding parameter specifies the value for the charset attribute in the html header. For example if ‘utf-8’ is specified then the beginning of the generated html will look like this:

# <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head><body>...

If no encoding is specified then no such meta information is generated.

If you later on convert the returned html string into a byte array for transmission over a network or when saving to disk you should specify the encoding you’re going to use for the conversion to a byte array here.

See also

Supported HTML Subset.

---

toMarkdown(features: Union[MarkdownFeatures, MarkdownFeature] = MarkdownDialectGitHub) → str

TODO

---

toPlainText() → str

Returns the plain text contained in the document. If you want formatting information use a QTextCursor instead.

This function returns the same as toRawText(), but will replace some unicode characters with ASCII alternatives. In particular, no-break space (U+00A0) is replaced by a regular space (U+0020), and both paragraph (U+2029) and line (U+2028) separators are replaced by line feed (U+000A). If you need the precise contents of the document, use toRawText() instead.

Note: Embedded objects, such as images, are represented by a Unicode value U+FFFC (OBJECT REPLACEMENT CHARACTER).

See also

toHtml().

---

toRawText() → str

TODO

---

undo()

This is an overloaded function.

---

undo(QTextCursor)

Undoes the last editing operation on the document if undo is available. The provided cursor is positioned at the end of the location where the edition operation was undone.

See the Qt Undo Framework documentation for details.

See also

undoAvailable, isUndoRedoEnabled().

---

useDesignMetrics() → bool

See also

setUseDesignMetrics().

Signals

baseUrlChanged(QUrl)

TODO

---

blockCountChanged(int)

TODO

---

contentsChange(int, int, int)

TODO

---

contentsChanged()

TODO

---

cursorPositionChanged(QTextCursor)

TODO

---

documentLayoutChanged()

TODO

---

modificationChanged(bool)

TODO

---

redoAvailable(bool)

TODO

---

undoAvailable(bool)

TODO

---

undoCommandAdded()

TODO