QMetaMethod Class
La clase QMetaMethod proporciona metadatos sobre una función miembro. Más información...
| Encabezado: | #include <QMetaMethod> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Core) target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
Comparaciones de QMetaMethod
| Categoría | Tipos comparables |
|---|---|
| igualdad | QMetaMethod |
Tipos públicos
| enum | Access { Private, Protected, Public } |
| enum | MethodType { Method, Signal, Slot, Constructor } |
Funciones públicas
| QMetaMethod::Access | access() const |
(since 6.5) bool | invoke(QObject *obj, Args &&... arguments) const |
(since 6.5) bool | invoke(QObject *obj, QTemplatedMetaMethodReturnArgument<ReturnArg> ret, Args &&... arguments) const |
(since 6.5) bool | invoke(QObject *obj, Qt::ConnectionType type, Args &&... arguments) const |
(since 6.5) bool | invoke(QObject *obj, Qt::ConnectionType type, QTemplatedMetaMethodReturnArgument<ReturnArg> ret, Args &&... arguments) const |
(since 6.5) bool | invokeOnGadget(void *gadget, Args &&... arguments) const |
(since 6.5) bool | invokeOnGadget(void *gadget, QTemplatedMetaMethodReturnArgument<ReturnArg> ret, Args &&... arguments) const |
(since 6.2) bool | isConst() const |
| bool | isValid() const |
| int | methodIndex() const |
| QByteArray | methodSignature() const |
| QMetaMethod::MethodType | methodType() const |
| QByteArray | name() const |
(since 6.9) QByteArrayView | nameView() const |
| int | parameterCount() const |
(since 6.0) QMetaType | parameterMetaType(int index) const |
| QList<QByteArray> | parameterNames() const |
| int | parameterType(int index) const |
(since 6.0) QByteArray | parameterTypeName(int index) const |
| QList<QByteArray> | parameterTypes() const |
(since 6.0) int | relativeMethodIndex() const |
(since 6.0) QMetaType | returnMetaType() const |
| int | returnType() const |
| int | revision() const |
| const char * | tag() const |
| const char * | typeName() const |
Miembros públicos estáticos
| QMetaMethod | fromSignal(PointerToMemberFunction signal) |
Elementos no miembros relacionados
| bool | operator!=(const QMetaMethod &lhs, const QMetaMethod &rhs) |
| bool | operator==(const QMetaMethod &lhs, const QMetaMethod &rhs) |
Macros
(until 6.13) | Q_METAMETHOD_INVOKE_MAX_ARGS |
Descripción detallada
Un QMetaMethod tiene un « methodType » (), un « methodSignature » (), una lista de « parameterTypes » () y « parameterNames » (), un «return typeName » (), un « tag » () y un especificador « access » (). Puedes utilizar « invoke » () para invocar el método en un « QObject » arbitrario.
Véase también QMetaObject, QMetaEnum, QMetaProperty y el sistema de propiedades de Qt.
Documentación sobre tipos de miembros
enum QMetaMethod::Access
Esta enumeración describe el nivel de acceso de un método, siguiendo las convenciones utilizadas en C++.
| Constante | Valor |
|---|---|
QMetaMethod::Private | 0 |
QMetaMethod::Protected | 1 |
QMetaMethod::Public | 2 |
enum QMetaMethod::MethodType
| Constante | Valor | Descripción |
|---|---|---|
QMetaMethod::Method | QMETHOD_CODE | La función es una función miembro simple. |
QMetaMethod::Signal | 1 | La función es una señal. |
QMetaMethod::Slot | 2 | La función es una ranura. |
QMetaMethod::Constructor | 3 | La función es un constructor. |
Documentación de la función miembro
QMetaMethod::Access QMetaMethod::access() const
Devuelve la especificación de acceso de este método (privado, protegido o público).
Nota: Las señales son siempre públicas, pero debes considerar esto como un detalle de implementación. Casi siempre es una mala idea emitir una señal desde fuera de su clase.
Véase también methodType().
[static] template <typename PointerToMemberFunction> QMetaMethod QMetaMethod::fromSignal(PointerToMemberFunction signal)
Devuelve el metamétodo que corresponde al signal dado, o un QMetaMethod no válido si signal es nullptr o no es una señal de la clase.
Ejemplo:
QMetaMethod destroyedSignal = QMetaMethod::fromSignal(&QObject::destroyed);[since 6.5] template <typename... Args> bool QMetaMethod::invoke(QObject *obj, Args &&... arguments) const
[since 6.5] template <typename ReturnArg, typename... Args> bool QMetaMethod::invoke(QObject *obj, QTemplatedMetaMethodReturnArgument<ReturnArg> ret, Args &&... arguments) const
[since 6.5] template <typename... Args> bool QMetaMethod::invoke(QObject *obj, Qt::ConnectionType type, Args &&... arguments) const
[since 6.5] template <typename ReturnArg, typename... Args> bool QMetaMethod::invoke(QObject *obj, Qt::ConnectionType type, QTemplatedMetaMethodReturnArgument<ReturnArg> ret, Args &&... arguments) const
Invoca este método en el objeto ` object`. Devuelve ` true ` si se ha podido invocar el miembro. Devuelve ` false ` si no existe dicho miembro o si los parámetros no coinciden.
En el caso de las sobrecargas con un parámetro `QTemplatedMetaMethodReturnArgument`, el valor de retorno de la llamada a la función ` member ` se asigna a ` ret`. En el caso de las sobrecargas que no cuentan con dicho miembro, el valor de retorno de la función llamada (si lo hay) se descartará. `QTemplatedMetaMethodReturnArgument` es un tipo interno que no debes utilizar directamente. En su lugar, utiliza la función `qReturnArg()`.
Las sobrecargas con un parámetro Qt::ConnectionType type permiten seleccionar explícitamente si la invocación será sincrónica o no:
- Si type es Qt::DirectConnection, el miembro se invocará inmediatamente en el hilo actual.
- Si type es Qt::QueuedConnection, se enviará un QEvent y el miembro se invocará tan pronto como la aplicación entre en el bucle de eventos del hilo en el que se creó o al que se trasladó el obj.
- Si type es Qt::BlockingQueuedConnection, el método se invocará de la misma forma que en el caso de Qt::QueuedConnection, salvo que el hilo actual se bloqueará hasta que se entregue el evento. El uso de este tipo de conexión para la comunicación entre objetos en el mismo hilo provocará interbloqueos.
- Si type es Qt::AutoConnection, el miembro se invoca de forma sincrónica si obj reside en el mismo hilo que el llamante; de lo contrario, se invocará de forma asincrónica. Este es el comportamiento de las sobrecargas que no tienen el parámetro type.
Para invocar de forma asíncrona la ranura animateClick() en un QPushButton:
int methodIndex = pushButton->metaObject()->indexOfMethod("animateClick()");
QMetaMethod method = metaObject->method(methodIndex);
method.invoke(pushButton, Qt::QueuedConnection);En las invocaciones asíncronas de métodos, los parámetros deben ser tipos copiables, ya que Qt necesita copiar los argumentos para almacenarlos en un evento en segundo plano. Desde Qt 6.5, esta función registra automáticamente los tipos que se utilizan; sin embargo, como efecto secundario, no es posible realizar llamadas utilizando tipos que solo estén declarados de forma anticipada. Además, tampoco es posible realizar llamadas asíncronas que utilicen referencias a tipos no calificados como const como parámetros.
Para invocar de forma sincrónica la ranura « compute(QString, int, double) » en un objeto arbitrario obj y recuperar su valor de retorno:
QString retVal;
QByteArray normalizedSignature = QMetaObject::normalizedSignature("compute(QString, int, double)");
int methodIndex = obj->metaObject()->indexOfMethod(normalizedSignature);
QMetaMethod method = obj->metaObject()->method(methodIndex);
method.invoke(obj, Qt::DirectConnection, qReturnArg(retVal),
QString("sqrt"), 42, 9.7);Si la ranura «compute» no admite exactamente un ` QString`, un ` int` y un ` double ` en el orden especificado, la llamada fallará. Fíjate en que era necesario especificar explícitamente el tipo de QString, ya que el literal de carácter no es exactamente el tipo adecuado para la coincidencia. Si, en cambio, el método aceptara un QByteArray, un qint64 y un long double, la llamada debería escribirse así:
QString retVal;
QByteArray normalizedSignature = QMetaObject::normalizedSignature("compute(QByteArray, qint64, long double)");
int methodIndex = obj->metaObject()->indexOfMethod(normalizedSignature);
QMetaMethod method = obj->metaObject()->method(methodIndex);
method.invoke(obj, Qt::DirectConnection, qReturnArg(retVal),
QByteArray("sqrt"), qint64(42), 9.7L);La misma llamada se puede ejecutar utilizando las macros Q_ARG() y Q_RETURN_ARG(), como se muestra a continuación:
QString retVal;
QByteArray normalizedSignature = QMetaObject::normalizedSignature("compute(QString, int, double)");
int methodIndex = obj->metaObject()->indexOfMethod(normalizedSignature);
QMetaMethod method = obj->metaObject()->method(methodIndex);
method.invoke(obj,
Qt::DirectConnection,
Q_RETURN_ARG(QString, retVal),
Q_ARG(QString, "sqrt"),
Q_ARG(int, 42),
Q_ARG(double, 9.7));Advertencia: este método no comprueba la validez de los argumentos: ` object ` debe ser una instancia de la clase del ` QMetaObject ` con el que se ha construido este ` QMetaMethod `.
Estas funciones se introdujeron en Qt 6.5.
Véanse también Q_ARG(), Q_RETURN_ARG(), qRegisterMetaType() y QMetaObject::invokeMethod().
[since 6.5] template <typename... Args> bool QMetaMethod::invokeOnGadget(void *gadget, Args &&... arguments) const
[since 6.5] template <typename ReturnArg, typename... Args> bool QMetaMethod::invokeOnGadget(void *gadget, QTemplatedMetaMethodReturnArgument<ReturnArg> ret, Args &&... arguments) const
Invoca este método en un objeto ` Q_GADGET`. Devuelve ` true ` si se ha podido invocar el miembro. Devuelve ` false ` si no existe dicho miembro o si los parámetros no coinciden.
El puntero gadget debe apuntar a una instancia de la clase de gadget.
La invocación es siempre síncrona.
En el caso de la sobrecarga con un parámetro `QTemplatedMetaMethodReturnArgument`, el valor de retorno de la llamada a la función ` member ` se almacena en ` ret`. En el caso de la sobrecarga sin dicho parámetro, el valor de retorno de la función llamada (si lo hay) se descartará. `QTemplatedMetaMethodReturnArgument` es un tipo interno que no debes utilizar directamente. En su lugar, utiliza la función `qReturnArg()`.
Advertencia: este método no comprueba la validez de los argumentos: ` gadget ` debe ser una instancia de la clase de ` QMetaObject ` con la que se ha construido este ` QMetaMethod `.
Estas funciones se introdujeron en Qt 6.5.
Véanse también Q_ARG(), Q_RETURN_ARG(), qRegisterMetaType() y QMetaObject::invokeMethod().
[since 6.2] bool QMetaMethod::isConst() const
Devuelve si el método está calificado como `const`.
Nota: Este método podría devolver erróneamente « false » para un método «const» si pertenece a una biblioteca compilada con una versión anterior de Qt.
Esta función se introdujo en Qt 6.2.
bool QMetaMethod::isValid() const
Devuelve ` true ` si este método es válido (se puede inspeccionar e invocar); en caso contrario, devuelve ` false`.
int QMetaMethod::methodIndex() const
Devuelve el índice de este método.
QByteArray QMetaMethod::methodSignature() const
Devuelve la firma de este método (por ejemplo, setValue(double)).
Véanse también parameterTypes() y parameterNames().
QMetaMethod::MethodType QMetaMethod::methodType() const
Devuelve el tipo de este método (señal, ranura o método).
Véase también ` access()`.
QByteArray QMetaMethod::name() const
Devuelve el nombre de este método.
Véase también methodSignature() y parameterCount().
[since 6.9] QByteArrayView QMetaMethod::nameView() const
Devuelve el nombre de este método. El objeto ` QByteArrayView ` devuelto es válido siempre y cuando sea válido el metaobjeto de la clase a la que pertenece el método.
Esta función se introdujo en Qt 6.9.
Véase también name.
int QMetaMethod::parameterCount() const
Devuelve el número de parámetros de este método.
Véase también parameterType() y parameterNames().
[since 6.0] QMetaType QMetaMethod::parameterMetaType(int index) const
Devuelve el metatipo del parámetro en la dirección index indicada.
Si el index es menor que cero o mayor que parameterCount(), se devuelve un QMetaType no válido.
Esta función se introdujo en Qt 6.0.
Véase también parameterCount(), returnMetaType() y QMetaType.
QList<QByteArray> QMetaMethod::parameterNames() const
Devuelve una lista con los nombres de los parámetros.
Véase también parameterTypes() y methodSignature().
int QMetaMethod::parameterType(int index) const
Devuelve el tipo del parámetro en la dirección index indicada.
El valor devuelto es uno de los tipos registrados en QMetaType, o bien QMetaType::UnknownType si el tipo no está registrado.
Véase también parameterCount(), parameterMetaType(), returnType() y QMetaType.
[since 6.0] QByteArray QMetaMethod::parameterTypeName(int index) const
Devuelve el nombre del tipo en la posición index. Si no hay ningún parámetro en index, devuelve un QByteArray
Esta función se introdujo en Qt 6.0.
Véase también parameterNames().
QList<QByteArray> QMetaMethod::parameterTypes() const
Devuelve una lista de tipos de parámetros.
Véase también parameterNames() y methodSignature().
[since 6.0] int QMetaMethod::relativeMethodIndex() const
Devuelve el índice local de este método.
Esta función se introdujo en Qt 6.0.
[since 6.0] QMetaType QMetaMethod::returnMetaType() const
Devuelve el tipo de retorno de este método.
Esta función se introdujo en Qt 6.0.
Véase también parameterMetaType(), QMetaType y typeName().
int QMetaMethod::returnType() const
Devuelve el tipo de retorno de este método.
El valor devuelto es uno de los tipos registrados en QMetaType, o en QMetaType::UnknownType si el tipo no está registrado.
Véase también parameterType(), QMetaType, typeName() y returnMetaType().
int QMetaMethod::revision() const
Devuelve la revisión del método si se ha especificado alguna mediante ` Q_REVISION`; en caso contrario, devuelve 0. Desde Qt 6.0, los valores distintos de cero se codifican y pueden descodificarse mediante ` QTypeRevision::fromEncodedVersion()`.
const char *QMetaMethod::tag() const
Devuelve la etiqueta asociada a este método.
Las etiquetas son macros especiales reconocidas por moc que permiten añadir información adicional sobre un método.
La información de la etiqueta se puede añadir de la siguiente manera en la declaración de la función:
// In the class MainWindow declaration
#ifndef Q_MOC_RUN
// define the tag text as empty, so the compiler doesn't see it
# define MY_CUSTOM_TAG
#endif
//...
private slots:
MY_CUSTOM_TAG void testFunc();y se puede acceder a dicha información utilizando:
MainWindow win;
win.show();
int functionIndex = win.metaObject()->indexOfSlot("testFunc()");
QMetaMethod mm = win.metaObject()->method(functionIndex);
qDebug() << mm.tag(); // prints MY_CUSTOM_TAGPor el momento, « moc » extraerá y registrará todas las etiquetas, pero no las tratará de forma especial. Puedes utilizar las etiquetas para anotar tus métodos de forma diferente y tratarlos según las necesidades específicas de tu aplicación.
Nota: moc expande las macros del preprocesador, por lo que es necesario rodear la definición con #ifndef Q_MOC_RUN , tal y como se muestra en el ejemplo anterior.
const char *QMetaMethod::typeName() const
Devuelve el nombre del tipo de retorno de este método. Si este método es un constructor, esta función devuelve una cadena vacía (los constructores no tienen tipos de retorno).
Nota: En Qt 7, esta función devolverá un puntero nulo para los constructores.
Véase también returnType() y QMetaType::name().
Elementos no miembros relacionados
[noexcept] bool operator!=(const QMetaMethod &lhs, const QMetaMethod &rhs)
Devuelve ` true ` si el método ` lhs ` no es igual al método ` rhs`; en caso contrario, devuelve ` false`.
[noexcept] bool operator==(const QMetaMethod &lhs, const QMetaMethod &rhs)
Devuelve « true » si el método « lhs » es igual al método « rhs »; en caso contrario, devuelve « false ».
Documentación de macros
[until 6.13] Q_METAMETHOD_INVOKE_MAX_ARGS
Está previsto que esta macro quede obsoleta en la versión 6.13.
Equivale al número máximo de argumentos disponibles para la ejecución del método mediante la antigua implementación de ` QMetaMethod::invoke()`. La nueva implementación (a partir de Qt 6.5) utiliza argumentos variádicos y no tiene un límite máximo.
© 2026 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.