QtBase  v6.3.1
Public Member Functions | Static Public Member Functions | Friends | List of all members
QTextDocumentFragment Class Reference

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

#include <qtextdocumentfragment.h>

Public Member Functions

 QTextDocumentFragment ()
 
 QTextDocumentFragment (const QTextDocument *document)
 
 QTextDocumentFragment (const QTextCursor &range)
 
 QTextDocumentFragment (const QTextDocumentFragment &rhs)
 
QTextDocumentFragmentoperator= (const QTextDocumentFragment &rhs)
 
 ~QTextDocumentFragment ()
 
bool isEmpty () const
 
QString toPlainText () const
 
QString toHtml () const
 

Static Public Member Functions

static QTextDocumentFragment fromPlainText (const QString &plainText)
 
static QTextDocumentFragment fromHtml (const QString &html, const QTextDocument *resourceProvider=nullptr)
 

Friends

class QTextCursor
 
class QTextDocumentWriter
 

Detailed Description

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

\reentrant

\inmodule QtGui

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

Definition at line 54 of file qtextdocumentfragment.h.

Constructor & Destructor Documentation

◆ QTextDocumentFragment() [1/4]

QTextDocumentFragment::QTextDocumentFragment ( )

Constructs an empty QTextDocumentFragment.

See also
isEmpty()

Definition at line 280 of file qtextdocumentfragment.cpp.

◆ QTextDocumentFragment() [2/4]

QTextDocumentFragment::QTextDocumentFragment ( const QTextDocument document)
explicit

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

Definition at line 290 of file qtextdocumentfragment.cpp.

◆ QTextDocumentFragment() [3/4]

QTextDocumentFragment::QTextDocumentFragment ( const QTextCursor cursor)
explicit

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

See also
isEmpty(), QTextCursor::selection()

Definition at line 307 of file qtextdocumentfragment.cpp.

◆ QTextDocumentFragment() [4/4]

QTextDocumentFragment::QTextDocumentFragment ( const QTextDocumentFragment other)

Copy constructor. Creates a copy of the other fragment.

Definition at line 321 of file qtextdocumentfragment.cpp.

Here is the call graph for this function:

◆ ~QTextDocumentFragment()

QTextDocumentFragment::~QTextDocumentFragment ( )

Destroys the document fragment.

Definition at line 346 of file qtextdocumentfragment.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ fromHtml()

QTextDocumentFragment QTextDocumentFragment::fromHtml ( const QString text,
const QTextDocument resourceProvider = nullptr 
)
static
Since
4.2

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.

Definition at line 1274 of file qtextdocumentfragment.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fromPlainText()

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.

Definition at line 399 of file qtextdocumentfragment.cpp.

Here is the caller graph for this function:

◆ isEmpty()

bool QTextDocumentFragment::isEmpty ( ) const

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

Definition at line 355 of file qtextdocumentfragment.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

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

Assigns the other fragment to this fragment.

Definition at line 333 of file qtextdocumentfragment.cpp.

Here is the call graph for this function:

◆ toHtml()

QString QTextDocumentFragment::toHtml ( ) const
Since
4.2

Returns the contents of the document fragment as HTML.

See also
toPlainText(), QTextDocument::toHtml()

Definition at line 383 of file qtextdocumentfragment.cpp.

Here is the call graph for this function:

◆ toPlainText()

QString QTextDocumentFragment::toPlainText ( ) const

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

See also
toHtml()

Definition at line 366 of file qtextdocumentfragment.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ QTextCursor

friend class QTextCursor
friend

Definition at line 78 of file qtextdocumentfragment.h.

◆ QTextDocumentWriter

friend class QTextDocumentWriter
friend

Definition at line 79 of file qtextdocumentfragment.h.


The documentation for this class was generated from the following files: