Класс QMetaMethod

Класс QMetaMethod предоставляет метаданные о членной функции. Подробнее...

• Список всех членов, включая унаследованные

Типы public

Функции public

Статические члены public

Связанные внешние члены

Макросы

Подробное описание

У QMetaMethod есть methodType(), methodSignature(), список parameterTypes() и parameterNames(), возвращаемый typeName(), tag() и спецификатор доступа access(). Вы можете использовать invoke() для вызова метода на произвольном QObject.

См. также QMetaObject, QMetaEnum, QMetaProperty и Систему свойств Qt.

Документация по типам членов

Перечисление QMetaMethod::Access

Это перечисление описывает уровень доступа к методу, следуя соглашениям, используемым в C++.

Перечисление QMetaMethod::MethodType

Документация по функциям-членам

QMetaMethod::Access QMetaMethod::access() const

Возвращает спецификацию доступа к этому методу (private, protected или public).

Примечание: Сигналы всегда публичные, но это следует рассматривать как деталь реализации. Практически всегда плохая идея излучать сигнал извне своего класса.

См. также methodType().

[static] QMetaMethod QMetaMethod::fromSignal(PointerToMemberFunction signal)

Возвращает мета-метод, соответствующий заданному сигналу, или недействительный QMetaMethod, если сигнал не является сигналом класса.

Пример:

QMetaMethod destroyedSignal = QMetaMethod::fromSignal(&QObject::destroyed);

Данная функция была добавлена в Qt 5.0.

bool QMetaMethod::invoke(QObject *object, Qt::ConnectionType connectionType, QGenericReturnArgument returnValue, QGenericArgument val0 = QGenericArgument(nullptr), QGenericArgument val1 = QGenericArgument(), QGenericArgument val2 = QGenericArgument(), QGenericArgument val3 = QGenericArgument(), QGenericArgument val4 = QGenericArgument(), QGenericArgument val5 = QGenericArgument(), QGenericArgument val6 = QGenericArgument(), QGenericArgument val7 = QGenericArgument(), QGenericArgument val8 = QGenericArgument(), QGenericArgument val9 = QGenericArgument()) const

Вызывает данный метод для объекта object. Возвращает true если член можно вызвать. Возвращает false если такого члена нет или параметры не соответствуют.

Вызов может быть синхронным или асинхронным, в зависимости от connectionType:

• Если connectionType равен Qt::DirectConnection, член будет вызван немедленно.
• Если connectionType равен Qt::QueuedConnection, будет отправлен QEvent, и член вызывается, как только приложение войдёт в основной цикл обработки событий.
• Если connectionType равен Qt::AutoConnection, член вызывается синхронно, если object находится в том же потоке, что и вызывающий код; в противном случае член вызывается асинхронно.

Значение возвращаемого результата вызова метода помещается в returnValue. Если вызов является асинхронным, значение возвращаемого результата не может быть вычислено. Вы можете передать до десяти аргументов (val0, val1, val2, val3, val4, val5, val6, val7, val8, и val9) в этот вызов метода.

QGenericArgument и QGenericReturnArgument являются внутренними вспомогательными классами. Поскольку сигналы и слоты могут вызываться динамически, вы должны заключить аргументы в макросы Q_ARG() и Q_RETURN_ARG(). Q_ARG() принимает имя типа и константную ссылку на этот тип; Q_RETURN_ARG() принимает имя типа и неконстантную ссылку.

Чтобы асинхронно вызвать слот animateClick() для QPushButton:

int methodIndex = pushButton->metaObject()->indexOfMethod("animateClick()");
QMetaMethod method = metaObject->method(methodIndex);
method.invoke(pushButton, Qt::QueuedConnection);

При асинхронных вызовах методов параметры должны быть типов, которые известны системе метаобъектов Qt, так как Qt нужно скопировать аргументы для их хранения в событии за кулисами. Если вы попробуете использовать очереди для соединения и получите сообщение об ошибке

QMetaMethod::invoke: Unable to handle unregistered datatype 'MyType'

вызовите qRegisterMetaType(), чтобы зарегистрировать тип данных перед вызовом QMetaMethod::invoke().

Чтобы синхронно вызвать слот compute(QString, int, double) для произвольного объекта obj и получить его возвращаемое значение:

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));

QMetaObject::normalizedSignature() используется здесь, чтобы убедиться, что формат подписи — тот, который ожидает invoke(). Например, лишние пробелы удаляются.

Если слот «compute» не принимает ровно один QString, одно целое число и одно число с плавающей точкой в указанном порядке, вызов завершится ошибкой.

Предупреждение: этот метод не проверяет корректность аргументов: object должен быть экземпляром класса метаобъекта QMetaObject, с которым был создан этот QMetaMethod. Аргументы должны иметь тот же тип, что и ожидаемые методом, иначе поведение не определено.

См. также Q_ARG(), Q_RETURN_ARG(), qRegisterMetaType(), и QMetaObject::invokeMethod().

bool QMetaMethod::invoke(QObject *object, QGenericReturnArgument returnValue, QGenericArgument val0 = ..., QGenericArgument val1 = ..., QGenericArgument val2 = ..., QGenericArgument val3 = ..., QGenericArgument val4 = ..., QGenericArgument val5 = ..., QGenericArgument val6 = ..., QGenericArgument val7 = ..., QGenericArgument val8 = ..., QGenericArgument val9 = ...) const

Эта функция перегружает invoke().

Эта перегрузка всегда вызывает этот метод с помощью типа соединения Qt::AutoConnection.

bool QMetaMethod::invoke(QObject *object, Qt::ConnectionType connectionType, QGenericArgument val0 = ..., QGenericArgument val1 = ..., QGenericArgument val2 = ..., QGenericArgument val3 = ..., QGenericArgument val4 = ..., QGenericArgument val5 = ..., QGenericArgument val6 = ..., QGenericArgument val7 = ..., QGenericArgument val8 = ..., QGenericArgument val9 = ...) const

Эта функция перегружает invoke().

Эта перегрузка может использоваться, если возвращаемое значение члена не представляет интереса.

bool QMetaMethod::invoke(QObject *object, QGenericArgument val0 = ..., QGenericArgument val1 = ..., QGenericArgument val2 = ..., QGenericArgument val3 = ..., QGenericArgument val4 = ..., QGenericArgument val5 = ..., QGenericArgument val6 = ..., QGenericArgument val7 = ..., QGenericArgument val8 = ..., QGenericArgument val9 = ...) const

Эта функция перегружает invoke().

Эта перегрузка вызывает этот метод с типом соединения Qt::AutoConnection и игнорирует возвращаемые значения.

bool QMetaMethod::invokeOnGadget(void *gadget, QGenericReturnArgument returnValue, QGenericArgument val0 = QGenericArgument(nullptr), QGenericArgument val1 = QGenericArgument(), QGenericArgument val2 = QGenericArgument(), QGenericArgument val3 = QGenericArgument(), QGenericArgument val4 = QGenericArgument(), QGenericArgument val5 = QGenericArgument(), QGenericArgument val6 = QGenericArgument(), QGenericArgument val7 = QGenericArgument(), QGenericArgument val8 = QGenericArgument(), QGenericArgument val9 = QGenericArgument()) const

Вызывает данный метод для Q_GADGET. Возвращает true если член можно вызвать. Возвращает false если такого члена нет или параметры не соответствуют.

Указатель gadget должен указывать на экземпляр класса гаджета.

Вызов всегда синхронный.

Значение возвращаемого результата вызова метода помещается в returnValue. Вы можете передать до десяти аргументов (val0, val1, val2, val3, val4, val5, val6, val7, val8, и val9) в этот вызов метода.

Предупреждение: этот метод не проверяет корректность аргументов: gadget должен быть экземпляром класса метаобъекта QMetaObject, с которым был создан этот QMetaMethod. Аргументы должны иметь тот же тип, что и ожидаемые методом, иначе поведение не определено.

Эта функция была добавлена в Qt 5.5.

См. также Q_ARG(), Q_RETURN_ARG(), qRegisterMetaType() и QMetaObject::invokeMethod().

bool QMetaMethod::invokeOnGadget(void *gadget, QGenericArgument val0 = ..., QGenericArgument val1 = ..., QGenericArgument val2 = ..., QGenericArgument val3 = ..., QGenericArgument val4 = ..., QGenericArgument val5 = ..., QGenericArgument val6 = ..., QGenericArgument val7 = ..., QGenericArgument val8 = ..., QGenericArgument val9 = ...) const

Это перегруженный метод.

Этот перегруз вызывает этот метод для gadget и игнорирует возвращаемые значения.

Эта функция была добавлена в Qt 5.5.

bool QMetaMethod::isValid() const

Возвращает true если этот метод валиден (можно инспектировать и вызывать), в противном случае возвращает false.

Эта функция была добавлена в Qt 5.0.

int QMetaMethod::methodIndex() const

Возвращает индекс этого метода.

Эта функция была добавлена в Qt 4.6.

QByteArray QMetaMethod::methodSignature() const

Возвращает сигнатуру этого метода (например, setValue(double)).

Эта функция была добавлена в Qt 5.0.

См. также parameterTypes() и parameterNames().

QMetaMethod::MethodType QMetaMethod::methodType() const

Возвращает тип этого метода (сигнал, слот или метод).

См. также access().

QByteArray QMetaMethod::name() const

Возвращает имя этого метода.

Эта функция была добавлена в Qt 5.0.

См. также methodSignature() и parameterCount().

int QMetaMethod::parameterCount() const

Возвращает количество параметров этого метода.

Эта функция была добавлена в Qt 5.0.

См. также parameterType() и parameterNames().

QList<QByteArray> QMetaMethod::parameterNames() const

Возвращает список имён параметров.

См. также parameterTypes() и methodSignature().

int QMetaMethod::parameterType(int index) const

Возвращает тип параметра по заданному index.

Возвращаемое значение — один из типов, зарегистрированных с помощью QMetaType, или QMetaType::UnknownType, если тип не зарегистрирован.

Эта функция была добавлена в Qt 5.0.

См. также parameterCount(), returnType() и QMetaType.

QList<QByteArray> QMetaMethod::parameterTypes() const

Возвращает список типов параметров.

См. также parameterNames() и methodSignature().

int QMetaMethod::returnType() const

Возвращает тип возвращаемого значения этого метода.

Возвращаемое значение — один из типов, зарегистрированных с помощью QMetaType, или QMetaType::UnknownType, если тип не зарегистрирован.

Эта функция была добавлена в Qt 5.0.

См. также parameterType(), QMetaType и typeName().

int QMetaMethod::revision() const

Возвращает версию метода, если она была указана с помощью Q_REVISION, в противном случае возвращает 0.

Эта функция была добавлена в Qt 5.1.

const char *QMetaMethod::tag() const

Возвращает тег, связанный с этим методом.

Теги — это специальные макросы, распознаваемые moc , которые позволяют добавлять дополнительную информацию о методе.

Информация о теге может быть добавлена в объявлении функции следующим образом:

    // 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();

и информация может быть получена с помощью:

    MainWindow win;
    win.show();

    int functionIndex = win.metaObject()->indexOfSlot("testFunc()");
    QMetaMethod mm = win.metaObject()->method(functionIndex);
    qDebug() << mm.tag(); // prints MY_CUSTOM_TAG

В настоящее время moc извлечёт и запишет все теги, но не обработает их специально. Вы можете использовать теги для разного аннотирования ваших методов и обработки их в соответствии со специфическими потребностями вашего приложения.

Примечание: Начиная с Qt 5.0, moc расширяет макросы препроцессора, поэтому необходимо заключить определение в #ifndef Q_MOC_RUN, как показано в примере выше. Это не требовалось в Qt 4. Приведенный выше код также работает с Qt 4.

const char *QMetaMethod::typeName() const

Возвращает имя типа возвращаемого значения этого метода.

См. также returnType() и QMetaType::type().