PySide6.QtGui.QTextDocumentFragment

class QTextDocumentFragment

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

Synopsis

Methods

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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 raw text by using the toRawText() function, as ASCII with toPlainText() , as HTML with toHtml() , or as Markdown with toMarkdown() .

__init__()

Constructs an empty QTextDocumentFragment .

See also

isEmpty()

__init__(range)
Parameters:

range – QTextCursor

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

__init__(document)
Parameters:

document – 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__(rhs)
Parameters:

rhs – QTextDocumentFragment

Copy constructor. Creates a copy of the other fragment.

static fromHtml(html[, resourceProvider=None])
Parameters:
Return type:

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 fromMarkdown(markdown[, features=QTextDocument.MarkdownDialectGitHub])
Parameters:
Return type:

QTextDocumentFragment

Returns a QTextDocumentFragment based on the given markdown text with the specified features. The default is GitHub dialect.

The formatting is preserved as much as possible; for example, **bold** will become a document fragment containing the text “bold” with a bold character style.

Note

Loading external resources is not supported.

static fromPlainText(plainText)
Parameters:

plainText – str

Return type:

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()
Return type:

bool

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

toHtml()
Return type:

str

Returns the contents of the document fragment as HTML.

toMarkdown([features=QTextDocument.MarkdownDialectGitHub])
Parameters:

features – Combination of MarkdownFeature

Return type:

str

Returns the contents of the document fragment as Markdown, with the specified features. The default is GitHub dialect.

toPlainText()
Return type:

str

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.

toRawText()
Return type:

str

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