 |
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
|
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
\reentrant More...
#include <qtextdocumentfragment.h>
Collaboration diagram for QTextDocumentFragment:Public Member Functions | |
| QTextDocumentFragment () | |
| Constructs an empty QTextDocumentFragment. | |
| QTextDocumentFragment (const QTextDocument *document) | |
| Converts the given document into a QTextDocumentFragment. | |
| QTextDocumentFragment (const QTextCursor &range) | |
| Creates a QTextDocumentFragment from the {cursor}'s selection. | |
| QTextDocumentFragment (const QTextDocumentFragment &rhs) | |
| Copy constructor. | |
| QTextDocumentFragment & | operator= (const QTextDocumentFragment &rhs) |
| Assigns the other fragment to this fragment. | |
| ~QTextDocumentFragment () | |
| Destroys the document fragment. | |
| bool | isEmpty () const |
Returns true if the fragment is empty; otherwise returns false. | |
| QString | toPlainText () const |
| This function returns the same as toRawText(), but will replace some unicode characters with ASCII alternatives. | |
| QString | toRawText () const |
| Returns the document fragment's text as raw text (i.e. | |
| QString | toHtml () const |
Static Public Member Functions | |
| static QTextDocumentFragment | fromPlainText (const QString &plainText) |
| Returns a document fragment that contains the given plainText. | |
| static QTextDocumentFragment | fromHtml (const QString &html, const QTextDocument *resourceProvider=nullptr) |
Friends | |
| class | QTextCursor |
| class | QTextDocumentWriter |
\reentrant
\inmodule QtGui
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 raw text by using the toRawText() function, as ASCII with toPlainText(), as HTML with toHtml(), or as Markdown with toMarkdown().
Definition at line 18 of file qtextdocumentfragment.h.
| QTextDocumentFragment::QTextDocumentFragment | ( | ) |
Constructs an empty QTextDocumentFragment.
Definition at line 251 of file qtextdocumentfragment.cpp.
|
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 261 of file qtextdocumentfragment.cpp.
References cursor, QTextCursor::End, and QTextCursor::KeepAnchor.
|
explicit |
Creates a QTextDocumentFragment from the {cursor}'s selection.
If the cursor doesn't have a selection, the created fragment is empty.
Definition at line 278 of file qtextdocumentfragment.cpp.
References cursor.
| QTextDocumentFragment::QTextDocumentFragment | ( | const QTextDocumentFragment & | other | ) |
Copy constructor.
Creates a copy of the other fragment.
Definition at line 292 of file qtextdocumentfragment.cpp.
References QBasicAtomicInteger< T >::ref(), and QTextDocumentFragmentPrivate::ref.
Here is the call graph for this function:| QTextDocumentFragment::~QTextDocumentFragment | ( | ) |
Destroys the document fragment.
Definition at line 317 of file qtextdocumentfragment.cpp.
References QBasicAtomicInteger< T >::deref(), and QTextDocumentFragmentPrivate::ref.
Here is the call graph for this function:
|
static |
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 1284 of file qtextdocumentfragment.cpp.
References QTextHtmlImporter::import(), and QTextHtmlImporter::ImportToFragment.
Referenced by QWidgetTextControl::insertFromMimeData(), QQuickTextControl::insertFromMimeData(), and QTextCursor::insertHtml().
Here is the call graph for this function: Here is the caller graph for this function:
|
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 410 of file qtextdocumentfragment.cpp.
References cursor, QTextDocumentFragmentPrivate::importedFromPlainText, and plainText.
Referenced by QWidgetTextControl::insertFromMimeData(), and QQuickTextControl::insertFromMimeData().
Here is the caller graph for this function:| bool QTextDocumentFragment::isEmpty | ( | ) | const |
Returns true if the fragment is empty; otherwise returns false.
Definition at line 326 of file qtextdocumentfragment.cpp.
References QTextDocumentFragmentPrivate::doc, and QTextDocumentPrivate::get().
Referenced by QTextEditMimeData::formats(), QQuickTextEditMimeData::formats(), QTextCursor::insertFragment(), QTextEditMimeData::retrieveData(), QQuickTextEditMimeData::retrieveData(), and MainWindow::updateMenus().
Here is the call graph for this function: Here is the caller graph for this function:| QTextDocumentFragment & QTextDocumentFragment::operator= | ( | const QTextDocumentFragment & | rhs | ) |
Assigns the other fragment to this fragment.
Definition at line 304 of file qtextdocumentfragment.cpp.
References QBasicAtomicInteger< T >::deref(), QBasicAtomicInteger< T >::ref(), and QTextDocumentFragmentPrivate::ref.
Here is the call graph for this function:| QString QTextDocumentFragment::toHtml | ( | ) | const |
Returns the contents of the document fragment as HTML.
Definition at line 374 of file qtextdocumentfragment.cpp.
References QTextDocumentFragmentPrivate::doc, QTextHtmlExporter::ExportFragment, and QTextHtmlExporter::toHtml().
Here is the call graph for this function:| QString QTextDocumentFragment::toPlainText | ( | ) | const |
This function returns the same as toRawText(), but will replace some unicode characters with ASCII alternatives.
In particular, no-break space (U+00A0) is replaced by a regular space (U+0020), and both paragraph (U+2029) and line (U+2028) separators are replaced by line feed (U+000A). If you need the precise contents of the document, use toRawText() instead.
Definition at line 342 of file qtextdocumentfragment.cpp.
References QTextDocumentFragmentPrivate::doc, and QTextDocument::toPlainText().
Here is the call graph for this function:| QString QTextDocumentFragment::toRawText | ( | ) | const |
Returns the document fragment's text as raw text (i.e.
with no formatting information).
Definition at line 357 of file qtextdocumentfragment.cpp.
References QTextDocumentFragmentPrivate::doc, and QTextDocument::toRawText().
Here is the call graph for this function:
|
friend |
Definition at line 50 of file qtextdocumentfragment.h.
|
friend |
Definition at line 51 of file qtextdocumentfragment.h.
1.10.0