QTextDocumentFragment

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

Inheritance diagram of PySide2.QtGui.QTextDocumentFragment

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 PySide2.QtGui.QTextDocumentFragment

PySide2.QtGui.QTextDocumentFragment(range)

PySide2.QtGui.QTextDocumentFragment(document)

PySide2.QtGui.QTextDocumentFragment(rhs)

param range

PySide2.QtGui.QTextCursor

param document

PySide2.QtGui.QTextDocument

param rhs

PySide2.QtGui.QTextDocumentFragment

Constructs an empty QTextDocumentFragment .

See also

isEmpty()

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

static PySide2.QtGui.QTextDocumentFragment.fromHtml(html)
Parameters

html – str

Return type

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

static PySide2.QtGui.QTextDocumentFragment.fromHtml(html, resourceProvider)
Parameters
Return type

PySide2.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 PySide2.QtGui.QTextDocumentFragment.fromPlainText(plainText)
Parameters

plainText – str

Return type

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

PySide2.QtGui.QTextDocumentFragment.isEmpty()
Return type

bool

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

PySide2.QtGui.QTextDocumentFragment.toHtml([encoding=QByteArray()])
Parameters

encodingPySide2.QtCore.QByteArray

Return type

str

Returns the contents of the document fragment as HTML, using the specified encoding (e.g., “UTF-8”, “ISO 8859-1”).

See also

toPlainText() toHtml() QTextCodec

PySide2.QtGui.QTextDocumentFragment.toPlainText()
Return type

str

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

See also

toHtml()