Qt Slot Return Value

The QMetaObject class contains meta-information about Qt objects. More...

• Qt Slot Return Value Estimator
• Qt Slot Return Value Guide
• Qt Slot Return Value Kelley Blue Book
• Qt Slot Return Value
• Qt Connect Slot Return Value

Public Types

Qt Get Return Value From Slot registered address at Level 5, Suite 1A, Portomaso Business Tower, Vjal Portomaso, St. Julians, STJ 4012, Malta and by EveryMatrix N.V., a limited liability company incorporated under Qt Get Return Value From Slot the laws of Curacao, bearing company registration number 108354 and having its. Return 1 if this class is the same type of (or a subclass of) the named class. With the return value of the callback method. Qt slots to connect with must. Asynchronous slots are marked by the keyword QNOREPLY in the method signature, before the void return type and the slot name. (See the quit slot in the D-Bus Adaptor Example). Input-Only Slots. Input-only slots are normal slots that take parameters passed by value or by constant reference. Further properties of signal/slots. Qt provides the QObject::sender function, which returns a pointer to the object that sent the signal Note: if the slot was not activated by a signal, the return is undefined. Signals and slots are loosely coupled: A class which emits a signal neither knows nor cares which slots receive the signal.

Public Functions

Qt Slot Return Value Estimator

Public Variables

Static Public Members

Macros

Detailed Description

The QMetaObject class contains meta-information about Qt objects.

The Qt Meta-Object System in Qt is responsible for the signals and slots inter-object communication mechanism, runtime type information, and the Qt property system. A single QMetaObject instance is created for each QObject subclass that is used in an application, and this instance stores all the meta-information for the QObject subclass. This object is available as QObject::metaObject().

This class is not normally required for application programming, but it is useful if you write meta-applications, such as scripting engines or GUI builders.

The functions you are most likely to find useful are these:

• className() returns the name of a class.
• superClass() returns the superclass's meta-object.
• method() and methodCount() provide information about a class's meta-methods (signals, slots and other invokable member functions).
• enumerator() and enumeratorCount() and provide information about a class's enumerators.
• propertyCount() and property() provide information about a class's properties.
• constructor() and constructorCount() provide information about a class's meta-constructors.

The index functions indexOfConstructor(), indexOfMethod(), indexOfEnumerator(), and indexOfProperty() map names of constructors, member functions, enumerators, or properties to indexes in the meta-object. For example, Qt uses indexOfMethod() internally when you connect a signal to a slot.

Classes can also have a list of name--value pairs of additional class information, stored in QMetaClassInfo objects. The number of pairs is returned by classInfoCount(), single pairs are returned by classInfo(), and you can search for pairs with indexOfClassInfo().

Note: Operations that use the meta object system are generally thread- safe, as QMetaObjects are typically static read-only instances generated at compile time. However, if meta objects are dynamically modified by the application (for instance, when using QQmlPropertyMap), then the application has to explicitly synchronize access to the respective meta object.

See also QMetaClassInfo, QMetaEnum, QMetaMethod, QMetaProperty, QMetaType, and Meta-Object System.

Member Function Documentation

[static] bool QMetaObject::checkConnectArgs(const char *signal, const char *method)

Returns true if the signal and method arguments are compatible; otherwise returns false.

Both signal and method are expected to be normalized.

See also normalizedSignature().

[static] bool QMetaObject::checkConnectArgs(const QMetaMethod &signal, const QMetaMethod &method)

This is an overloaded function.

Returns true if the signal and method arguments are compatible; otherwise returns false.

This function was introduced in Qt 5.0.

QMetaClassInfo QMetaObject::classInfo(intindex) const

Returns the meta-data for the item of class information with the given index.

Example:

See also classInfoCount(), classInfoOffset(), and indexOfClassInfo().

int QMetaObject::classInfoCount() const

Returns the number of items of class information in this class.

See also classInfo(), classInfoOffset(), and indexOfClassInfo().

int QMetaObject::classInfoOffset() const

Returns the class information offset for this class; i.e. the index position of this class's first class information item.

If the class has no superclasses with class information, the offset is 0; otherwise the offset is the sum of all the class information items in the class's superclasses.

See also classInfo(), classInfoCount(), and indexOfClassInfo().

const char *QMetaObject::className() const

Returns the class name.

See also superClass().

[static] void QMetaObject::connectSlotsByName(QObject *object)

Searches recursively for all child objects of the given object, and connects matching signals from them to slots of object that follow the following form:

Let's assume our object has a child object of type QPushButton with the object namebutton1. The slot to catch the button's clicked() signal would be:

If object itself has a properly set object name, its own signals are also connected to its respective slots.

See also QObject::setObjectName().

QMetaMethod QMetaObject::constructor(intindex) const

Returns the meta-data for the constructor with the given index.

This function was introduced in Qt 4.5.

See also constructorCount() and newInstance().

int QMetaObject::constructorCount() const

Returns the number of constructors in this class.

This function was introduced in Qt 4.5.

See also constructor() and indexOfConstructor().

QMetaEnum QMetaObject::enumerator(intindex) const

Returns the meta-data for the enumerator with the given index.

See also enumeratorCount(), enumeratorOffset(), and indexOfEnumerator().

int QMetaObject::enumeratorCount() const

Returns the number of enumerators in this class.

See also enumerator(), enumeratorOffset(), and indexOfEnumerator().

int QMetaObject::enumeratorOffset() const

Returns the enumerator offset for this class; i.e. the index position of this class's first enumerator.

If the class has no superclasses with enumerators, the offset is 0; otherwise the offset is the sum of all the enumerators in the class's superclasses.

See also enumerator(), enumeratorCount(), and indexOfEnumerator().

int QMetaObject::indexOfClassInfo(const char *name) const

Finds class information item name and returns its index; otherwise returns -1.

See also classInfo(), classInfoCount(), and classInfoOffset().

int QMetaObject::indexOfConstructor(const char *constructor) const

Finds constructor and returns its index; otherwise returns -1.

Note that the constructor has to be in normalized form, as returned by normalizedSignature().

This function was introduced in Qt 4.5.

See also constructor(), constructorCount(), and normalizedSignature().

int QMetaObject::indexOfEnumerator(const char *name) const

Finds enumerator name and returns its index; otherwise returns -1.

See also enumerator(), enumeratorCount(), and enumeratorOffset().

int QMetaObject::indexOfMethod(const char *method) const

Finds method and returns its index; otherwise returns -1.

Note that the method has to be in normalized form, as returned by normalizedSignature().

See also method(), methodCount(), methodOffset(), and normalizedSignature().

int QMetaObject::indexOfProperty(const char *name) const

Finds property name and returns its index; otherwise returns -1.

See also property(), propertyCount(), and propertyOffset().

int QMetaObject::indexOfSignal(const char *signal) const

Finds signal and returns its index; otherwise returns -1.

This is the same as indexOfMethod(), except that it will return -1 if the method exists but isn't a signal.

Note that the signal has to be in normalized form, as returned by normalizedSignature().

See also indexOfMethod(), normalizedSignature(), method(), methodCount(), and methodOffset().

int QMetaObject::indexOfSlot(const char *slot) const

Finds slot and returns its index; otherwise returns -1.

This is the same as indexOfMethod(), except that it will return -1 if the method exists but isn't a slot.

See also indexOfMethod(), method(), methodCount(), and methodOffset().

bool QMetaObject::inherits(const QMetaObject *metaObject) const

Returns true if the class described by this QMetaObject inherits the type described by metaObject; otherwise returns false.

A type is considered to inherit itself.

This function was introduced in Qt 5.7.

[static] bool QMetaObject::invokeMethod(QObject *obj, const char *member, Qt::ConnectionTypetype, QGenericReturnArgumentret, QGenericArgumentval0 = QGenericArgument(nullptr), QGenericArgumentval1 = QGenericArgument(), QGenericArgumentval2 = QGenericArgument(), QGenericArgumentval3 = QGenericArgument(), QGenericArgumentval4 = QGenericArgument(), QGenericArgumentval5 = QGenericArgument(), QGenericArgumentval6 = QGenericArgument(), QGenericArgumentval7 = QGenericArgument(), QGenericArgumentval8 = QGenericArgument(), QGenericArgumentval9 = QGenericArgument())

Invokes the member (a signal or a slot name) on the object obj. Returns true if the member could be invoked. Returns false if there is no such member or the parameters did not match.

The invocation can be either synchronous or asynchronous, depending on type:

• If type is Qt::DirectConnection, the member will be invoked immediately.
• If type is Qt::QueuedConnection, a QEvent will be sent and the member is invoked as soon as the application enters the main event loop.
• If type is Qt::BlockingQueuedConnection, the method will be invoked in the same way as for Qt::QueuedConnection, except that the current thread will block until the event is delivered. Using this connection type to communicate between objects in the same thread will lead to deadlocks.
• If type is Qt::AutoConnection, the member is invoked synchronously if obj lives in the same thread as the caller; otherwise it will invoke the member asynchronously.

The return value of the member function call is placed in ret. If the invocation is asynchronous, the return value cannot be evaluated. You can pass up to ten arguments (val0, val1, val2, val3, val4, val5, val6, val7, val8, and val9) to the member function.

QGenericArgument and QGenericReturnArgument are internal helper classes. Because signals and slots can be dynamically invoked, you must enclose the arguments using the Q_ARG() and Q_RETURN_ARG() macros. Q_ARG() takes a type name and a const reference of that type; Q_RETURN_ARG() takes a type name and a non-const reference.

You only need to pass the name of the signal or slot to this function, not the entire signature. For example, to asynchronously invoke the quit() slot on a QThread, use the following code:

With asynchronous method invocations, the parameters must be of types that are known to Qt's meta-object system, because Qt needs to copy the arguments to store them in an event behind the scenes. If you try to use a queued connection and get the error message

call qRegisterMetaType() to register the data type before you call invokeMethod().

To synchronously invoke the compute(QString, int, double) slot on some arbitrary object obj retrieve its return value:

If the 'compute' slot does not take exactly one QString, one int and one double in the specified order, the call will fail.

Note: This function is thread-safe.

See also Q_ARG(), Q_RETURN_ARG(), qRegisterMetaType(), and QMetaMethod::invoke().

[static] bool QMetaObject::invokeMethod(QObject *obj, const char *member, QGenericReturnArgumentret, QGenericArgumentval0 = ..., QGenericArgumentval1 = ..., QGenericArgumentval2 = ..., QGenericArgumentval3 = ..., QGenericArgumentval4 = ..., QGenericArgumentval5 = ..., QGenericArgumentval6 = ..., QGenericArgumentval7 = ..., QGenericArgumentval8 = ..., QGenericArgumentval9 = ...)

This function overloads invokeMethod().

This overload always invokes the member using the connection type Qt::AutoConnection.

Note: This function is thread-safe.

[static] bool QMetaObject::invokeMethod(QObject *obj, const char *member, Qt::ConnectionTypetype, QGenericArgumentval0 = ..., QGenericArgumentval1 = ..., QGenericArgumentval2 = ..., QGenericArgumentval3 = ..., QGenericArgumentval4 = ..., QGenericArgumentval5 = ..., QGenericArgumentval6 = ..., QGenericArgumentval7 = ..., QGenericArgumentval8 = ..., QGenericArgumentval9 = ...)

This function overloads invokeMethod().

This overload can be used if the return value of the member is of no interest.

Note: This function is thread-safe.

[static] bool QMetaObject::invokeMethod(QObject *obj, const char *member, QGenericArgumentval0 = ..., QGenericArgumentval1 = ..., QGenericArgumentval2 = ..., QGenericArgumentval3 = ..., QGenericArgumentval4 = ..., QGenericArgumentval5 = ..., QGenericArgumentval6 = ..., QGenericArgumentval7 = ..., QGenericArgumentval8 = ..., QGenericArgumentval9 = ...)

This function overloads invokeMethod().

This overload invokes the member using the connection type Qt::AutoConnection and ignores return values.

Note: This function is thread-safe.

[static] bool QMetaObject::invokeMethod(QObject *context, Functorfunction, Qt::ConnectionTypetype = Qt::AutoConnection, FunctorReturnType *ret = nullptr)

This is an overloaded function.

Invokes the function in the event loop of context. function can be a functor or a pointer to a member function. Returns true if the function could be invoked. Returns false if there is no such function or the parameters did not match. The return value of the function call is placed in ret.

Note: This function is thread-safe.

This function was introduced in Qt 5.10.

[static] bool QMetaObject::invokeMethod(QObject *context, Functorfunction, FunctorReturnType *ret)

This is an overloaded function.

Invokes the function in the event loop of context using the connection type Qt::AutoConnection. function can be a functor or a pointer to a member function. Returns true if the function could be invoked. Returns false if there is no such member or the parameters did not match. The return value of the function call is placed in ret.

Note: This function is thread-safe.

This function was introduced in Qt 5.10.

QMetaMethod QMetaObject::method(intindex) const

Returns the meta-data for the method with the given index.

See also methodCount(), methodOffset(), and indexOfMethod().

int QMetaObject::methodCount() const

Returns the number of methods in this class, including the number of methods provided by each base class. These include signals and slots as well as normal member functions.

Use code like the following to obtain a QStringList containing the methods specific to a given class:

See also method(), methodOffset(), and indexOfMethod().

int QMetaObject::methodOffset() const

Returns the method offset for this class; i.e. the index position of this class's first member function.

The offset is the sum of all the methods in the class's superclasses (which is always positive since QObject has the deleteLater() slot and a destroyed() signal).

See also method(), methodCount(), and indexOfMethod().

QObject *QMetaObject::newInstance(QGenericArgumentval0 = QGenericArgument(nullptr), QGenericArgumentval1 = QGenericArgument(), QGenericArgumentval2 = QGenericArgument(), QGenericArgumentval3 = QGenericArgument(), QGenericArgumentval4 = QGenericArgument(), QGenericArgumentval5 = QGenericArgument(), QGenericArgumentval6 = QGenericArgument(), QGenericArgumentval7 = QGenericArgument(), QGenericArgumentval8 = QGenericArgument(), QGenericArgumentval9 = QGenericArgument()) const

Constructs a new instance of this class. You can pass up to ten arguments (val0, val1, val2, val3, val4, val5, val6, val7, val8, and val9) to the constructor. Returns the new object, or 0 if no suitable constructor is available.

Note that only constructors that are declared with the Q_INVOKABLE modifier are made available through the meta-object system.

This function was introduced in Qt 4.5.

See also Q_ARG() and constructor().

[static] QByteArray QMetaObject::normalizedSignature(const char *method)

Normalizes the signature of the given method.

Qt uses normalized signatures to decide whether two given signals and slots are compatible. Normalization reduces whitespace to a minimum, moves 'const' to the front where appropriate, removes 'const' from value types and replaces const references with values.

See also checkConnectArgs() and normalizedType().

[static] QByteArray QMetaObject::normalizedType(const char *type)

Normalizes a type.

See QMetaObject::normalizedSignature() for a description on how Qt normalizes.

Example:

This function was introduced in Qt 4.2.

See also normalizedSignature().

QMetaProperty QMetaObject::property(intindex) const

Returns the meta-data for the property with the given index. If no such property exists, a null QMetaProperty is returned.

See also propertyCount(), propertyOffset(), and indexOfProperty().

int QMetaObject::propertyCount() const

Returns the number of properties in this class, including the number of properties provided by each base class.

Use code like the following to obtain a QStringList containing the properties specific to a given class:

See also property(), propertyOffset(), and indexOfProperty().

int QMetaObject::propertyOffset() const

Returns the property offset for this class; i.e. the index position of this class's first property.

Qt Slot Return Value Guide

The offset is the sum of all the properties in the class's superclasses (which is always positive since QObject has the name() property).

See also property(), propertyCount(), and indexOfProperty().

const QMetaObject *QMetaObject::superClass() const

Returns the meta-object of the superclass, or 0 if there is no such object.

See also className().

QMetaProperty QMetaObject::userProperty() const

Returns the property that has the USER flag set to true.

This function was introduced in Qt 4.2.

See also QMetaProperty::isUser().

Qt Slot Return Value Kelley Blue Book

Macro Documentation

QGenericArgumentQ_ARG(Type, const Type &value)

This macro takes a Type and a value of that type and returns a QGenericArgument object that can be passed to QMetaObject::invokeMethod().

Qt Slot Return Value

See also Q_RETURN_ARG().

QGenericReturnArgumentQ_RETURN_ARG(Type, Type &value)

This macro takes a Type and a non-const reference to a value of that type and returns a QGenericReturnArgument object that can be passed to QMetaObject::invokeMethod().

See also Q_ARG().

Qt Connect Slot Return Value

© 2020 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.