qtquicktest.qdoc

Go to the documentation of this file.

// Copyright (C) 2018 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
/*!
   \namespace QQuickTest
   \inheaderfile QtQuickTest
   \inmodule QtQuickTest
 
   \brief The QQuickTest namespace contains all the functions and
   macros related to Qt Quick Test.
 
   See the \l{Introduction to Qt Quick Test} for information about how to write
   Qt Quick unit tests.
 
   To link to the Qt Quick Test C++ library, see \l {Qt Quick Test C++ API}.
 
   \sa {Executing C++ Before QML Tests}
*/
 
/*!
    \macro QUICK_TEST_MAIN(name)
    \relates QQuickTest
 
    \brief Sets up the entry point for a Qt Quick Test application.
    The \a name argument uniquely identifies this set of tests.
 
    \snippet src_qmltest_qquicktest_snippet.cpp 1
 
    \note The macro assumes that your test sources are in the current
    directory, unless the \c QUICK_TEST_SOURCE_DIR environment variable is set.
 
    \sa QUICK_TEST_MAIN_WITH_SETUP(), {Running Qt Quick Tests}
 
*/
 
/*!
    \macro QUICK_TEST_MAIN_WITH_SETUP(name, QuickTestSetupClass)
    \relates QQuickTest
 
    \brief Sets up the entry point for a Qt Quick Test application.
    The \a name argument uniquely identifies this set of tests.
 
    This macro is identical to QUICK_TEST_MAIN(), except that it takes an
    additional argument \a QuickTestSetupClass, the type of a QObject-derived
    class which will be instantiated. With this class it is possible to define
    additional setup code to execute before running the QML test.
 
    \note The macro assumes that your test sources are in the current
    directory, unless the \c QUICK_TEST_SOURCE_DIR environment variable is set.
 
    The following snippet demonstrates the use of this macro:
 
    \snippet src_qmltest_qquicktest.cpp 2
 
    \sa QUICK_TEST_MAIN(), {Running Qt Quick Tests}
*/