Notation used in Ruby API documentation
Module: QtCore
Description: Binding of QObject
Class hierarchy: QObject
new QObject | new | (QObject ptr parent = nullptr) | Constructor QObject::QObject(QObject *parent) |
[const] | QObject 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. | ||
bool | blockSignals | (bool b) | Method bool QObject::blockSignals(bool b) | |
[const] | QObject ptr[] | children | Method const QList<QObject*> &QObject::children() | |
[const] | QMetaObject_Connection | connect | (const QObject ptr sender, string signal, string member, const Qt_ConnectionType type = Qt::AutoConnection) | Method QMetaObject::Connection QObject::connect(const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type) |
void | deleteLater | Method void QObject::deleteLater() | ||
[signal] | void | destroyed | (QObject ptr arg1) | Signal declaration for QObject::destroyed(QObject *) |
[const] | bool | disconnect | (string signal = nullptr, const QObject ptr receiver = nullptr, string member = nullptr) | Method bool QObject::disconnect(const char *signal, const QObject *receiver, const char *member) |
[const] | bool | disconnect | (const QObject ptr receiver, string member = nullptr) | Method bool QObject::disconnect(const QObject *receiver, const char *member) |
void | dumpObjectInfo | Method void QObject::dumpObjectInfo() | ||
[const] | void | dumpObjectInfo | Method void QObject::dumpObjectInfo() | |
void | dumpObjectTree | Method void QObject::dumpObjectTree() | ||
[const] | void | dumpObjectTree | Method void QObject::dumpObjectTree() | |
[const] | bytes[] | dynamicPropertyNames | Method QList<QByteArray> QObject::dynamicPropertyNames() | |
void | emit_destroyed | (QObject ptr arg1 = nullptr) | Emitter for signal void QObject::destroyed(QObject *) | |
void | emit_objectNameChanged | (string objectName) | Emitter for signal void QObject::objectNameChanged(const QString &objectName) | |
bool | event | (QEvent ptr event) | Virtual method bool QObject::event(QEvent *event) | |
bool | eventFilter | (QObject ptr watched, QEvent ptr event) | Virtual method bool QObject::eventFilter(QObject *watched, QEvent *event) | |
QObject ptr | findChild | (string name = null, Qt_QFlags_FindChildOption options = Qt::FindChildrenRecursively) | Specialisation for findChild (uses QObject as T). | |
QObject ptr[] | findChildren | (string name = null, Qt_QFlags_FindChildOption options = Qt::FindChildrenRecursively) | Specialisation for findChildren (uses QObject as T). | |
QObject ptr[] | findChildren | (const QRegularExpression re, Qt_QFlags_FindChildOption options = Qt::FindChildrenRecursively) | Specialisation for findChildren (uses QObject as T). | |
[const] | bool | inherits | (string classname) | Method bool QObject::inherits(const char *classname) |
void | installEventFilter | (QObject ptr filterObj) | Method void QObject::installEventFilter(QObject *filterObj) | |
[const] | bool | isWidgetType? | Method bool QObject::isWidgetType() | |
[const] | bool | isWindowType? | Method bool QObject::isWindowType() | |
void | killTimer | (int id) | Method void QObject::killTimer(int id) | |
method_missing | (id, ...) | Maps unknown methods to accessors for child objects | ||
method_missing | (id, ...) | Maps unknown methods to accessors for child objects | ||
void | moveToThread | (QThread ptr thread) | Method void QObject::moveToThread(QThread *thread) | |
[const] | string | objectName | Method QString QObject::objectName() | |
void | objectName= | (string name) | Method void QObject::setObjectName(const QString &name) | |
[signal] | void | objectNameChanged | (string objectName) | Signal declaration for QObject::objectNameChanged(const QString &objectName) |
[const] | QObject ptr | parent | Method QObject *QObject::parent() | |
void | parent= | (QObject ptr parent) | Method void QObject::setParent(QObject *parent) | |
[const] | variant | property | (string name) | Method QVariant QObject::property(const char *name) |
void | removeEventFilter | (QObject ptr obj) | Method void QObject::removeEventFilter(QObject *obj) | |
void | setObjectName | (string name) | Method void QObject::setObjectName(const QString &name) | |
void | setParent | (QObject ptr parent) | Method void QObject::setParent(QObject *parent) | |
bool | setProperty | (string name, variant value) | Method bool QObject::setProperty(const char *name, const QVariant &value) | |
[const] | bool | signalsBlocked | Method bool QObject::signalsBlocked() | |
int | startTimer | (int interval, const Qt_TimerType timerType = Qt::CoarseTimer) | Method int QObject::startTimer(int interval, Qt::TimerType timerType) | |
[const] | QThread ptr | thread | Method QThread *QObject::thread() |
QMetaObject_Connection | connect | (const QObject ptr sender, string signal, const QObject ptr receiver, string member, const Qt_ConnectionType arg5 = Qt::AutoConnection) | Static method QMetaObject::Connection QObject::connect(const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType) | |
QMetaObject_Connection | connect | (const QObject ptr sender, const QMetaMethod signal, const QObject ptr receiver, const QMetaMethod method, const Qt_ConnectionType type = Qt::AutoConnection) | Static method QMetaObject::Connection QObject::connect(const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) | |
bool | disconnect | (const QObject ptr sender, string signal, const QObject ptr receiver, string member) | Static method bool QObject::disconnect(const QObject *sender, const char *signal, const QObject *receiver, const char *member) | |
bool | disconnect | (const QObject ptr sender, const QMetaMethod signal, const QObject ptr receiver, const QMetaMethod member) | Static method bool QObject::disconnect(const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) | |
bool | disconnect | (const QMetaObject_Connection arg1) | Static method bool QObject::disconnect(const QMetaObject::Connection &) | |
unsigned int | registerUserData | Static method unsigned int QObject::registerUserData() | ||
QMetaObject | staticMetaObject | Obtains the static MetaObject for this class. | ||
string | tr | (string s, string c = nullptr, int n = -1) | Static method QString QObject::tr(const char *s, const char *c, int n) | |
string | trUtf8 | (string s, string c = nullptr, int n = -1) | Static method QString QObject::trUtf8(const char *s, const char *c, int n) |
void | childEvent | (QChildEvent ptr event) | Virtual method void QObject::childEvent(QChildEvent *event) | ||
void | customEvent | (QEvent ptr event) | Virtual method void QObject::customEvent(QEvent *event) | ||
void | disconnectNotify | (const QMetaMethod signal) | Virtual method void QObject::disconnectNotify(const QMetaMethod &signal) | ||
[const] | bool | isSignalConnected | (const QMetaMethod signal) | Method bool QObject::isSignalConnected(const QMetaMethod &signal) | |
[const] | int | receivers | (string signal) | Method int QObject::receivers(const char *signal) | |
[const] | QObject ptr | sender | Method QObject *QObject::sender() | ||
[const] | int | senderSignalIndex | Method int QObject::senderSignalIndex() | ||
void | timerEvent | (QTimerEvent ptr event) | Virtual method void QObject::timerEvent(QTimerEvent *event) |
void | create | Use of this method is deprecated. Use _create instead | ||
void | destroy | Use of this method is deprecated. Use _destroy instead | ||
[const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_const_cast | Signature: [const] QObject 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. |
blockSignals | Signature: bool blockSignals (bool b) Description: Method bool QObject::blockSignals(bool b) |
childEvent | Signature: void childEvent (QChildEvent ptr event) Description: Virtual method void QObject::childEvent(QChildEvent *event) This method can be reimplemented in a derived class. |
children | Signature: [const] QObject ptr[] children Description: Method const QList<QObject*> &QObject::children() |
connect | (1) Signature: [const] QMetaObject_Connection connect (const QObject ptr sender, string signal, string member, const Qt_ConnectionType type = Qt::AutoConnection) Description: Method QMetaObject::Connection QObject::connect(const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type) Python specific notes: |
(2) Signature: [static] QMetaObject_Connection connect (const QObject ptr sender, string signal, const QObject ptr receiver, string member, const Qt_ConnectionType arg5 = Qt::AutoConnection) Description: Static method QMetaObject::Connection QObject::connect(const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType) This method is static and can be called without an instance. Python specific notes: | |
(3) Signature: [static] QMetaObject_Connection connect (const QObject ptr sender, const QMetaMethod signal, const QObject ptr receiver, const QMetaMethod method, const Qt_ConnectionType type = Qt::AutoConnection) Description: Static method QMetaObject::Connection QObject::connect(const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) This method is static and can be called without an instance. Python specific notes: | |
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. |
customEvent | Signature: void customEvent (QEvent ptr event) Description: Virtual method void QObject::customEvent(QEvent *event) This method can be reimplemented in a derived class. |
deleteLater | Signature: void deleteLater Description: Method void QObject::deleteLater() |
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: [signal] void destroyed (QObject ptr arg1) Description: Signal declaration for QObject::destroyed(QObject *) You can bind a procedure to this signal. Python specific notes: |
disconnect | (1) Signature: [const] bool disconnect (string signal = nullptr, const QObject ptr receiver = nullptr, string member = nullptr) Description: Method bool QObject::disconnect(const char *signal, const QObject *receiver, const char *member) Python specific notes: |
(2) Signature: [const] bool disconnect (const QObject ptr receiver, string member = nullptr) Description: Method bool QObject::disconnect(const QObject *receiver, const char *member) Python specific notes: | |
(3) Signature: [static] bool disconnect (const QObject ptr sender, string signal, const QObject ptr receiver, string member) Description: Static method bool QObject::disconnect(const QObject *sender, const char *signal, const QObject *receiver, const char *member) This method is static and can be called without an instance. Python specific notes: | |
(4) Signature: [static] bool disconnect (const QObject ptr sender, const QMetaMethod signal, const QObject ptr receiver, const QMetaMethod member) Description: Static method bool QObject::disconnect(const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) This method is static and can be called without an instance. Python specific notes: | |
(5) Signature: [static] bool disconnect (const QMetaObject_Connection arg1) Description: Static method bool QObject::disconnect(const QMetaObject::Connection &) This method is static and can be called without an instance. Python specific notes: | |
disconnectNotify | Signature: void disconnectNotify (const QMetaMethod signal) Description: Virtual method void QObject::disconnectNotify(const QMetaMethod &signal) This method can be reimplemented in a derived class. |
dumpObjectInfo | (1) Signature: void dumpObjectInfo Description: Method void QObject::dumpObjectInfo() |
(2) Signature: [const] void dumpObjectInfo Description: Method void QObject::dumpObjectInfo() | |
dumpObjectTree | (1) Signature: void dumpObjectTree Description: Method void QObject::dumpObjectTree() |
(2) Signature: [const] void dumpObjectTree Description: Method void QObject::dumpObjectTree() | |
dynamicPropertyNames | Signature: [const] bytes[] dynamicPropertyNames Description: Method QList<QByteArray> QObject::dynamicPropertyNames() |
emit_destroyed | Signature: void emit_destroyed (QObject ptr arg1 = nullptr) Description: Emitter for signal void QObject::destroyed(QObject *) Call this method to emit this signal. |
emit_objectNameChanged | Signature: void emit_objectNameChanged (string objectName) Description: Emitter for signal void QObject::objectNameChanged(const QString &objectName) Call this method to emit this signal. |
event | Signature: bool event (QEvent ptr event) Description: Virtual method bool QObject::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 QObject::eventFilter(QObject *watched, QEvent *event) This method can be reimplemented in a derived class. |
findChild | Signature: QObject ptr findChild (string name = null, Qt_QFlags_FindChildOption options = Qt::FindChildrenRecursively) Description: Specialisation for findChild (uses QObject as T). |
findChildren | (1) Signature: QObject ptr[] findChildren (string name = null, Qt_QFlags_FindChildOption options = Qt::FindChildrenRecursively) Description: Specialisation for findChildren (uses QObject as T). |
(2) Signature: QObject ptr[] findChildren (const QRegularExpression re, Qt_QFlags_FindChildOption options = Qt::FindChildrenRecursively) Description: Specialisation for findChildren (uses QObject as T). | |
inherits | Signature: [const] bool inherits (string classname) Description: Method bool QObject::inherits(const char *classname) |
installEventFilter | Signature: void installEventFilter (QObject ptr filterObj) Description: Method void QObject::installEventFilter(QObject *filterObj) |
isSignalConnected | Signature: [const] bool isSignalConnected (const QMetaMethod signal) Description: Method bool QObject::isSignalConnected(const QMetaMethod &signal) This method is protected and can only be called from inside a derived class. |
isWidgetType? | Signature: [const] bool isWidgetType? Description: Method bool QObject::isWidgetType() |
isWindowType? | Signature: [const] bool isWindowType? Description: Method bool QObject::isWindowType() |
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. |
killTimer | Signature: void killTimer (int id) Description: Method void QObject::killTimer(int id) |
method_missing | (1) Signature: method_missing (id, ...) Description: Maps unknown methods to accessors for child objects This method implements Ruby's fallback mechanism and adds some convenience to QObject: through that implementation, each child object can be accessed through its name. That method will deliver a reference to the child object or nil if there is no child element with that name. For example: dialog = MyDialog.new # has a widget named "button" dialog.button.text = "The button text" If no child object with the given name exists, an exception is thrown. You can use "respond_to?(child_name)" to check whether a child with the given name exists. |
(2) Signature: method_missing (id, ...) Description: Maps unknown methods to accessors for child objects This method implements Ruby's fallback mechanism and adds some convenience to QObject: through that implementation, each child object can be accessed through its name. That method will deliver a reference to the child object or nil if there is no child element with that name. For example: dialog = MyDialog.new # has a widget named "button" dialog.button.text = "The button text" If no child object with the given name exists, an exception is thrown. You can use "respond_to?(child_name)" to check whether a child with the given name exists. | |
moveToThread | Signature: void moveToThread (QThread ptr thread) Description: Method void QObject::moveToThread(QThread *thread) |
new | Signature: [static] new QObject new (QObject ptr parent = nullptr) Description: Constructor QObject::QObject(QObject *parent) This method creates an object of class QObject. Python specific notes: |
objectName | Signature: [const] string objectName Description: Method QString QObject::objectName() Python specific notes: |
objectName= | Signature: void objectName= (string name) Description: Method void QObject::setObjectName(const QString &name) Python specific notes: |
objectNameChanged | Signature: [signal] void objectNameChanged (string objectName) Description: Signal declaration for QObject::objectNameChanged(const QString &objectName) You can bind a procedure to this signal. Python specific notes: |
parent | Signature: [const] QObject ptr parent Description: Method QObject *QObject::parent() Python specific notes: |
parent= | Signature: void parent= (QObject ptr parent) Description: Method void QObject::setParent(QObject *parent) Python specific notes: |
property | Signature: [const] variant property (string name) Description: Method QVariant QObject::property(const char *name) |
receivers | Signature: [const] int receivers (string signal) Description: Method int QObject::receivers(const char *signal) This method is protected and can only be called from inside a derived class. |
registerUserData | Signature: [static] unsigned int registerUserData Description: Static method unsigned int QObject::registerUserData() This method is static and can be called without an instance. |
removeEventFilter | Signature: void removeEventFilter (QObject ptr obj) Description: Method void QObject::removeEventFilter(QObject *obj) |
sender | Signature: [const] QObject ptr sender Description: Method QObject *QObject::sender() This method is protected and can only be called from inside a derived class. |
senderSignalIndex | Signature: [const] int senderSignalIndex Description: Method int QObject::senderSignalIndex() This method is protected and can only be called from inside a derived class. |
setObjectName | Signature: void setObjectName (string name) Description: Method void QObject::setObjectName(const QString &name) Python specific notes: |
setParent | Signature: void setParent (QObject ptr parent) Description: Method void QObject::setParent(QObject *parent) Python specific notes: |
setProperty | Signature: bool setProperty (string name, variant value) Description: Method bool QObject::setProperty(const char *name, const QVariant &value) |
signalsBlocked | Signature: [const] bool signalsBlocked Description: Method bool QObject::signalsBlocked() |
startTimer | Signature: int startTimer (int interval, const Qt_TimerType timerType = Qt::CoarseTimer) Description: Method int QObject::startTimer(int interval, Qt::TimerType timerType) |
staticMetaObject | Signature: [static] QMetaObject staticMetaObject Description: Obtains the static MetaObject for this class. |
thread | Signature: [const] QThread ptr thread Description: Method QThread *QObject::thread() |
timerEvent | Signature: void timerEvent (QTimerEvent ptr event) Description: Virtual method void QObject::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 QObject::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 QObject::trUtf8(const char *s, const char *c, int n) This method is static and can be called without an instance. |