1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QQMLINSTANCEMODEL_P_H
5#define QQMLINSTANCEMODEL_P_H
6
7//
8// W A R N I N G
9// -------------
10//
11// This file is not part of the Qt API. It exists purely as an
12// implementation detail. This header file may change from version to
13// version without notice, or even be removed.
14//
15// We mean it.
16//
17
18#include <private/qtqmlmodelsglobal_p.h>
19#include <private/qqmlincubator_p.h>
20#include <QtQml/qqml.h>
21#include <QtCore/qobject.h>
22
23QT_REQUIRE_CONFIG(qml_object_model);
24
25QT_BEGIN_NAMESPACE
26
27class QObject;
28class QQmlChangeSet;
29class QAbstractItemModel;
30
31class Q_QMLMODELS_EXPORT QQmlInstanceModel : public QObject
32{
33 Q_OBJECT
34
35 Q_PROPERTY(int count READ count NOTIFY countChanged)
36 QML_ANONYMOUS
37 QML_ADDED_IN_VERSION(2, 0)
38
39public:
40 enum ReusableFlag {
41 NotReusable,
42 Reusable
43 };
44
45 enum ReleaseFlag { Referenced = 0x01, Destroyed = 0x02, Pooled = 0x04 };
46 Q_DECLARE_FLAGS(ReleaseFlags, ReleaseFlag)
47
48 virtual int count() const = 0;
49 virtual bool isValid() const = 0;
50 virtual QObject *object(int index, QQmlIncubator::IncubationMode incubationMode = QQmlIncubator::AsynchronousIfNested) = 0;
51 virtual ReleaseFlags release(QObject *object, ReusableFlag reusableFlag = NotReusable) = 0;
52 virtual void cancel(int) {}
53 QString stringValue(int index, const QString &role) { return variantValue(index, role).toString(); }
54 virtual QVariant variantValue(int, const QString &) = 0;
55 virtual void setWatchedRoles(const QList<QByteArray> &roles) = 0;
56 virtual QQmlIncubator::Status incubationStatus(int index) = 0;
57
58 virtual void drainReusableItemsPool(int maxPoolTime) { Q_UNUSED(maxPoolTime); }
59 virtual int poolSize() { return 0; }
60
61 virtual int indexOf(QObject *object, QObject *objectContext) const = 0;
62 virtual const QAbstractItemModel *abstractItemModel() const { return nullptr; }
63
64 virtual bool setRequiredProperty(int index, const QString &name, const QVariant &value);
65
66Q_SIGNALS:
67 void countChanged();
68 void modelUpdated(const QQmlChangeSet &changeSet, bool reset);
69 void createdItem(int index, QObject *object);
70 void initItem(int index, QObject *object);
71 void destroyingItem(QObject *object);
72 Q_REVISION(2, 15) void itemPooled(int index, QObject *object);
73 Q_REVISION(2, 15) void itemReused(int index, QObject *object);
74
75protected:
76 QQmlInstanceModel(QObjectPrivate &dd, QObject *parent = nullptr)
77 : QObject(dd, parent) {}
78
79private:
80 Q_DISABLE_COPY(QQmlInstanceModel)
81};
82
83class QQmlObjectModelAttached;
84class QQmlObjectModelPrivate;
85class Q_QMLMODELS_EXPORT QQmlObjectModel : public QQmlInstanceModel
86{
87 Q_OBJECT
88 Q_DECLARE_PRIVATE(QQmlObjectModel)
89
90 Q_PROPERTY(QQmlListProperty<QObject> children READ children NOTIFY childrenChanged DESIGNABLE false)
91 Q_CLASSINFO("qt_QmlJSWrapperFactoryMethod", "_q_createJSWrapper(QQmlV4ExecutionEnginePtr)")
92 Q_CLASSINFO("DefaultProperty", "children")
93 QML_NAMED_ELEMENT(ObjectModel)
94 QML_ADDED_IN_VERSION(2, 1)
95 QML_ATTACHED(QQmlObjectModelAttached)
96
97public:
98 QQmlObjectModel(QObject *parent=nullptr);
99 ~QQmlObjectModel();
100
101 int count() const override;
102 bool isValid() const override;
103 QObject *object(int index, QQmlIncubator::IncubationMode incubationMode = QQmlIncubator::AsynchronousIfNested) override;
104 ReleaseFlags release(QObject *object, ReusableFlag reusable = NotReusable) override;
105 QVariant variantValue(int index, const QString &role) override;
106 void setWatchedRoles(const QList<QByteArray> &) override {}
107 QQmlIncubator::Status incubationStatus(int index) override;
108
109 int indexOf(QObject *object, QObject *objectContext) const override;
110
111 QQmlListProperty<QObject> children();
112
113 static QQmlObjectModelAttached *qmlAttachedProperties(QObject *obj);
114
115 Q_REVISION(2, 3) Q_INVOKABLE QObject *get(int index) const;
116 Q_REVISION(2, 3) Q_INVOKABLE void append(QObject *object);
117 Q_REVISION(2, 3) Q_INVOKABLE void insert(int index, QObject *object);
118 Q_REVISION(2, 3) Q_INVOKABLE void move(int from, int to, int n = 1);
119 Q_REVISION(2, 3) Q_INVOKABLE void remove(int index, int n = 1);
120
121public Q_SLOTS:
122 Q_REVISION(2, 3) void clear();
123
124Q_SIGNALS:
125 void childrenChanged();
126
127private:
128 Q_PRIVATE_SLOT(d_func(), quint64 _q_createJSWrapper(QQmlV4ExecutionEnginePtr))
129 Q_DISABLE_COPY(QQmlObjectModel)
130};
131
132class QQmlObjectModelAttached : public QObject
133{
134 Q_OBJECT
135
136public:
137 QQmlObjectModelAttached(QObject *parent)
138 : QObject(parent), m_index(-1) {}
139
140 Q_PROPERTY(int index READ index NOTIFY indexChanged FINAL)
141 int index() const { return m_index; }
142 void setIndex(int idx) {
143 if (m_index != idx) {
144 m_index = idx;
145 Q_EMIT indexChanged();
146 }
147 }
148
149Q_SIGNALS:
150 void indexChanged();
151
152public:
153 int m_index;
154};
155
156
157QT_END_NAMESPACE
158
159#endif // QQMLINSTANCEMODEL_P_H
160

source code of qtdeclarative/src/qmlmodels/qqmlobjectmodel_p.h