KLayout Manual: Main Index » Class Index » API reference - Class QTextDocumentFragment

API reference - Class QTextDocumentFragment

Notation used in Ruby API documentation

Description: Binding of QTextDocumentFragment

Public constructors

new QTextDocumentFragmentnewConstructor QTextDocumentFragment::QTextDocumentFragment()
new QTextDocumentFragmentnew(const QTextCursor range)Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextCursor &range)
new QTextDocumentFragmentnew(const QTextDocument ptr document)Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextDocument *document)
new QTextDocumentFragmentnew(const QTextDocumentFragment rhs)Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextDocumentFragment &rhs)

Public methods

QTextDocumentFragmentassign(const QTextDocumentFragment rhs)Method QTextDocumentFragment & QTextDocumentFragment::operator=(const QTextDocumentFragment &rhs)
[const]voidassign(const QTextDocumentFragment other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QTextDocumentFragmentdupCreates a copy of self
[const]boolisEmptyMethod bool QTextDocumentFragment::isEmpty()
[const]boolisEmpty?Method bool QTextDocumentFragment::isEmpty()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]stringtoHtmlMethod QString QTextDocumentFragment::toHtml()
[const]stringtoHtml(string encoding)Method QString QTextDocumentFragment::toHtml(const QByteArray &encoding)
[const]stringtoPlainTextMethod QString QTextDocumentFragment::toPlainText()

Public static methods and constants

QTextDocumentFragmentfromHtml(string html)Static method QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &html)
QTextDocumentFragmentfromHtml(string html,
const QTextDocument ptr resourceProvider)
Static method QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &html, const QTextDocument *resourceProvider)
QTextDocumentFragmentfromPlainText(string plainText)Static method QTextDocumentFragment QTextDocumentFragment::fromPlainText(const QString &plainText)

Detailed description

QTextDocumentFragment assign(const QTextDocumentFragment rhs)

Description: Method QTextDocumentFragment & QTextDocumentFragment::operator=(const QTextDocumentFragment &rhs)

[const] void assign(const QTextDocumentFragment other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] QTextDocumentFragment dup

Description: Creates a copy of self

[static] QTextDocumentFragment fromHtml(string html)

Description: Static method QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &html)

This method is static and can be called without an instance.

[static] QTextDocumentFragment fromHtml(string html,const QTextDocument ptr resourceProvider)

Description: Static method QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &html, const QTextDocument *resourceProvider)

This method is static and can be called without an instance.

[static] QTextDocumentFragment fromPlainText(string plainText)

Description: Static method QTextDocumentFragment QTextDocumentFragment::fromPlainText(const QString &plainText)

This method is static and can be called without an instance.

[const] bool isEmpty

Description: Method bool QTextDocumentFragment::isEmpty()

[const] bool isEmpty?

Description: Method bool QTextDocumentFragment::isEmpty()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[static] new QTextDocumentFragment new

Description: Constructor QTextDocumentFragment::QTextDocumentFragment()

This method creates an object of class QTextDocumentFragment.

[static] new QTextDocumentFragment new(const QTextCursor range)

Description: Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextCursor &range)

This method creates an object of class QTextDocumentFragment.

[static] new QTextDocumentFragment new(const QTextDocument ptr document)

Description: Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextDocument *document)

This method creates an object of class QTextDocumentFragment.

[static] new QTextDocumentFragment new(const QTextDocumentFragment rhs)

Description: Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextDocumentFragment &rhs)

This method creates an object of class QTextDocumentFragment.

[const] string toHtml

Description: Method QString QTextDocumentFragment::toHtml()

[const] string toHtml(string encoding)

Description: Method QString QTextDocumentFragment::toHtml(const QByteArray &encoding)

[const] string toPlainText

Description: Method QString QTextDocumentFragment::toPlainText()