QTextDocumentFragment Class | Qt GUI 5.6

Qt 5.6 | Qt GUI | C++ Classes | QTextDocumentFragment

Qt 5.6.2 Reference Documentation

# QTextDocumentFragment Class

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

Header: | #include <QTextDocumentFragment>
qmake: | QT += gui

- List of all members, including inherited members

Note: All functions in this class are reentrant.

## Public Functions

| QTextDocumentFragment()
| QTextDocumentFragment(const QTextDocument *document)
| QTextDocumentFragment(const QTextCursor &cursor)
| QTextDocumentFragment(const QTextDocumentFragment &other)
| ~QTextDocumentFragment()
bool | isEmpty() const
QString | toHtml(const QByteArray &encoding = QByteArray()) const
QString | toPlainText() const
QTextDocumentFragment & | operator=(const QTextDocumentFragment &other)

## Static Public Members

QTextDocumentFragment | fromHtml(const QString &text)
QTextDocumentFragment | fromHtml(const QString &text, const QTextDocument *resourceProvider)
QTextDocumentFragment | fromPlainText(const QString &plainText)

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

## Member Function Documentation

### QTextDocumentFragment::QTextDocumentFragment()

Constructs an empty QTextDocumentFragment.

See also isEmpty().

### QTextDocumentFragment::QTextDocumentFragment(const QTextDocument *document)

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

### QTextDocumentFragment::QTextDocumentFragment(const QTextCursor &cursor)

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

See also isEmpty() and QTextCursor::selection().

### QTextDocumentFragment::QTextDocumentFragment(const QTextDocumentFragment &other)

Copy constructor. Creates a copy of the other fragment.

### QTextDocumentFragment::~QTextDocumentFragment()

Destroys the document fragment.

### `[static]` QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &text)

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.

### `[static]` QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &text, const QTextDocument *resourceProvider)

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.

This function was introduced in Qt 4.2.

### `[static]` QTextDocumentFragment QTextDocumentFragment::fromPlainText(const QString &plainText)

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.

### bool QTextDocumentFragment::isEmpty() const

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

### QString QTextDocumentFragment::toHtml(const QByteArray &encoding = QByteArray()) const

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

This function was introduced in Qt 4.2.

See also toPlainText(), QTextDocument::toHtml(), and QTextCodec.

### QString QTextDocumentFragment::toPlainText() const

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

See also toHtml().

### QTextDocumentFragment &QTextDocumentFragment::operator=(const QTextDocumentFragment &other)

Assigns the other fragment to this fragment.