Класс 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() имеет один булевый аргумент, который хранится в качестве первого элемента в списке аргументов.

Следующий пример перехватывает сигнал от пользовательского объекта:

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

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

QList<QVariant> arguments = spy.takeFirst();
QVERIFY(arguments.at(0).type() == QVariant::Int);
QVERIFY(arguments.at(1).type() == QVariant::String);
QVERIFY(arguments.at(2).type() == QVariant::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().

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

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.

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

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

bool QSignalSpy::wait(int timeout = 5000)

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

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

Пример:

QVERIFY(spy.wait(1000));

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