1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtTest module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QABSTRACTITEMMODELTESTER_H
41#define QABSTRACTITEMMODELTESTER_H
42
43#include <QtCore/QObject>
44#include <QtTest/qttestglobal.h>
45#include <QtCore/QAbstractItemModel>
46#include <QtCore/QVariant>
47
48#ifdef QT_GUI_LIB
49#include <QtGui/QFont>
50#include <QtGui/QColor>
51#include <QtGui/QBrush>
52#include <QtGui/QPixmap>
53#include <QtGui/QImage>
54#include <QtGui/QIcon>
55#endif
56
57QT_REQUIRE_CONFIG(itemmodeltester);
58
59QT_BEGIN_NAMESPACE
60
61class QAbstractItemModel;
62class QAbstractItemModelTester;
63class QAbstractItemModelTesterPrivate;
64
65namespace QTestPrivate {
66inline bool testDataGuiRoles(QAbstractItemModelTester *tester);
67}
68
69class Q_TESTLIB_EXPORT QAbstractItemModelTester : public QObject
70{
71 Q_OBJECT
72 Q_DECLARE_PRIVATE(QAbstractItemModelTester)
73
74public:
75 enum class FailureReportingMode {
76 QtTest,
77 Warning,
78 Fatal
79 };
80
81 QAbstractItemModelTester(QAbstractItemModel *model, QObject *parent = nullptr);
82 QAbstractItemModelTester(QAbstractItemModel *model, FailureReportingMode mode, QObject *parent = nullptr);
83
84 QAbstractItemModel *model() const;
85 FailureReportingMode failureReportingMode() const;
86
87private:
88 friend inline bool QTestPrivate::testDataGuiRoles(QAbstractItemModelTester *tester);
89 bool verify(bool statement, const char *statementStr, const char *description, const char *file, int line);
90};
91
92namespace QTestPrivate {
93inline bool testDataGuiRoles(QAbstractItemModelTester *tester)
94{
95#ifdef QT_GUI_LIB
96
97#define MODELTESTER_VERIFY(statement) \
98do { \
99 if (!tester->verify(static_cast<bool>(statement), #statement, "", __FILE__, __LINE__)) \
100 return false; \
101} while (false)
102
103 const auto model = tester->model();
104 Q_ASSERT(model);
105
106 if (!model->hasChildren())
107 return true;
108
109 QVariant variant;
110
111 variant = model->data(model->index(0, 0), Qt::DecorationRole);
112 if (variant.isValid()) {
113 MODELTESTER_VERIFY(variant.canConvert<QPixmap>()
114 || variant.canConvert<QImage>()
115 || variant.canConvert<QIcon>()
116 || variant.canConvert<QColor>()
117 || variant.canConvert<QBrush>());
118 }
119
120 // General Purpose roles that should return a QFont
121 variant = model->data(model->index(0, 0), Qt::FontRole);
122 if (variant.isValid())
123 MODELTESTER_VERIFY(variant.canConvert<QFont>());
124
125 // General Purpose roles that should return a QColor or a QBrush
126 variant = model->data(model->index(0, 0), Qt::BackgroundRole);
127 if (variant.isValid())
128 MODELTESTER_VERIFY(variant.canConvert<QColor>() || variant.canConvert<QBrush>());
129
130 variant = model->data(model->index(0, 0), Qt::ForegroundRole);
131 if (variant.isValid())
132 MODELTESTER_VERIFY(variant.canConvert<QColor>() || variant.canConvert<QBrush>());
133
134#undef MODELTESTER_VERIFY
135
136#else
137 Q_UNUSED(tester);
138#endif // QT_GUI_LIB
139
140 return true;
141}
142} // namespaceQTestPrivate
143
144QT_END_NAMESPACE
145
146#endif // QABSTRACTITEMMODELTESTER_H
147