tests/auto/qtquick2/shared/visualtestutil.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the test suite of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQUICKVISUALTESTUTIL_H
  43 #define QQUICKVISUALTESTUTIL_H
  44
  45 #include <QtQuick/QQuickItem>
  46 #include <QtDeclarative/QDeclarativeExpression>
  47
  48 namespace QQuickVisualTestUtil
  49 {
  50     QQuickItem *findVisibleChild(QQuickItem *parent, const QString &objectName);
  51
  52     void dumpTree(QQuickItem *parent, int depth = 0);
  53
  54
  55     /*
  56        Find an item with the specified objectName.  If index is supplied then the
  57        item must also evaluate the {index} expression equal to index
  58     */
  59     template<typename T>
  60     T *findItem(QQuickItem *parent, const QString &objectName, int index = -1)
  61     {
  62         const QMetaObject &mo = T::staticMetaObject;
  63         for (int i = 0; i < parent->childItems().count(); ++i) {
  64             QQuickItem *item = qobject_cast<QQuickItem*>(parent->childItems().at(i));
  65             if (!item)
  66                 continue;
  67             if (mo.cast(item) && (objectName.isEmpty() || item->objectName() == objectName)) {
  68                 if (index != -1) {
  69                     QDeclarativeExpression e(qmlContext(item), item, "index");
  70                     if (e.evaluate().toInt() == index)
  71                         return static_cast<T*>(item);
  72                 } else {
  73                     return static_cast<T*>(item);
  74                 }
  75             }
  76             item = findItem<T>(item, objectName, index);
  77             if (item)
  78                 return static_cast<T*>(item);
  79         }
  80
  81         return 0;
  82     }
  83
  84     template<typename T>
  85     QList<T*> findItems(QQuickItem *parent, const QString &objectName, bool visibleOnly = true)
  86     {
  87         QList<T*> items;
  88         const QMetaObject &mo = T::staticMetaObject;
  89         for (int i = 0; i < parent->childItems().count(); ++i) {
  90             QQuickItem *item = qobject_cast<QQuickItem*>(parent->childItems().at(i));
  91             if (!item || (visibleOnly && !item->isVisible()))
  92                 continue;
  93             if (mo.cast(item) && (objectName.isEmpty() || item->objectName() == objectName))
  94                 items.append(static_cast<T*>(item));
  95             items += findItems<T>(item, objectName);
  96         }
  97
  98         return items;
  99     }
 100
 101     template<typename T>
 102     QList<T*> findItems(QQuickItem *parent, const QString &objectName, const QList<int> &indexes)
 103     {
 104         QList<T*> items;
 105         for (int i=0; i<indexes.count(); i++)
 106             items << qobject_cast<QQuickItem*>(findItem<T>(parent, objectName, indexes[i]));
 107         return items;
 108     }
 109
 110 }
 111
 112 #endif // QQUICKVISUALTESTUTIL_H