QTextDocument

The QTextDocument class holds formatted text. More

Inheritance diagram of PySide6.QtGui.QTextDocument

Synopsis

Functions

Virtual functions

Detailed Description

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 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.

class PySide6.QtGui.QTextDocument([parent=None])

PySide6.QtGui.QTextDocument(text[, parent=None])

Parameters

Constructs an empty QTextDocument with the given parent.

PySide6.QtGui.QTextDocument.MetaInformation

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

Constant

Description

QTextDocument.DocumentTitle

The title of the document.

QTextDocument.DocumentUrl

The url of the document. The loadResource() function uses this url as the base when loading relative resources.

PySide6.QtGui.QTextDocument.MarkdownFeature

New in version 5.14.

PySide6.QtGui.QTextDocument.FindFlag

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

Constant

Description

QTextDocument.FindBackward

Search backwards instead of forwards.

QTextDocument.FindCaseSensitively

By default find works case insensitive. Specifying this option changes the behaviour to a case sensitive find operation.

QTextDocument.FindWholeWords

Makes find match only complete words.

PySide6.QtGui.QTextDocument.ResourceType

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

Constant

Description

QTextDocument.UnknownResource

No resource is loaded, or the resource type is not known.

QTextDocument.HtmlResource

The resource contains HTML.

QTextDocument.ImageResource

The resource contains image data. Currently supported data types are QPixmap and QImage . If the corresponding variant is of type QByteArray then Qt attempts to load the image using loadFromData . QIcon is currently not supported. The icon needs to be converted to one of the supported types first, for example using pixmap .

QTextDocument.StyleSheetResource

The resource contains CSS.

QTextDocument.MarkdownResource

The resource contains Markdown.

QTextDocument.UserResource

The first available value for user defined resource types.

See also

loadResource() sourceType()

PySide6.QtGui.QTextDocument.Stacks

Constant

Description

QTextDocument.UndoStack

The undo stack.

QTextDocument.RedoStack

The redo stack.

QTextDocument.UndoAndRedoStacks

Both the undo and redo stacks.

New in version 4.7.

PySide6.QtGui.QTextDocument.addResource(type, name, resource)
Parameters

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\" />");
PySide6.QtGui.QTextDocument.adjustSize()

Adjusts the document to a reasonable size.

PySide6.QtGui.QTextDocument.allFormats()
Return type

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

PySide6.QtGui.QTextDocument.availableRedoSteps()
Return type

int

Returns the number of available redo steps.

PySide6.QtGui.QTextDocument.availableUndoSteps()
Return type

int

Returns the number of available undo steps.

PySide6.QtGui.QTextDocument.baseUrl()
Return type

PySide6.QtCore.QUrl

See also

setBaseUrl()

PySide6.QtGui.QTextDocument.baseUrlChanged(url)
Parameters

urlPySide6.QtCore.QUrl

PySide6.QtGui.QTextDocument.baselineOffset()
Return type

float

Returns the the baseline offset in % used in the document layout.

PySide6.QtGui.QTextDocument.begin()
Return type

PySide6.QtGui.QTextBlock

Returns the document’s first text block.

See also

firstBlock()

PySide6.QtGui.QTextDocument.blockCount()
Return type

int

PySide6.QtGui.QTextDocument.blockCountChanged(newBlockCount)
Parameters

newBlockCount – int

This signal is emitted when the total number of text blocks in the document changes. The value passed in newBlockCount is the new total.

PySide6.QtGui.QTextDocument.characterAt(pos)
Parameters

pos – int

Return type

QChar

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

See also

characterCount()

PySide6.QtGui.QTextDocument.characterCount()
Return type

int

Returns the number of characters of this document.

Note

As a QTextDocument always contains at least one ParagraphSeparator , this method will return at least 1.

PySide6.QtGui.QTextDocument.clear()

Clears the document.

PySide6.QtGui.QTextDocument.clearUndoRedoStacks([historyToClear=UndoAndRedoStacks])
Parameters

historyToClearStacks

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() .

PySide6.QtGui.QTextDocument.clone([parent=None])
Parameters

parentPySide6.QtCore.QObject

Return type

PySide6.QtGui.QTextDocument

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

PySide6.QtGui.QTextDocument.contentsChange(from, charsRemoved, charsAdded)
Parameters
  • from – int

  • charsRemoved – int

  • charsAdded – int

This signal is emitted whenever the document’s content changes; for example, when text is inserted or deleted, or when formatting is applied.

Information is provided about the position of the character in the document where the change occurred, the number of characters removed (charsRemoved), and the number of characters added (charsAdded).

The signal is emitted before the document’s layout manager is notified about the change. This hook allows you to implement syntax highlighting for the document.

PySide6.QtGui.QTextDocument.contentsChanged()

This signal is emitted whenever the document’s content changes; for example, when text is inserted or deleted, or when formatting is applied.

See also

contentsChange()

PySide6.QtGui.QTextDocument.createObject(f)
Parameters

fPySide6.QtGui.QTextFormat

Return type

PySide6.QtGui.QTextObject

Creates and returns a new document object (a QTextObject ), based on the given format.

QTextObjects will always get created through this method, so you must reimplement it if you use custom text objects inside your document.

PySide6.QtGui.QTextDocument.cursorPositionChanged(cursor)
Parameters

cursorPySide6.QtGui.QTextCursor

This signal is emitted whenever the position of a cursor changed due to an editing operation. The cursor that changed is passed in cursor. If the document is used with the QTextEdit class and you need a signal when the cursor is moved with the arrow keys you can use the signal in QTextEdit .

PySide6.QtGui.QTextDocument.defaultCursorMoveStyle()
Return type

CursorMoveStyle

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

PySide6.QtGui.QTextDocument.defaultFont()
Return type

PySide6.QtGui.QFont

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

See also

setDefaultFont()

PySide6.QtGui.QTextDocument.defaultStyleSheet()
Return type

str

PySide6.QtGui.QTextDocument.defaultTextOption()
Return type

PySide6.QtGui.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.

PySide6.QtGui.QTextDocument.documentLayout()
Return type

PySide6.QtGui.QAbstractTextDocumentLayout

Returns the document layout for this document.

PySide6.QtGui.QTextDocument.documentLayoutChanged()

This signal is emitted when a new document layout is set.

PySide6.QtGui.QTextDocument.documentMargin()
Return type

float

PySide6.QtGui.QTextDocument.drawContents(painter[, rect=QRectF()])
Parameters

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.

PySide6.QtGui.QTextDocument.end()
Return type

PySide6.QtGui.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())
    std::cout << it.text().toStdString() << "\n";

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()

PySide6.QtGui.QTextDocument.find(subString[, from=0[, options=QTextDocument.FindFlags()]])
Parameters
  • subString – str

  • from – int

  • optionsFindFlags

Return type

PySide6.QtGui.QTextCursor

PySide6.QtGui.QTextDocument.find(subString, cursor[, options=QTextDocument.FindFlags()])
Parameters
Return type

PySide6.QtGui.QTextCursor

PySide6.QtGui.QTextDocument.find(expr, cursor[, options=QTextDocument.FindFlags()])
Parameters
Return type

PySide6.QtGui.QTextCursor

PySide6.QtGui.QTextDocument.find(expr[, from=0[, options=QTextDocument.FindFlags()]])
Parameters
Return type

PySide6.QtGui.QTextCursor

PySide6.QtGui.QTextDocument.findBlock(pos)
Parameters

pos – int

Return type

PySide6.QtGui.QTextBlock

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

PySide6.QtGui.QTextDocument.findBlockByLineNumber(blockNumber)
Parameters

blockNumber – int

Return type

PySide6.QtGui.QTextBlock

Returns the text block that contains the specified lineNumber.

PySide6.QtGui.QTextDocument.findBlockByNumber(blockNumber)
Parameters

blockNumber – int

Return type

PySide6.QtGui.QTextBlock

Returns the text block with the specified blockNumber.

See also

blockNumber()

PySide6.QtGui.QTextDocument.firstBlock()
Return type

PySide6.QtGui.QTextBlock

Returns the document’s first text block.

PySide6.QtGui.QTextDocument.frameAt(pos)
Parameters

pos – int

Return type

PySide6.QtGui.QTextFrame

Returns the frame that contains the text cursor position pos.

PySide6.QtGui.QTextDocument.idealWidth()
Return type

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().

PySide6.QtGui.QTextDocument.indentWidth()
Return type

float

See also

setIndentWidth()

PySide6.QtGui.QTextDocument.isEmpty()
Return type

bool

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

PySide6.QtGui.QTextDocument.isModified()
Return type

bool

PySide6.QtGui.QTextDocument.isRedoAvailable()
Return type

bool

Returns true if redo is available; otherwise returns false.

PySide6.QtGui.QTextDocument.isUndoAvailable()
Return type

bool

Returns true if undo is available; otherwise returns false.

PySide6.QtGui.QTextDocument.isUndoRedoEnabled()
Return type

bool

PySide6.QtGui.QTextDocument.lastBlock()
Return type

PySide6.QtGui.QTextBlock

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

PySide6.QtGui.QTextDocument.lineCount()
Return type

int

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

PySide6.QtGui.QTextDocument.loadResource(type, name)
Parameters
Return type

object

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.

PySide6.QtGui.QTextDocument.markContentsDirty(from, length)
Parameters
  • from – int

  • length – int

Marks the contents specified by the given position and length as “dirty”, informing the document that it needs to be laid out again.

PySide6.QtGui.QTextDocument.maximumBlockCount()
Return type

int

PySide6.QtGui.QTextDocument.metaInformation(info)
Parameters

infoMetaInformation

Return type

str

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

PySide6.QtGui.QTextDocument.modificationChanged(m)
Parameters

m – bool

This signal is emitted whenever the content of the document changes in a way that affects the modification state. If changed is true, the document has been modified; otherwise it is false.

For example, calling setModified (false) on a document and then inserting text causes the signal to get emitted. If you undo that operation, causing the document to return to its original unmodified state, the signal will get emitted again.

PySide6.QtGui.QTextDocument.object(objectIndex)
Parameters

objectIndex – int

Return type

PySide6.QtGui.QTextObject

Returns the text object associated with the given objectIndex.

PySide6.QtGui.QTextDocument.objectForFormat(arg__1)
Parameters

arg__1PySide6.QtGui.QTextFormat

Return type

PySide6.QtGui.QTextObject

Returns the text object associated with the format f.

PySide6.QtGui.QTextDocument.pageCount()
Return type

int

returns the number of pages in this document.

PySide6.QtGui.QTextDocument.pageSize()
Return type

PySide6.QtCore.QSizeF

See also

setPageSize()

PySide6.QtGui.QTextDocument.print_(printer)
Parameters

printerPySide6.QtGui.QPagedPaintDevice

Prints the document to the given printer. The QPagedPaintDevice must be set up before being used with this function.

This is only a convenience method to print the whole document to the printer.

If the document is already paginated through a specified height in the pageSize() property it is printed as-is.

If the document is not paginated, like for example a document used in a QTextEdit , then a temporary copy of the document is created and the copy is broken into multiple pages according to the size of the paint device’s paperRect(). By default a 2 cm margin is set around the document contents. In addition the current page number is printed at the bottom of each page.

See also

print()

PySide6.QtGui.QTextDocument.redo()

This is an overloaded function.

Redoes the last editing operation on the document if redo is available .

PySide6.QtGui.QTextDocument.redo(cursor)
Parameters

cursorPySide6.QtGui.QTextCursor

Redoes the last editing operation on the document if redo is available .

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

PySide6.QtGui.QTextDocument.redoAvailable(arg__1)
Parameters

arg__1 – bool

This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).

PySide6.QtGui.QTextDocument.resource(type, name)
Parameters
Return type

object

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

PySide6.QtGui.QTextDocument.revision()
Return type

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.

PySide6.QtGui.QTextDocument.rootFrame()
Return type

PySide6.QtGui.QTextFrame

Returns the document’s root frame.

PySide6.QtGui.QTextDocument.setBaseUrl(url)
Parameters

urlPySide6.QtCore.QUrl

See also

baseUrl()

PySide6.QtGui.QTextDocument.setBaselineOffset(baseline)
Parameters

baseline – float

Sets the base line as a% of font height to use in the document layout to baseline. The default value is 0. A positive value moves up the text, by the corresponding %; a negative value moves it down.

PySide6.QtGui.QTextDocument.setDefaultCursorMoveStyle(style)
Parameters

styleCursorMoveStyle

Sets the default cursor movement style to the given style.

PySide6.QtGui.QTextDocument.setDefaultFont(font)
Parameters

fontPySide6.QtGui.QFont

Sets the default font to use in the document layout.

See also

defaultFont()

PySide6.QtGui.QTextDocument.setDefaultStyleSheet(sheet)
Parameters

sheet – str

PySide6.QtGui.QTextDocument.setDefaultTextOption(option)
Parameters

optionPySide6.QtGui.QTextOption

Sets the default text option to option.

PySide6.QtGui.QTextDocument.setDocumentLayout(layout)
Parameters

layoutPySide6.QtGui.QAbstractTextDocumentLayout

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

PySide6.QtGui.QTextDocument.setDocumentMargin(margin)
Parameters

margin – float

See also

documentMargin()

PySide6.QtGui.QTextDocument.setHtml(html)
Parameters

html – 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 .

PySide6.QtGui.QTextDocument.setIndentWidth(width)
Parameters

width – 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()

PySide6.QtGui.QTextDocument.setMarkdown(markdown[, features=QTextDocument.MarkdownDialectGitHub])
Parameters
  • markdown – str

  • featuresMarkdownFeatures

Replaces the entire contents of the document with the given Markdown-formatted text in the markdown string, with the given features supported. By default, all supported GitHub-style Markdown features are included; pass MarkdownDialectCommonMark for a more basic parse.

The Markdown formatting is respected as much as possible; for example, “*bold* text” will produce text where the first word has a font weight that gives it an emphasized appearance.

Parsing of HTML included in the markdown string is handled in the same way as in setHtml ; however, Markdown formatting inside HTML blocks is not supported.

Some features of the parser can be enabled or disabled via the features argument:

  • MarkdownNoHTML

  • Any HTML tags in the Markdown text will be discarded

The default is MarkdownDialectGitHub.

The undo/redo history is reset when this function is called.

PySide6.QtGui.QTextDocument.setMaximumBlockCount(maximum)
Parameters

maximum – int

PySide6.QtGui.QTextDocument.setMetaInformation(info, arg__2)
Parameters

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

PySide6.QtGui.QTextDocument.setModified([m=true])
Parameters

m – bool

See also

isModified()

PySide6.QtGui.QTextDocument.setPageSize(size)
Parameters

sizePySide6.QtCore.QSizeF

See also

pageSize()

PySide6.QtGui.QTextDocument.setPlainText(text)
Parameters

text – 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()

PySide6.QtGui.QTextDocument.setSubScriptBaseline(baseline)
Parameters

baseline – float

Sets the default subscript’s base line as a % of font height to use in the document layout to baseline. The default value is 16.67% (1/6 of height).

PySide6.QtGui.QTextDocument.setSuperScriptBaseline(baseline)
Parameters

baseline – float

Sets the default superscript’s base line as a % of font height to use in the document layout to baseline. The default value is 50% (1/2 of height).

PySide6.QtGui.QTextDocument.setTextWidth(width)
Parameters

width – float

See also

textWidth()

PySide6.QtGui.QTextDocument.setUndoRedoEnabled(enable)
Parameters

enable – bool

PySide6.QtGui.QTextDocument.setUseDesignMetrics(b)
Parameters

b – bool

PySide6.QtGui.QTextDocument.size()
Return type

PySide6.QtCore.QSizeF

PySide6.QtGui.QTextDocument.subScriptBaseline()
Return type

float

Returns the superscript’s base line as a % of font height used in the document layout.

PySide6.QtGui.QTextDocument.superScriptBaseline()
Return type

float

Returns the superscript’s base line as a % of font height used in the document layout.

PySide6.QtGui.QTextDocument.textWidth()
Return type

float

See also

setTextWidth()

PySide6.QtGui.QTextDocument.toHtml()
Return type

str

Returns a string containing an HTML representation of the document.

The content of the document specifies its encoding to be UTF-8. 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 use toUtf8() to convert the string to a QByteArray .

PySide6.QtGui.QTextDocument.toMarkdown([features=QTextDocument.MarkdownDialectGitHub])
Parameters

featuresMarkdownFeatures

Return type

str

Returns a string containing a Markdown representation of the document with the given features, or an empty string if writing fails for any reason.

See also

setMarkdown

PySide6.QtGui.QTextDocument.toPlainText()
Return type

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()

PySide6.QtGui.QTextDocument.toRawText()
Return type

str

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

See also

toPlainText()

PySide6.QtGui.QTextDocument.undo()

This is an overloaded function.

PySide6.QtGui.QTextDocument.undo(cursor)
Parameters

cursorPySide6.QtGui.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.

PySide6.QtGui.QTextDocument.undoAvailable(arg__1)
Parameters

arg__1 – bool

This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).

See the Qt Undo Framework documentation for details.

PySide6.QtGui.QTextDocument.undoCommandAdded()

This signal is emitted every time a new level of undo is added to the QTextDocument .

PySide6.QtGui.QTextDocument.useDesignMetrics()
Return type

bool