QSignalSpy Class

メンバ関数ドキュメント

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

QObject object からのsignal のエミッションをリッスンする新しい QSignalSpy を構築する。QSignalSpy が有効なシグナルをリッスンできない場合（たとえば、object がnullptr であったり、signal がobject の有効なシグナルを示さない場合など）、qWarning() を使用して説明の警告メッセージが出力され、isValid() への後続の呼び出しは false を返します。

例

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

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

QObject obj からのsignal の発信をリッスンする新しい QSignalSpy を構築する。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 クラスのすべてのプロパティが適切に書き込み可能かどうかをチェックする必要があるとします。次の例は、そのアプローチの1つを示しています：

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)

QObject object からのsignal の放出をリスンする新しい QSignalSpy を構築する。QSignalSpyが有効なシグナルをリッスンできない場合（例えば、object がnullptr であったり、signal がobject の有効なシグナルを示さない場合など）、qWarning() を使用して説明の警告メッセージが出力され、isValid() への後続の呼び出しは false を返します。

例

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

[noexcept] QSignalSpy::~QSignalSpy()

デストラクタ。

[noexcept] bool QSignalSpy::isValid() const

シグナルスパイが有効なシグナルをリッスンしている場合はtrue を返し、そうでない場合は false を返します。

QByteArray QSignalSpy::signal() const

スパイが現在リッスンしている正規化シグナルを返します。

bool QSignalSpy::wait(int timeout)

これはオーバーロードされた関数で、timeout を chrono のオーバーロードに渡すのと同じです：

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

シグナルがtimeout で一度でも発せられた場合はtrue を返し、そうでない場合はfalse を返します。

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

イベントループを開始し、与えられたシグナルを受信するか、timeout が経過するか、どちらか先になるまで実行します。

timeout は有効な std::chrono::duration (std::chrono::seconds, std::chrono::milliseconds ...etc) です。

シグナルがtimeout で一度でも発せられた場合はtrue を返し、そうでない場合はfalse を返します。

例

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

この関数は Qt 6.6 で導入されました。