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

Synopsis¶
Functions¶
def
isEmpty
()def
toHtml
([encoding=QByteArray()])def
toPlainText
()
Static functions¶
def
fromHtml
(html)def
fromHtml
(html, resourceProvider)def
fromPlainText
(plainText)
Detailed Description¶
A
QTextDocumentFragment
is a fragment of rich text, that can be inserted into aQTextDocument
. A document fragment can be created from aQTextDocument
, from aQTextCursor
‘s selection, or from another document fragment. Document fragments can also be created by the static functions,fromPlainText()
andfromHtml()
.The contents of a document fragment can be obtained as plain text by using the
toPlainText()
function, or it can be obtained as HTML withtoHtml()
.
-
class
QTextDocumentFragment
¶ QTextDocumentFragment(range)
QTextDocumentFragment(document)
QTextDocumentFragment(rhs)
- param range
- param document
- param rhs
Constructs an empty
QTextDocumentFragment
.See also
Creates a
QTextDocumentFragment
from thecursor
‘s selection. If the cursor doesn’t have a selection, the created fragment is empty.See also
Converts the given
document
into aQTextDocumentFragment
. Note that theQTextDocumentFragment
only stores the document contents, not meta information like the document’s title.Copy constructor. Creates a copy of the
other
fragment.
-
static
PySide2.QtGui.QTextDocumentFragment.
fromHtml
(html)¶ - Parameters
html – unicode
- Return type
Returns a
QTextDocumentFragment
based on the arbitrary piece of HTML in the giventext
. 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
html – unicode
resourceProvider –
QTextDocument
- Return type
Returns a
QTextDocumentFragment
based on the arbitrary piece of HTML in the giventext
. 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 – unicode
- Return type
Returns a document fragment that contains the given
plainText
.When inserting such a fragment into a
QTextDocument
the current char format of theQTextCursor
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 returnsfalse
.
-
PySide2.QtGui.QTextDocumentFragment.
toHtml
([encoding=QByteArray()])¶ - Parameters
encoding –
QByteArray
- Return type
unicode
Returns the contents of the document fragment as HTML, using the specified
encoding
(e.g., “UTF-8”, “ISO 8859-1”).See also