Contents

• Public Functions
• Static Public Members
• Detailed Description

Detailed Description

TheQTextDocumentFragment class represents a piece of formatted text from aQTextDocument.

AQTextDocumentFragment 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 thetoPlainText() function, or it can be obtained as HTML withtoHtml().

Member Function Documentation

QTextDocumentFragment::QTextDocumentFragment()

Constructs an emptyQTextDocumentFragment.

See alsoisEmpty().

QTextDocumentFragment::QTextDocumentFragment(constQTextDocument * document)

Converts the givendocument into aQTextDocumentFragment. Note that theQTextDocumentFragment only stores the document contents, not meta information like the document's title.

QTextDocumentFragment::QTextDocumentFragment(constQTextCursor & cursor)

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

See alsoisEmpty() andQTextCursor::selection().

QTextDocumentFragment::QTextDocumentFragment(constQTextDocumentFragment & other)

Copy constructor. Creates a copy of theother fragment.

QTextDocumentFragment::~QTextDocumentFragment()

Destroys the document fragment.

[static]QTextDocumentFragment QTextDocumentFragment::fromHtml(constQString & text)

Returns aQTextDocumentFragment 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]QTextDocumentFragment QTextDocumentFragment::fromHtml(constQString & text, constQTextDocument * resourceProvider)

Returns aQTextDocumentFragment 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 theresourceProvider.

This function was introduced in Qt 4.2.

[static]QTextDocumentFragment QTextDocumentFragment::fromPlainText(constQString & plainText)

Returns a document fragment that contains the givenplainText.

When inserting such a fragment into aQTextDocument the current char format of theQTextCursor used for insertion is used as format for the text.

bool QTextDocumentFragment::isEmpty() const

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

QString QTextDocumentFragment::toHtml(constQByteArray & encoding) const

Returns the contents of the document fragment as HTML, using the specifiedencoding (e.g., "UTF-8", "ISO 8859-1").

This function was introduced in Qt 4.2.

See alsotoPlainText(),QTextDocument::toHtml(), andQTextCodec.

QString QTextDocumentFragment::toHtml() const

This is an overloaded function.

QString QTextDocumentFragment::toPlainText() const

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

See alsotoHtml().

QTextDocumentFragment & QTextDocumentFragment::operator=(constQTextDocumentFragment & other)

Assigns theother fragment to this fragment.