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 クラスの最小および最大寸法を表すすべてのプロパティが正しく書き込み可能かどうかを確認する必要があると仮定します。以下の例は、そのアプローチの一例を示しています：

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 の期間中にシグナルが少なくとも1回発せられた場合は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 など）です。

timeout の間にシグナルが少なくとも1回発信された場合はtrue を返し、そうでない場合はfalse を返します。

例：

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

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