Struct qt_gui::QTextDocumentFragment

#[repr(C)]
pub struct QTextDocumentFragment { /* fields omitted */ }

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

C++ class: QTextDocumentFragment.

C++ documentation:

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

Methods

impl QTextDocumentFragment

pub unsafe fn copy_from(
    &mut self,
    rhs: impl CastInto<Ref<QTextDocumentFragment>>
) -> MutRef<QTextDocumentFragment>

Assigns the other fragment to this fragment.

Calls C++ function: QTextDocumentFragment& QTextDocumentFragment::operator=(const QTextDocumentFragment& rhs).

C++ documentation:

Assigns the other fragment to this fragment.

pub unsafe fn from_html_1a(
    html: impl CastInto<Ref<QString>>
) -> CppBox<QTextDocumentFragment>

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.

Calls C++ function: static QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString& html).

C++ documentation:

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.

pub unsafe fn from_html_2a(
    html: impl CastInto<Ref<QString>>,
    resource_provider: impl CastInto<Ptr<QTextDocument>>
) -> CppBox<QTextDocumentFragment>

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.

Calls C++ function: static QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString& html, const QTextDocument* resourceProvider).

C++ documentation:

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.

pub unsafe fn from_plain_text(
    plain_text: impl CastInto<Ref<QString>>
) -> CppBox<QTextDocumentFragment>

Returns a document fragment that contains the given plainText.

Calls C++ function: static QTextDocumentFragment QTextDocumentFragment::fromPlainText(const QString& plainText).

C++ documentation:

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.

pub unsafe fn is_empty(&self) -> bool

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

Calls C++ function: bool QTextDocumentFragment::isEmpty() const.

C++ documentation:

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

pub unsafe fn new() -> CppBox<QTextDocumentFragment>

Constructs an empty QTextDocumentFragment.

Calls C++ function: [constructor] void QTextDocumentFragment::QTextDocumentFragment().

C++ documentation:

Constructs an empty QTextDocumentFragment.

See also isEmpty().

pub unsafe fn from_q_text_document(
    document: impl CastInto<Ptr<QTextDocument>>
) -> CppBox<QTextDocumentFragment>

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

Calls C++ function: [constructor] void QTextDocumentFragment::QTextDocumentFragment(const QTextDocument* document).

C++ documentation:

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

pub unsafe fn from_q_text_cursor(
    range: impl CastInto<Ref<QTextCursor>>
) -> CppBox<QTextDocumentFragment>

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

Calls C++ function: [constructor] void QTextDocumentFragment::QTextDocumentFragment(const QTextCursor& range).

C++ documentation:

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

pub unsafe fn new_copy(
    rhs: impl CastInto<Ref<QTextDocumentFragment>>
) -> CppBox<QTextDocumentFragment>

Copy constructor. Creates a copy of the other fragment.

Calls C++ function: [constructor] void QTextDocumentFragment::QTextDocumentFragment(const QTextDocumentFragment& rhs).

C++ documentation:

Copy constructor. Creates a copy of the other fragment.

pub unsafe fn to_html_1a(
    &self,
    encoding: impl CastInto<Ref<QByteArray>>
) -> CppBox<QString>

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

Calls C++ function: QString QTextDocumentFragment::toHtml(const QByteArray& encoding = …) const.

C++ documentation:

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.

pub unsafe fn to_html_0a(&self) -> CppBox<QString>

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

Calls C++ function: QString QTextDocumentFragment::toHtml() const.

C++ documentation:

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.

pub unsafe fn to_plain_text(&self) -> CppBox<QString>

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

Calls C++ function: QString QTextDocumentFragment::toPlainText() const.

C++ documentation:

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

See also toHtml().

Trait Implementations

impl CppDeletable for QTextDocumentFragment

unsafe fn delete(&mut self)

Destroys the document fragment.

Calls C++ function: [destructor] void QTextDocumentFragment::~QTextDocumentFragment().

C++ documentation:

Destroys the document fragment.