QTextDocumentFragment¶

PyQt5.QtGui.QTextDocumentFragment

Description¶

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

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

Methods¶

__init__(): Constructs an empty QTextDocumentFragment.

See also

isEmpty().

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

__init__(QTextCursor): Creates a QTextDocumentFragment from the cursor’s selection. If the cursor doesn’t have a selection, the created fragment is empty.

See also

isEmpty(), selection().

__init__(QTextDocumentFragment): TODO

@staticmethod fromHtml(str) → QTextDocumentFragment: TODO

@staticmethod fromHtml(str, QTextDocument) → QTextDocumentFragment: TODO

@staticmethod fromPlainText(str) → 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.

isEmpty() → bool: Returns true if the fragment is empty; otherwise returns false.

toHtml(encoding: Union[QByteArray, bytes, bytearray] = QByteArray()) → 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.

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

See also

toHtml().