Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QTextDocumentFragment Class Reference

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

    #include <QTextDocumentFragment>

- List of all members, including inherited members

### Public Functions

- QTextDocumentFragment ()
- QTextDocumentFragment ( QTextDocument * document )
- QTextDocumentFragment ( const QTextCursor & cursor )
- QTextDocumentFragment ( const QTextDocumentFragment & other )
- ~QTextDocumentFragment ()
- bool isEmpty () const
- QString toPlainText () const
- QTextDocumentFragment & operator= ( const QTextDocumentFragment & other )

### Static Public Members

- QTextDocumentFragment fromHTML ( const QString & html )
- QTextDocumentFragment fromHTML ( const QByteArray & html )
- QTextDocumentFragment fromPlainText ( const QString & plainText )

### Related Non-Members

- QDataStream & operator<< ( QDataStream & stream, const QTextDocumentFragment & fragment )
- QDataStream & operator>> ( QDataStream & stream, QTextDocumentFragment & fragment )

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

A document fragment's text can be obtained by calling toPlainText().

## Member Function Documentation

### QTextDocumentFragment::QTextDocumentFragment ()

Constructs an empty QTextDocumentFragment.

See also isEmpty().

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

Converts the given document into a QTextDocumentFragment.

### 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.

### QTextDocumentFragment QTextDocumentFragment::fromHTML ( const QString & html ) `[static]`

Returns a QTextDocumentFragment based on the arbitrary piece of HTML in the string html. 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.

### QTextDocumentFragment QTextDocumentFragment::fromHTML ( const QByteArray & html ) `[static]`

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

The text encoding of the string html is determined from encoding attributes specified in the header.

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

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::toPlainText () const

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

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

Assigns the other fragment to this fragment.

## Related Non-Members

### QDataStream & operator<< ( QDataStream & stream, const QTextDocumentFragment & fragment )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Writes the fragment to the stream and returns a reference to the stream.

### QDataStream & operator>> ( QDataStream & stream, QTextDocumentFragment & fragment )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Reads the fragment from the stream and returns a reference to the stream.