Creating a QtUiTest Test Widget

Test widget class

Each test widget class needs to inherit from QObject and the relevant test widget interfaces.

In practice, it is common for a test widget class hierarchy to be written which closely mirrors the wrapped widget class hierarchy. This makes it possible to avoid rewriting the code for common interfaces such as QtUiTest::Widget many times.

It is possible to subclass the test widgets shipped with QtUiTest, although they are not guaranteed to remain source or binary compatible across releases. The convention used in the reference plugins to generate a test widget class name is to take the wrapped widget class name, drop any leading Q, and prefix Test. For example, the test widget wrappers for QWidget and QAbstractItemView are named TestWidget and TestAbstractItemView respectively.

Using the plugin approach, while subclassing from TestWidget to avoid reimplementing the QtUiTest::Widget interface, would result in a class declaration like the following:

    #include <testwidget.h>
    class TestCustomComboBox : public TestWidget, public QtUiTest::ListWidget,
        public QtUiTest::SelectWidget, public QtUiTest::TextWidget
    {
    Q_OBJECT
    Q_INTERFACES(
        QtUiTest::ListWidget
        QtUiTest::SelectWidget
        QtUiTest::TextWidget)

    public:
        TestCustomComboBox(CustomComboBox* wrapped);
        virtual ~TestCustomComboBox();

        // QtUiTest::ListWidget members
        virtual QStringList list() const;
        virtual QRect visualRect(const QString&) const;

        // QtUiTest::SelectWidget members
        virtual bool canSelect(QString const&) const;
        virtual bool select(QString const&);

        // QtUiTest::TextWidget members
        virtual QString text() const;
        virtual QString selectedText() const;

    private:
        CustomComboBox* m_wrapped;
    };

Implementing the test widget is as simple as retrieving the necessary information from the wrapped widget. Test widgets can create and use other test widgets at runtime when necessary, as shown in the list() function below.

    TestCustomComboBox::TestCustomComboBox(CustomComboBox* wrapped)
        : m_wrapped(wrapped)
    {}

    QStringList TestCustomComboBox::list() const
    { return qtuitest_cast<QtUiTest::ListWidget*>(m_wrapped->view())->list(); }

    QString TestCustomComboBox::text() const
    { return list().join("\n"); }

    QString TestCustomComboBox::selectedText() const
    { return m_wrapped->currentText(); }

Memory management is handled automatically; there will be a maximum of one TestCustomComboBox instance created for any CustomComboBox and it will be destroyed when the underlying CustomComboBox is destroyed.

    class TestWidgetsFactory : public QObject, public QtUiTest::WidgetFactory
    {
        Q_OBJECT
        Q_INTERFACES(QtUiTest::WidgetFactory)

    public:
        TestWidgetsFactory();

        virtual QObject* create(QObject*);
        virtual QStringList keys() const;
    };

    QObject* TestWidgetsFactory::create(QObject* wrapped)
    {
        if ((CustomComboBox* ccb = qobject_cast<CustomComboBox*>(wrapped))) {
            return new TestCustomComboBox(ccb);
        }
        return 0;
    }

    QStringList TestWidgetsFactory::keys() const
    {
        return QStringList() << "CustomComboBox";
    }

    #include <qplugin.h>
    Q_EXPORT_PLUGIN2(customtestwidgets, TestWidgetsFactory)

    class CustomComboBox : public QComboBox, public QtUiTest::Widget,
        public QtUiTest::ListWidget, public QtUiTest::SelectWidget,
        public QtUiTest::TextWidget
    {
    Q_OBJECT
    Q_INTERFACES(
        QtUiTest::Widget
        QtUiTest::ListWidget
        QtUiTest::SelectWidget
        QtUiTest::TextWidget)

    public:
        CustomComboBox(QWidget* parent = 0);
        ...

        // CustomComboBox members
        void addCustomItem(const QVariant& item);
        void addCustomItems(const QVariantList& items);
        ...

        // QtUiTest::Widget members
        virtual const QRect& geometry() const;
        virtual QRect rect() const;
        ...

        // QtUiTest::ListWidget members
        virtual QStringList list() const;
        virtual QRect visualRect(const QString&) const;
        ...

        // etc...
    };

    QStringList CustomComboBox::list() const
    { return qtuitest_cast<QtUiTest::ListWidget*>(view())->list(); }

    QString CustomComboBox::text() const
    { return list().join("\n"); }

    QString CustomComboBox::selectedText() const
    { return currentText(); }

    select("New contact...", optionsMenu());

    QObject* CustomFactory::find(QtUiTest::WidgetType type)
    {
        // For the options menu, use our permanently onscreen widget
        if (type == QtUiTest::OptionsMenu)
            return OnScreenOptionsMenu::instance();

        // For the call manager, create our test widget which knows how to simulate
        // device-specific key clicks.  Since there is no underlying widget,
        // just create and reuse a single test widget throughout the whole lifetime
        // of the program.
        if (type == QtUiTest::CallManager) {
            static TestCustomCallManager testCallManager;
            return &testCallManager;
        }

        // For all other widget types, just use the default find behavior.
        return 0;
    }