Notation used in Ruby API documentation
Module: QtGui
Description: Binding of QTextDocumentFragment
new QTextDocumentFragment | new | Constructor QTextDocumentFragment::QTextDocumentFragment() | |
new QTextDocumentFragment | new | (const QTextDocument ptr document) | Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextDocument *document) |
new QTextDocumentFragment | new | (const QTextCursor range) | Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextCursor &range) |
new QTextDocumentFragment | new | (const QTextDocumentFragment rhs) | Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextDocumentFragment &rhs) |
void | _assign | (const QTextDocumentFragment other) | Assigns another object to self | |
[const] | QTextDocumentFragment ptr | _const_cast | Returns a non-const reference to self. | |
void | _create | Ensures the C++ object is created | ||
void | _destroy | Explicitly destroys the object | ||
[const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
[const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
void | _manage | Marks the object as managed by the script side. | ||
void | _unmanage | Marks the object as no longer owned by the script side. | ||
QTextDocumentFragment | assign | (const QTextDocumentFragment rhs) | Method QTextDocumentFragment &QTextDocumentFragment::operator=(const QTextDocumentFragment &rhs) | |
[const] | new QTextDocumentFragment ptr | dup | Creates a copy of self | |
[const] | bool | isEmpty? | Method bool QTextDocumentFragment::isEmpty() | |
[const] | string | toHtml | Method QString QTextDocumentFragment::toHtml() | |
[const] | string | toHtml | (bytes encoding) | Method QString QTextDocumentFragment::toHtml(const QByteArray &encoding) |
[const] | string | toPlainText | Method QString QTextDocumentFragment::toPlainText() |
QTextDocumentFragment | fromHtml | (string html) | Static method QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &html) | |
QTextDocumentFragment | fromHtml | (string html, const QTextDocument ptr resourceProvider) | Static method QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &html, const QTextDocument *resourceProvider) | |
QTextDocumentFragment | fromPlainText | (string plainText) | Static method QTextDocumentFragment QTextDocumentFragment::fromPlainText(const QString &plainText) |
void | create | Use of this method is deprecated. Use _create instead | ||
void | destroy | Use of this method is deprecated. Use _destroy instead | ||
[const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
[const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_assign | Signature: void _assign (const QTextDocumentFragment other) Description: Assigns another object to self |
_const_cast | Signature: [const] QTextDocumentFragment ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_create | Signature: 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. |
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
_destroyed? | Signature: [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. |
_is_const_object? | Signature: [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. |
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. |
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. |
assign | Signature: QTextDocumentFragment assign (const QTextDocumentFragment rhs) Description: Method QTextDocumentFragment &QTextDocumentFragment::operator=(const QTextDocumentFragment &rhs) |
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead 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. |
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. |
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead 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. |
dup | Signature: [const] new QTextDocumentFragment ptr dup Description: Creates a copy of self Python specific notes: |
fromHtml | (1) Signature: [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. |
(2) Signature: [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. | |
fromPlainText | Signature: [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. |
isEmpty? | Signature: [const] bool isEmpty? Description: Method bool QTextDocumentFragment::isEmpty() |
is_const_object? | Signature: [const] bool is_const_object? Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead This method returns true, if self is a const reference. In that case, only const methods may be called on self. |
new | (1) Signature: [static] new QTextDocumentFragment new Description: Constructor QTextDocumentFragment::QTextDocumentFragment() This method creates an object of class QTextDocumentFragment. Python specific notes: |
(2) Signature: [static] new QTextDocumentFragment new (const QTextDocument ptr document) Description: Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextDocument *document) This method creates an object of class QTextDocumentFragment. Python specific notes: | |
(3) Signature: [static] new QTextDocumentFragment new (const QTextCursor range) Description: Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextCursor &range) This method creates an object of class QTextDocumentFragment. Python specific notes: | |
(4) Signature: [static] new QTextDocumentFragment new (const QTextDocumentFragment rhs) Description: Constructor QTextDocumentFragment::QTextDocumentFragment(const QTextDocumentFragment &rhs) This method creates an object of class QTextDocumentFragment. Python specific notes: | |
toHtml | (1) Signature: [const] string toHtml Description: Method QString QTextDocumentFragment::toHtml() |
(2) Signature: [const] string toHtml (bytes encoding) Description: Method QString QTextDocumentFragment::toHtml(const QByteArray &encoding) | |
toPlainText | Signature: [const] string toPlainText Description: Method QString QTextDocumentFragment::toPlainText() |