QQuickTest Namespace

Function Documentation

bool QQuickTest::qIsPolishScheduled(const QQuickItem *item)

Returns true if updatePolish() has not been called on item since the last call to polish(), otherwise returns false.

When assigning values to properties in QML, any layouting the item must do as a result of the assignment might not take effect immediately, but can instead be postponed until the item is polished. For these cases, you can use this function to ensure that the item has been polished before the execution of the test continues. For example:

 QVERIFY(QQuickTest::qIsPolishScheduled(item));
 QVERIFY(QQuickTest::qWaitForItemPolished(item));

Without the call to qIsPolishScheduled() above, the call to qWaitForItemPolished() might see that no polish was scheduled and therefore pass instantly, assuming that the item had already been polished. This function makes it obvious why an item wasn't polished and allows tests to fail early under such circumstances.

The QML equivalent of this function is isPolishScheduled().

See also QQuickItem::polish() and QQuickItem::updatePolish().

[since 6.4] bool QQuickTest::qIsPolishScheduled(const QQuickWindow *window)

This function overloads qIsPolishScheduled().

Returns true if there are any items managed by this window for which qIsPolishScheduled(item) returns true, otherwise returns false.

For example, if an item somewhere within the scene may or may not be polished, but you need to wait for it if it is, you can use the following code:

 if (QQuickTest::qIsPolishScheduled(window))
     QVERIFY(QQuickTest::qWaitForPolish(window));

The QML equivalent of this function is isPolishScheduled().

This function was introduced in Qt 6.4.

See also QQuickItem::polish(), QQuickItem::updatePolish(), and QQuickTest::qWaitForPolish().

[since 6.4] bool QQuickTest::qWaitForPolish(const QQuickItem *item, int timeout = defaultTimeout)

Waits for timeout milliseconds or until updatePolish() has been called on item.

Returns true if updatePolish() was called on item within timeout milliseconds, otherwise returns false.

This function was introduced in Qt 6.4.

See also QQuickItem::polish(), QQuickItem::updatePolish(), and QQuickTest::qIsPolishScheduled().

[since 6.4] bool QQuickTest::qWaitForPolish(const QQuickWindow *window, int timeout = defaultTimeout)

Waits for timeout milliseconds or until qIsPolishScheduled(item) returns false for all items managed by window.

Returns true if qIsPolishScheduled(item) returns false for all items within timeout milliseconds, otherwise returns false.

The QML equivalent of this function is waitForPolish().

This function was introduced in Qt 6.4.

See also QQuickItem::polish(), QQuickItem::updatePolish(), and QQuickTest::qIsPolishScheduled().

 #include <QtQuickTest>
 QUICK_TEST_MAIN(example)

 // src_qmltest_qquicktest.cpp
 #include <QtQuickTest>
 #include <QQmlEngine>
 #include <QQmlContext>
 #include <QGuiApplication>

 class Setup : public QObject
 {
     Q_OBJECT

 public:
     Setup() {}

 public slots:
     void applicationAvailable()
     {
         // Initialization that only requires the QGuiApplication object to be available
     }

     void qmlEngineAvailable(QQmlEngine *engine)
     {
         // Initialization requiring the QQmlEngine to be constructed
         engine->rootContext()->setContextProperty("myContextProperty", QVariant(true));
     }

     void cleanupTestCase()
     {
         // Implement custom resource cleanup
     }
 };

 QUICK_TEST_MAIN_WITH_SETUP(mytest, Setup)

 #include "src_qmltest_qquicktest.moc"