QTextDocument¶

The QTextDocument class holds formatted text. More…

Synopsis¶

Functions¶

def addResource (type, name, resource)
def adjustSize ()
def allFormats ()
def availableRedoSteps ()
def availableUndoSteps ()
def baseUrl ()
def baselineOffset ()
def begin ()
def blockCount ()
def characterAt (pos)
def characterCount ()
def clearUndoRedoStacks ([historyToClear=QTextDocument.Stacks.UndoAndRedoStacks])
def clone ([parent=None])
def defaultCursorMoveStyle ()
def defaultFont ()
def defaultStyleSheet ()
def defaultTextOption ()
def documentLayout ()
def documentMargin ()
def drawContents (painter[, rect=QRectF()])
def end ()
def find (expr, cursor[, options=QTextDocument.FindFlags()])
def find (expr[, from=0[, options=QTextDocument.FindFlags()]])
def find (subString, cursor[, options=QTextDocument.FindFlags()])
def find (subString[, from=0[, options=QTextDocument.FindFlags()]])
def findBlock (pos)
def findBlockByLineNumber (blockNumber)
def findBlockByNumber (blockNumber)
def firstBlock ()
def frameAt (pos)
def idealWidth ()
def indentWidth ()
def isEmpty ()
def isModified ()
def isRedoAvailable ()
def isUndoAvailable ()
def isUndoRedoEnabled ()
def lastBlock ()
def lineCount ()
def markContentsDirty (from, length)
def maximumBlockCount ()
def metaInformation (info)
def object (objectIndex)
def objectForFormat (arg__1)
def pageCount ()
def pageSize ()
def print_ (printer)
def redo (cursor)
def resource (type, name)
def revision ()
def rootFrame ()
def setBaseUrl (url)
def setBaselineOffset (baseline)
def setDefaultCursorMoveStyle (style)
def setDefaultFont (font)
def setDefaultStyleSheet (sheet)
def setDefaultTextOption (option)
def setDocumentLayout (layout)
def setDocumentMargin (margin)
def setHtml (html)
def setIndentWidth (width)
def setMarkdown (markdown[, features=QTextDocument.MarkdownFeature.MarkdownDialectGitHub])
def setMaximumBlockCount (maximum)
def setMetaInformation (info, arg__2)
def setPageSize (size)
def setPlainText (text)
def setSubScriptBaseline (baseline)
def setSuperScriptBaseline (baseline)
def setTextWidth (width)
def setUndoRedoEnabled (enable)
def setUseDesignMetrics (b)
def size ()
def subScriptBaseline ()
def superScriptBaseline ()
def textWidth ()
def toHtml ()
def toMarkdown ([features=QTextDocument.MarkdownFeature.MarkdownDialectGitHub])
def toPlainText ()
def toRawText ()
def undo (cursor)
def useDesignMetrics ()

Virtual functions¶

def clear ()
def createObject (f)
def loadResource (type, name)

Slots¶

def redo ()
def setModified ([m=true])
def undo ()

Signals¶

def baseUrlChanged (url)
def blockCountChanged (newBlockCount)
def contentsChange (from, charsRemoved, charsAdded)
def contentsChanged ()
def cursorPositionChanged (cursor)
def documentLayoutChanged ()
def modificationChanged (m)
def redoAvailable (arg__1)
def undoAvailable (arg__1)
def undoCommandAdded ()

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.

See also

QTextCursor QTextEdit Rich Text Processing Text Object Example

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

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

Parameters

text – str
parent – PySide6.QtCore.QObject

Constructs an empty QTextDocument with the given parent.

Constructs a QTextDocument containing the plain (unformatted) text specified, and 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.

See also

metaInformation() setMetaInformation()

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

type – int
name – PySide6.QtCore.QUrl
resource – object

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:

imageFormat = QTextImageFormat()
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.

See also

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

See also

isRedoAvailable()

PySide6.QtGui.QTextDocument.availableUndoSteps()¶

Return type: int

Returns the number of available undo steps.

See also

isUndoAvailable()

PySide6.QtGui.QTextDocument.baseUrl()¶

Return type: PySide6.QtCore.QUrl

This property holds the base URL used to resolve relative resource URLs within the document..

Resource URLs are resolved to be within the same directory as the target of the base URL meaning any portion of the path after the last ‘/’ will be ignored.

Base URL

Relative URL

Resolved URL

file:///path/to/content

images/logo.png

file:///path/to/images/logo.png

file:///path/to/content/

images/logo.png

file:///path/to/content/images/logo.png

file:///path/to/content/index.html

images/logo.png

file:///path/to/content/images/logo.png

file:///path/to/content/images/

../images/logo.png

file:///path/to/content/images/logo.png

PySide6.QtGui.QTextDocument.baseUrlChanged(url)¶

Parameters: url – PySide6.QtCore.QUrl

PySide6.QtGui.QTextDocument.baselineOffset()¶

Return type: float

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

See also

setBaselineOffset() setSubScriptBaseline() subScriptBaseline() setSuperScriptBaseline() superScriptBaseline()

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

This property holds the number of text blocks in the document..

The value of this property is undefined in documents with tables or frames.

By default, if defined, this property contains a value of 1.

See also

lineCount() characterCount()

PySide6.QtGui.QTextDocument.blockCountChanged(newBlockCount)¶

Parameters: newBlockCount – int

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.

See also

blockCount() characterAt()

PySide6.QtGui.QTextDocument.clear()¶

Clears the document.

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

Parameters: historyToClear – Stacks

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

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

Parameters: parent – PySide6.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

PySide6.QtGui.QTextDocument.contentsChanged()¶

PySide6.QtGui.QTextDocument.createObject(f)¶

Parameters: f – PySide6.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: cursor – PySide6.QtGui.QTextCursor

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 .

See also

setDefaultCursorMoveStyle()

PySide6.QtGui.QTextDocument.defaultFont()¶

Return type: PySide6.QtGui.QFont

This property holds the default font used to display the document’s text.

PySide6.QtGui.QTextDocument.defaultStyleSheet()¶

Return type: str

The default style sheet is applied to all newly HTML formatted text that is inserted into the document, for example using setHtml() or insertHtml() .

The style sheet needs to be compliant to CSS 2.1 syntax.

Note

Changing the default style sheet does not have any effect to the existing content of the document.

See also

Supported HTML Subset

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.

See also

setDefaultTextOption()

PySide6.QtGui.QTextDocument.documentLayout()¶

Return type: PySide6.QtGui.QAbstractTextDocumentLayout

Returns the document layout for this document.

See also

setDocumentLayout()

PySide6.QtGui.QTextDocument.documentLayoutChanged()¶

PySide6.QtGui.QTextDocument.documentMargin()¶

Return type: float

The margin around the document. The default is 4.

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

Parameters

painter – PySide6.QtGui.QPainter
rect – PySide6.QtCore.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.

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 it in doc:
    print(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
options – FindFlags

Return type

PySide6.QtGui.QTextCursor

This is an overloaded function.

Finds the next occurrence of the string, subString, in the document. The search starts at the given position, 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 position is 0 (the default) the search begins from the beginning of the document; otherwise it begins at the specified position.

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

Parameters

subString – str
cursor – PySide6.QtGui.QTextCursor
options – FindFlags

Return type

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

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

Parameters

expr – PySide6.QtCore.QRegularExpression
cursor – PySide6.QtGui.QTextCursor
options – FindFlags

Return type

PySide6.QtGui.QTextCursor

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

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

Parameters

expr – PySide6.QtCore.QRegularExpression
from – int
options – FindFlags

Return type

PySide6.QtGui.QTextCursor

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.

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.

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.

See also

firstLineNumber()

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

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

See also

adjustSize() textWidth

PySide6.QtGui.QTextDocument.indentWidth()¶

Return type: float

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

PySide6.QtGui.QTextDocument.isEmpty()¶

Return type: bool

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

PySide6.QtGui.QTextDocument.isModified()¶

Return type: bool

This property holds whether the document has been modified by the user.

By default, this property is false.

See also

modificationChanged()

PySide6.QtGui.QTextDocument.isRedoAvailable()¶

Return type: bool

Returns true if redo is available; otherwise returns false.

See also

isUndoAvailable() availableRedoSteps()

PySide6.QtGui.QTextDocument.isUndoAvailable()¶

Return type: bool

Returns true if undo is available; otherwise returns false.

See also

isRedoAvailable() availableUndoSteps()

PySide6.QtGui.QTextDocument.isUndoRedoEnabled()¶

Return type: bool

This property holds whether undo/redo are enabled for this document.

This defaults to true. If disabled, the undo stack is cleared and no items will be added to it.

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.

See also

blockCount() characterCount()

PySide6.QtGui.QTextDocument.loadResource(type, name)¶

Parameters

type – int
name – PySide6.QtCore.QUrl

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.

See also

QTextDocument::ResourceProvider

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

This property Specifies the limit for blocks in the document..

Specifies the maximum number of blocks the document may have. If there are more blocks in the document that specified with this property blocks are removed from the beginning of the document.

A negative or zero value specifies that the document may contain an unlimited amount of blocks.

The default value is 0.

Note that setting this property will apply the limit immediately to the document contents.

Setting this property also disables the undo redo history.

This property is undefined in documents with tables or frames.

PySide6.QtGui.QTextDocument.metaInformation(info)¶

Parameters: info – MetaInformation
Return type: str

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

See also

setMetaInformation()

PySide6.QtGui.QTextDocument.modificationChanged(m)¶

Parameters: m – bool

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__1 – PySide6.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

This property holds the page size that should be used for laying out the document.

The units are determined by the underlying paint device. The size is measured in logical pixels when painting to the screen, and in points (1/72 inch) when painting to a printer.

By default, for a newly-created, empty document, this property contains an undefined size.

See also

modificationChanged()

PySide6.QtGui.QTextDocument.print_(printer)¶

Parameters: printer – PySide6.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: cursor – PySide6.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

PySide6.QtGui.QTextDocument.resource(type, name)¶

Parameters

type – int
name – PySide6.QtCore.QUrl

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.

If loadResource does not load the resource, then the resourceProvider and lastly the defaultResourceProvider will be called, if set. Note that the result from the provider will not be added automatically to the cache.

See also

ResourceType resourceProvider()

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.

See also

revision() isModified()

PySide6.QtGui.QTextDocument.rootFrame()¶

Return type: PySide6.QtGui.QTextFrame

Returns the document’s root frame.

PySide6.QtGui.QTextDocument.setBaseUrl(url)¶

Parameters: url – PySide6.QtCore.QUrl

This property holds the base URL used to resolve relative resource URLs within the document..

Resource URLs are resolved to be within the same directory as the target of the base URL meaning any portion of the path after the last ‘/’ will be ignored.

Base URL

Relative URL

Resolved URL

file:///path/to/content

images/logo.png

file:///path/to/images/logo.png

file:///path/to/content/

images/logo.png

file:///path/to/content/images/logo.png

file:///path/to/content/index.html

images/logo.png

file:///path/to/content/images/logo.png

file:///path/to/content/images/

../images/logo.png

file:///path/to/content/images/logo.png

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.

See also

baselineOffset() setSubScriptBaseline() subScriptBaseline() setSuperScriptBaseline() superScriptBaseline()

PySide6.QtGui.QTextDocument.setDefaultCursorMoveStyle(style)¶

Parameters: style – CursorMoveStyle

Sets the default cursor movement style to the given style.

See also

defaultCursorMoveStyle()

PySide6.QtGui.QTextDocument.setDefaultFont(font)¶

Parameters: font – PySide6.QtGui.QFont

This property holds the default font used to display the document’s text.

PySide6.QtGui.QTextDocument.setDefaultStyleSheet(sheet)¶

Parameters: sheet – str

The default style sheet is applied to all newly HTML formatted text that is inserted into the document, for example using setHtml() or insertHtml() .

The style sheet needs to be compliant to CSS 2.1 syntax.

Note

Changing the default style sheet does not have any effect to the existing content of the document.

See also

Supported HTML Subset

PySide6.QtGui.QTextDocument.setDefaultTextOption(option)¶

Parameters: option – PySide6.QtGui.QTextOption

Sets the default text option to option.

See also

defaultTextOption()

PySide6.QtGui.QTextDocument.setDocumentLayout(layout)¶

Parameters: layout – PySide6.QtGui.QAbstractTextDocumentLayout

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

See also

documentLayoutChanged()

PySide6.QtGui.QTextDocument.setDocumentMargin(margin)¶

Parameters: margin – float

The margin around the document. The default is 4.

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 .

See also

setPlainText() Supported HTML Subset

PySide6.QtGui.QTextDocument.setIndentWidth(width)¶

Parameters: width – float

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

PySide6.QtGui.QTextDocument.setMarkdown(markdown[, features=QTextDocument.MarkdownFeature.MarkdownDialectGitHub])¶

Parameters

markdown – str
features – MarkdownFeatures

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

This property Specifies the limit for blocks in the document..

Specifies the maximum number of blocks the document may have. If there are more blocks in the document that specified with this property blocks are removed from the beginning of the document.

A negative or zero value specifies that the document may contain an unlimited amount of blocks.

The default value is 0.

Note that setting this property will apply the limit immediately to the document contents.

Setting this property also disables the undo redo history.

This property is undefined in documents with tables or frames.

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

Parameters

info – MetaInformation
arg__2 – str

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

See also

metaInformation()

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

Parameters: m – bool

This property holds whether the document has been modified by the user.

By default, this property is false.

See also

modificationChanged()

PySide6.QtGui.QTextDocument.setPageSize(size)¶

Parameters: size – PySide6.QtCore.QSizeF

This property holds the page size that should be used for laying out the document.

The units are determined by the underlying paint device. The size is measured in logical pixels when painting to the screen, and in points (1/72 inch) when painting to a printer.

By default, for a newly-created, empty document, this property contains an undefined size.

See also

modificationChanged()

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

See also

subScriptBaseline() setSuperScriptBaseline() superScriptBaseline() setBaselineOffset() baselineOffset()

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

See also

superScriptBaseline() setSubScriptBaseline() subScriptBaseline() setBaselineOffset() baselineOffset()

PySide6.QtGui.QTextDocument.setTextWidth(width)¶

Parameters: width – float

The text width specifies the preferred width for text in the document. If the text (or content in general) is wider than the specified with it is broken into multiple lines and grows vertically. If the text cannot be broken into multiple lines to fit into the specified text width it will be larger and the size() and the idealWidth() property will reflect that.

If the text width is set to -1 then the text will not be broken into multiple lines unless it is enforced through an explicit line break or a new paragraph.

The default value is -1.

Setting the text width will also set the page height to -1, causing the document to grow or shrink vertically in a continuous way. If you want the document layout to break the text into multiple pages then you have to set the pageSize property instead.

See also

size() idealWidth() pageSize()

PySide6.QtGui.QTextDocument.setUndoRedoEnabled(enable)¶

Parameters: enable – bool

This property holds whether undo/redo are enabled for this document.

This defaults to true. If disabled, the undo stack is cleared and no items will be added to it.

PySide6.QtGui.QTextDocument.setUseDesignMetrics(b)¶

Parameters: b – bool

This property holds whether the document uses design metrics of fonts to improve the accuracy of text layout.

If this property is set to true, the layout will use design metrics. Otherwise, the metrics of the paint device as set on setPaintDevice() will be used.

Using design metrics makes a layout have a width that is no longer dependent on hinting and pixel-rounding. This means that WYSIWYG text layout becomes possible because the width scales much more linearly based on paintdevice metrics than it would otherwise.

By default, this property is false.

PySide6.QtGui.QTextDocument.size()¶

Return type: PySide6.QtCore.QSizeF

This property holds the actual size of the document. This is equivalent to documentLayout() ->documentSize();.

The size of the document can be changed either by setting a text width or setting an entire page size.

Note that the width is always >= pageSize() . width() .

By default, for a newly-created, empty document, this property contains a configuration-dependent size.

See also

setTextWidth() setPageSize() idealWidth()

PySide6.QtGui.QTextDocument.subScriptBaseline()¶

Return type: float

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

See also

setSubScriptBaseline() setSuperScriptBaseline() superScriptBaseline() setBaselineOffset() baselineOffset()

PySide6.QtGui.QTextDocument.superScriptBaseline()¶

Return type: float

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

See also

setSuperScriptBaseline() setSubScriptBaseline() subScriptBaseline() setBaselineOffset() baselineOffset()

PySide6.QtGui.QTextDocument.textWidth()¶

Return type: float

The text width specifies the preferred width for text in the document. If the text (or content in general) is wider than the specified with it is broken into multiple lines and grows vertically. If the text cannot be broken into multiple lines to fit into the specified text width it will be larger and the size() and the idealWidth() property will reflect that.

If the text width is set to -1 then the text will not be broken into multiple lines unless it is enforced through an explicit line break or a new paragraph.

The default value is -1.

Setting the text width will also set the page height to -1, causing the document to grow or shrink vertically in a continuous way. If you want the document layout to break the text into multiple pages then you have to set the pageSize property instead.

See also

size() idealWidth() pageSize()

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 .

See also

Supported HTML Subset

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

Parameters: features – MarkdownFeatures
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: cursor – PySide6.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.

See also

undoAvailable() isUndoRedoEnabled()

PySide6.QtGui.QTextDocument.undoAvailable(arg__1)¶

Parameters: arg__1 – bool

PySide6.QtGui.QTextDocument.undoCommandAdded()¶

PySide6.QtGui.QTextDocument.useDesignMetrics()¶

Return type: bool

This property holds whether the document uses design metrics of fonts to improve the accuracy of text layout.

If this property is set to true, the layout will use design metrics. Otherwise, the metrics of the paint device as set on setPaintDevice() will be used.

Using design metrics makes a layout have a width that is no longer dependent on hinting and pixel-rounding. This means that WYSIWYG text layout becomes possible because the width scales much more linearly based on paintdevice metrics than it would otherwise.

By default, this property is false.

Table of Contents

Previous topic

Next topic

QTextDocument¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶

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.

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.

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.

Base URL	Relative URL	Resolved URL
file:///path/to/content	images/logo.png	file:///path/to/images/logo.png
file:///path/to/content/	images/logo.png	file:///path/to/content/images/logo.png
file:///path/to/content/index.html	images/logo.png	file:///path/to/content/images/logo.png
file:///path/to/content/images/	../images/logo.png	file:///path/to/content/images/logo.png