Notation used in Ruby API documentation
Module: QtGui
Description: Binding of QTextObject
Class hierarchy: QTextObject » QObject
[const] | QTextObject 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. | ||
[signal] | void | destroyed | (QObject ptr arg1) | Signal declaration for QTextObject::destroyed(QObject *) |
[const] | QTextDocument ptr | document | Method QTextDocument *QTextObject::document() | |
void | emit_destroyed | (QObject ptr arg1 = nullptr) | Emitter for signal void QTextObject::destroyed(QObject *) | |
void | emit_objectNameChanged | (string objectName) | Emitter for signal void QTextObject::objectNameChanged(const QString &objectName) | |
bool | event | (QEvent ptr event) | Virtual method bool QTextObject::event(QEvent *event) | |
bool | eventFilter | (QObject ptr watched, QEvent ptr event) | Virtual method bool QTextObject::eventFilter(QObject *watched, QEvent *event) | |
[const] | QTextFormat | format | Method QTextFormat QTextObject::format() | |
[const] | int | formatIndex | Method int QTextObject::formatIndex() | |
[const] | int | objectIndex | Method int QTextObject::objectIndex() | |
[signal] | void | objectNameChanged | (string objectName) | Signal declaration for QTextObject::objectNameChanged(const QString &objectName) |
QMetaObject | staticMetaObject | Obtains the static MetaObject for this class. | ||
string | tr | (string s, string c = nullptr, int n = -1) | Static method QString QTextObject::tr(const char *s, const char *c, int n) | |
string | trUtf8 | (string s, string c = nullptr, int n = -1) | Static method QString QTextObject::trUtf8(const char *s, const char *c, int n) |
void | childEvent | (QChildEvent ptr event) | Virtual method void QTextObject::childEvent(QChildEvent *event) | ||
void | customEvent | (QEvent ptr event) | Virtual method void QTextObject::customEvent(QEvent *event) | ||
void | disconnectNotify | (const QMetaMethod signal) | Virtual method void QTextObject::disconnectNotify(const QMetaMethod &signal) | ||
[const] | bool | isSignalConnected | (const QMetaMethod signal) | Method bool QTextObject::isSignalConnected(const QMetaMethod &signal) | |
[const] | int | receivers | (string signal) | Method int QTextObject::receivers(const char *signal) | |
[const] | QObject ptr | sender | Method QObject *QTextObject::sender() | ||
[const] | int | senderSignalIndex | Method int QTextObject::senderSignalIndex() | ||
void | setFormat | (const QTextFormat format) | Method void QTextObject::setFormat(const QTextFormat &format) | ||
void | timerEvent | (QTimerEvent ptr event) | Virtual method void QTextObject::timerEvent(QTimerEvent *event) |
_const_cast | Signature: [const] QTextObject 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. |
childEvent | Signature: void childEvent (QChildEvent ptr event) Description: Virtual method void QTextObject::childEvent(QChildEvent *event) This method can be reimplemented in a derived class. |
customEvent | Signature: void customEvent (QEvent ptr event) Description: Virtual method void QTextObject::customEvent(QEvent *event) This method can be reimplemented in a derived class. |
destroyed | Signature: [signal] void destroyed (QObject ptr arg1) Description: Signal declaration for QTextObject::destroyed(QObject *) You can bind a procedure to this signal. Python specific notes: |
disconnectNotify | Signature: void disconnectNotify (const QMetaMethod signal) Description: Virtual method void QTextObject::disconnectNotify(const QMetaMethod &signal) This method can be reimplemented in a derived class. |
document | Signature: [const] QTextDocument ptr document Description: Method QTextDocument *QTextObject::document() |
emit_destroyed | Signature: void emit_destroyed (QObject ptr arg1 = nullptr) Description: Emitter for signal void QTextObject::destroyed(QObject *) Call this method to emit this signal. |
emit_objectNameChanged | Signature: void emit_objectNameChanged (string objectName) Description: Emitter for signal void QTextObject::objectNameChanged(const QString &objectName) Call this method to emit this signal. |
event | Signature: bool event (QEvent ptr event) Description: Virtual method bool QTextObject::event(QEvent *event) This method can be reimplemented in a derived class. |
eventFilter | Signature: bool eventFilter (QObject ptr watched, QEvent ptr event) Description: Virtual method bool QTextObject::eventFilter(QObject *watched, QEvent *event) This method can be reimplemented in a derived class. |
format | Signature: [const] QTextFormat format Description: Method QTextFormat QTextObject::format() |
formatIndex | Signature: [const] int formatIndex Description: Method int QTextObject::formatIndex() |
isSignalConnected | Signature: [const] bool isSignalConnected (const QMetaMethod signal) Description: Method bool QTextObject::isSignalConnected(const QMetaMethod &signal) This method is protected and can only be called from inside a derived class. |
objectIndex | Signature: [const] int objectIndex Description: Method int QTextObject::objectIndex() |
objectNameChanged | Signature: [signal] void objectNameChanged (string objectName) Description: Signal declaration for QTextObject::objectNameChanged(const QString &objectName) You can bind a procedure to this signal. Python specific notes: |
receivers | Signature: [const] int receivers (string signal) Description: Method int QTextObject::receivers(const char *signal) This method is protected and can only be called from inside a derived class. |
sender | Signature: [const] QObject ptr sender Description: Method QObject *QTextObject::sender() This method is protected and can only be called from inside a derived class. |
senderSignalIndex | Signature: [const] int senderSignalIndex Description: Method int QTextObject::senderSignalIndex() This method is protected and can only be called from inside a derived class. |
setFormat | Signature: void setFormat (const QTextFormat format) Description: Method void QTextObject::setFormat(const QTextFormat &format) This method is protected and can only be called from inside a derived class. |
staticMetaObject | Signature: [static] QMetaObject staticMetaObject Description: Obtains the static MetaObject for this class. |
timerEvent | Signature: void timerEvent (QTimerEvent ptr event) Description: Virtual method void QTextObject::timerEvent(QTimerEvent *event) This method can be reimplemented in a derived class. |
tr | Signature: [static] string tr (string s, string c = nullptr, int n = -1) Description: Static method QString QTextObject::tr(const char *s, const char *c, int n) This method is static and can be called without an instance. |
trUtf8 | Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1) Description: Static method QString QTextObject::trUtf8(const char *s, const char *c, int n) This method is static and can be called without an instance. |