QSignalSpy Class

Documentation des fonctions membres

template <typename PointerToMemberFunction> QSignalSpy::QSignalSpy(const QObject *object, PointerToMemberFunction signal)

Construit un nouveau QSignalSpy qui écoute les émissions de signal à partir de QObject object . Si QSignalSpy n'est pas en mesure d'écouter un signal valide (par exemple, parce que object est nullptr ou signal ne dénote pas un signal valide de object), un message d'avertissement explicatif sera émis à l'aide de qWarning() et les appels ultérieurs à isValid() renverront un message faux.

Exemple :

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

QSignalSpy::QSignalSpy(const QObject *obj, QMetaMethod signal)

Construit un nouveau QSignalSpy qui écoute les émissions de signal à partir de QObject obj . Si QSignalSpy n'est pas capable d'écouter un signal valide (par exemple, parce que obj est nullptr ou signal ne dénote pas un signal valide de obj), un message d'avertissement explicatif sera émis en utilisant qWarning() et les appels ultérieurs à isValid() renverront false.

Ce constructeur est pratique à utiliser lorsque le système de méta-objets de Qt Test est fortement utilisé dans un test.

Exemple d'utilisation basique :

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

Imaginons que nous devions vérifier si toutes les propriétés de la classe QWindow qui représentent les dimensions minimales et maximales sont correctement accessibles en écriture. L'exemple suivant illustre l'une des approches possibles :

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

[explicit] QSignalSpy::QSignalSpy(const QObject *object, const char *signal)

Construit un nouveau QSignalSpy qui écoute les émissions de signal à partir de QObject object . Si QSignalSpy n'est pas en mesure d'écouter un signal valide (par exemple, parce que object est nullptr ou signal ne dénote pas un signal valide de object), un message d'avertissement explicatif sera émis à l'aide de qWarning() et les appels ultérieurs à isValid() renverront un message faux.

Exemple :

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

[noexcept] QSignalSpy::~QSignalSpy()

Destructeur.

[noexcept] bool QSignalSpy::isValid() const

Retourne true si l'espion de signal écoute un signal valide, sinon false.

QByteArray QSignalSpy::signal() const

Renvoie le signal normalisé que l'espion est en train d'écouter.

bool QSignalSpy::wait(int timeout)

Il s'agit d'une fonction surchargée, équivalente à la transmission de timeout à la surcharge chrono :

wait(std::chrono::milliseconds{timeout});

renvoie true si le signal a été émis au moins une fois dans timeout, sinon renvoie false.

[since 6.6] bool QSignalSpy::wait(std::chrono::milliseconds timeout = std::chrono::seconds{5})

Démarre une boucle événementielle qui s'exécute jusqu'à ce que le signal donné soit reçu ou que timeout se soit écoulé, selon ce qui se produit en premier.

timeout est n'importe quelle std::chrono::durée valide (std::chrono::secondes, std::chrono::millisecondes ...etc).

Retourne true si le signal a été émis au moins une fois dans timeout, sinon retourne false.

Exemple :

using namespace std::chrono_literals;
QSignalSpy spy(object, signal);
spy.wait(2s);

Cette fonction a été introduite dans Qt 6.6.