QSignalSpy Class

Documentación de las funciones miembro

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

Construye un nuevo QSignalSpy que escucha las emisiones del signal desde el QObject object . Si QSignalSpy no es capaz de escuchar una señal válida (por ejemplo, porque object es nullptr o signal no denota una señal válida de object), se emitirá un mensaje de advertencia explicativo usando qWarning() y las llamadas posteriores a isValid() devolverán false.

Ejemplo:

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

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

Construye un nuevo QSignalSpy que escucha las emisiones del signal desde el QObject obj . Si QSignalSpy no es capaz de escuchar una señal válida (por ejemplo, porque obj es nullptr o signal no denota una señal válida de obj), se emitirá un mensaje de advertencia explicativo usando qWarning() y las llamadas posteriores a isValid() devolverán false.

Es conveniente utilizar este constructor cuando el sistema de meta-objetos de Qt se utiliza mucho en un test.

Ejemplo básico de uso:

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

Imaginemos que necesitamos comprobar si todas las propiedades de la clase QWindow que representan las dimensiones mínima y máxima se pueden escribir correctamente. El siguiente ejemplo demuestra uno de los enfoques:

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)

Construye un nuevo QSignalSpy que escucha las emisiones del signal desde el QObject object . Si QSignalSpy no es capaz de escuchar una señal válida (por ejemplo, porque object es nullptr o signal no denota una señal válida de object), se emitirá un mensaje de advertencia explicativo usando qWarning() y las llamadas posteriores a isValid() devolverán false.

Ejemplo:

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

[noexcept] QSignalSpy::~QSignalSpy()

Destructor.

[noexcept] bool QSignalSpy::isValid() const

Devuelve true si el espía de señales escucha una señal válida, en caso contrario false.

QByteArray QSignalSpy::signal() const

Devuelve la señal normalizada que el espía está escuchando actualmente.

bool QSignalSpy::wait(int timeout)

Esta es una función sobrecargada, equivalente a pasar timeout a la sobrecarga chrono:

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

Devuelve true si la señal se emitió al menos una vez en timeout, en caso contrario devuelve false.

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

Inicia un bucle de eventos que se ejecuta hasta que se recibe la señal dada o timeout ha pasado, lo que ocurra primero.

timeout es cualquier duración válida de std::chrono::duration (std::chrono::seconds, std::chrono::milliseconds ...etc).

Devuelve true si la señal se emitió al menos una vez en timeout, en caso contrario devuelve false.

Ejemplo:

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

Esta función se introdujo en Qt 6.6.