QTextDocumentFragment

Synopsis

Functions

• def isEmpty ()
• def toHtml ()
• def toHtml (encoding)
• def toPlainText ()

Static functions

• def fromHtml (html)
• def fromHtml (html, resourceProvider)
• def fromPlainText (plainText)

Detailed Description

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

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

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

class PySide.QtGui.QTextDocumentFragment

class PySide.QtGui.QTextDocumentFragment(range)

class PySide.QtGui.QTextDocumentFragment(document)

class PySide.QtGui.QTextDocumentFragment(rhs)

Parameters:

• range – PySide.QtGui.QTextCursor
• rhs – PySide.QtGui.QTextDocumentFragment
• document – PySide.QtGui.QTextDocument

Constructs an empty PySide.QtGui.QTextDocumentFragment .

See also

PySide.QtGui.QTextDocumentFragment.isEmpty()

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

See also

PySide.QtGui.QTextDocumentFragment.isEmpty() QTextCursor.selection()

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

Copy constructor. Creates a copy of the other fragment.

static PySide.QtGui.QTextDocumentFragment.fromHtml(html)

Parameters:html – unicode Return type:PySide.QtGui.QTextDocumentFragment

Returns a PySide.QtGui.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 PySide.QtGui.QTextDocumentFragment.fromHtml(html, resourceProvider)

Parameters:

• html – unicode
• resourceProvider – PySide.QtGui.QTextDocument

Return type:

PySide.QtGui.QTextDocumentFragment

Returns a PySide.QtGui.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 PySide.QtGui.QTextDocumentFragment.fromPlainText(plainText)

Parameters:plainText – unicode Return type:PySide.QtGui.QTextDocumentFragment

Returns a document fragment that contains the given plainText .

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

PySide.QtGui.QTextDocumentFragment.isEmpty()

Return type:PySide.QtCore.bool

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

PySide.QtGui.QTextDocumentFragment.toHtml(encoding)

Parameters:encoding – PySide.QtCore.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

PySide.QtGui.QTextDocumentFragment.toPlainText() QTextDocument.toHtml() PySide.QtCore.QTextCodec

PySide.QtGui.QTextDocumentFragment.toHtml()

Return type:unicode

This is an overloaded function.

PySide.QtGui.QTextDocumentFragment.toPlainText()

Return type:unicode

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

See also

PySide.QtGui.QTextDocumentFragment.toHtml()