Класс QSignalSpy

Класс QSignalSpy позволяет инспектировать излучение сигналов. Подробнее...

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

Открытые функции

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

QSignalSpy может подключиться к любому сигналу любого объекта и записывает его излучение. Сам QSignalSpy представляет собой список списков QVariant. Каждое излучение сигнала будет добавлять один элемент в список, содержащий аргументы сигнала.

Следующий пример записывает все излучения сигналов для сигнала clicked() класса QCheckBox:

QCheckBox *box = ...;
QSignalSpy spy(box, SIGNAL(clicked(bool)));

// do something that triggers the signal
box->animateClick();

QCOMPARE(spy.count(), 1); // make sure the signal was emitted exactly one time
QList<QVariant> arguments = spy.takeFirst(); // take the first signal

QVERIFY(arguments.at(0).toBool() == true); // verify the first argument

spy.takeFirst() возвращает аргументы для первого излученного сигнала в виде списка объектов QVariant. Сигнал clicked() имеет один аргумент типа bool, который хранится как первый элемент в списке аргументов.

Пример ниже перехватывает сигнал от пользовательского объекта:

QSignalSpy spy(myCustomObject, SIGNAL(mySignal(int,QString,double)));

myCustomObject->doSomething(); // trigger emission of the signal

QList<QVariant> arguments = spy.takeFirst();
QVERIFY(arguments.at(0).typeId() == QMetaType::Int);
QVERIFY(arguments.at(1).typeId() == QMetaType::QString);
QVERIFY(arguments.at(2).typeId() == QMetaType::Double);

Примечание: Нестандартные типы данных необходимо зарегистрировать, используя функцию qRegisterMetaType(), прежде чем можно будет создать QSignalSpy. Например:

qRegisterMetaType<SomeStruct>();
QSignalSpy spy(&model, SIGNAL(whatever(SomeStruct)));

Для получения экземпляра можно использовать qvariant_cast:

// get the first argument from the first received signal:
SomeStruct result = qvariant_cast<SomeStruct>(spy.at(0).at(0));

Проверка излучения сигналов

Класс QSignalSpy предоставляет элегантный механизм для захвата списка сигналов, излучаемых объектом. Однако необходимо проверить его корректность после создания. Конструктор выполняет ряд проверок целостности, например, проверяет, существует ли сигнал, на который следует просматривать. Чтобы упростить диагностику ошибок в тестах, результаты этих проверок должны проверяться с помощью вызова QVERIFY(spy.isValid()) перед продолжением теста.

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

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

[since 5.14] QSignalSpy::QSignalSpy(const QObject *obj, const QMetaMethod &signal)

Создает новый QSignalSpy, который прослушивает излучения сигнала signal от объекта QObject obj. Если QSignalSpy не может прослушивать действительный сигнал (например, потому что obj является nullptr или signal не обозначает действительный сигнал obj), будет выведено сообщение об ошибке с помощью qWarning(), и последующие вызовы isValid() вернут false.

Этот конструктор удобно использовать, когда система метаобъектов Qt активно используется в тесте.

Пример использования:

QObject object;
auto mo = object.metaObject();
auto signalIndex = mo->indexOfSignal("objectNameChanged(QString)");
auto signal = mo->method(signalIndex);

QSignalSpy spy(&object, signal);
object.setObjectName("A new object name");
QCOMPARE(spy.count(), 1);

Предположим, нам нужно проверить, все ли свойства класса QWindow, представляющие минимальные и максимальные размеры, правильно записываются. Следующий пример демонстрирует один из подходов:

void tst_QWindow::writeMinMaxDimensionalProps_data()
    QTest::addColumn<int>("propertyIndex");

    // Collect all relevant properties
    static const auto mo = QWindow::staticMetaObject;
    for (int i = mo.propertyOffset(); i < mo.propertyCount(); ++i) {
        auto property = mo.property(i);

        // ...that have type int
        if (property.type() == QVariant::Int) {
            static const QRegularExpression re("^minimum|maximum");
            const auto name = property.name();

            // ...and start with "minimum" or "maximum"
            if (re.match(name).hasMatch()) {
                QTest::addRow("%s", name) << i;
            }
        }
    }
}

void tst_QWindow::writeMinMaxDimensionalProps()
{
    QFETCH(int, propertyIndex);

    auto property = QWindow::staticMetaObject.property(propertyIndex);
    QVERIFY(property.isWritable());
    QVERIFY(property.hasNotifySignal());

    QWindow window;
    QSignalSpy spy(&window, property.notifySignal());

    QVERIFY(property.write(&window, 42));
    QCOMPARE(spy.count(), 1);
}

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

[since 5.4] template <typename PointerToMemberFunction> QSignalSpy::QSignalSpy(const QObject *object, PointerToMemberFunction signal)

Создает новый QSignalSpy, который прослушивает излучения сигнала signal от объекта QObject object. Если QSignalSpy не может прослушивать действительный сигнал (например, потому что object является nullptr или signal не обозначает действительный сигнал object), будет выведено сообщение об ошибке с помощью qWarning(), и последующие вызовы isValid() вернут false.

Пример:

QSignalSpy spy(myPushButton, &QPushButton::clicked);

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

QSignalSpy::QSignalSpy(const QObject *object, const char *signal)

Создает новый QSignalSpy, который прослушивает излучения сигнала signal от объекта QObject object. Если QSignalSpy не может прослушивать действительный сигнал (например, потому что object является nullptr или signal не обозначает действительный сигнал object), будет выведено сообщение об ошибке с помощью qWarning(), и последующие вызовы isValid() вернут false.

Пример:

QSignalSpy spy(myPushButton, SIGNAL(clicked(bool)));

bool QSignalSpy::isValid() const

Возвращает true, если шпион сигнала прослушивает действительный сигнал, в противном случае — false.

QByteArray QSignalSpy::signal() const

Возвращает нормализованный сигнал, на который в настоящее время настроен шпион.

[since 5.0] bool QSignalSpy::wait(int timeout = 5000)

Запускает цикл событий, который работает до получения заданного сигнала. При необходимости цикл событий может вернуться раньше по истечении timeout (в миллисекундах).

Возвращает true , если сигнал был излучен хотя бы один раз за timeout миллисекунд, в противном случае возвращает false.

Пример:

QVERIFY(spy.wait(1000));

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