QTextDocumentFragment#

The QTextDocumentFragment class represents a piece of formatted text from a QTextDocument . More

Synopsis#

Functions#

Static functions#

Detailed Description#

A QTextDocumentFragment is a fragment of rich text, that can be inserted into a QTextDocument . A document fragment can be created from a QTextDocument , from a QTextCursor ‘s selection, or from another document fragment. Document fragments can also be created by the static functions, fromPlainText() and fromHtml() .

The contents of a document fragment can be obtained as plain text by using the toPlainText() function, or it can be obtained as HTML with toHtml() .

class PySide6.QtGui.QTextDocumentFragment#

PySide6.QtGui.QTextDocumentFragment(range)

PySide6.QtGui.QTextDocumentFragment(document)

PySide6.QtGui.QTextDocumentFragment(rhs)

Parameters

Constructs an empty QTextDocumentFragment .

See also

isEmpty()

Creates a QTextDocumentFragment from the cursor's selection. If the cursor doesn’t have a selection, the created fragment is empty.

Converts the given document into a QTextDocumentFragment . Note that the QTextDocumentFragment only stores the document contents, not meta information like the document’s title.

Copy constructor. Creates a copy of the other fragment.

static PySide6.QtGui.QTextDocumentFragment.fromHtml(html[, resourceProvider=None])#
Parameters
Return type

PySide6.QtGui.QTextDocumentFragment

Returns a QTextDocumentFragment based on the arbitrary piece of HTML in the given text. The formatting is preserved as much as possible; for example, “<b>bold</b>” will become a document fragment with the text “bold” with a bold character format.

If the provided HTML contains references to external resources such as imported style sheets, then they will be loaded through the resourceProvider.

static PySide6.QtGui.QTextDocumentFragment.fromPlainText(plainText)#
Parameters

plainText – str

Return type

PySide6.QtGui.QTextDocumentFragment

Returns a document fragment that contains the given plainText.

When inserting such a fragment into a QTextDocument the current char format of the QTextCursor used for insertion is used as format for the text.

PySide6.QtGui.QTextDocumentFragment.isEmpty()#
Return type

bool

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

PySide6.QtGui.QTextDocumentFragment.toHtml()#
Return type

str

Returns the contents of the document fragment as HTML.

PySide6.QtGui.QTextDocumentFragment.toPlainText()#
Return type

str

Returns the document fragment’s text as plain text (i.e. with no formatting information).

See also

toHtml()