summaryrefslogtreecommitdiff
path: root/src/quick/items/qquickvisualitemmodel.cpp
blob: fd71deeb1514a09b6b51974267144f422c1e238b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtQml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qquickvisualitemmodel_p.h"
#include "qquickitem.h"

#include <QtCore/qcoreapplication.h>
#include <QtQml/qqmlcontext.h>
#include <QtQml/qqmlengine.h>

#include <private/qquickchangeset_p.h>
#include <private/qqmlglobal_p.h>
#include <private/qobject_p.h>

#include <QtCore/qhash.h>
#include <QtCore/qlist.h>

QT_BEGIN_NAMESPACE

QHash<QObject*, QQuickVisualItemModelAttached*> QQuickVisualItemModelAttached::attachedProperties;


class QQuickVisualItemModelPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QQuickVisualItemModel)
public:
    QQuickVisualItemModelPrivate() : QObjectPrivate() {}

    static void children_append(QQmlListProperty<QQuickItem> *prop, QQuickItem *item) {
        static_cast<QQuickVisualItemModelPrivate *>(prop->data)->children.append(Item(item));
        static_cast<QQuickVisualItemModelPrivate *>(prop->data)->itemAppended();
        static_cast<QQuickVisualItemModelPrivate *>(prop->data)->emitChildrenChanged();
    }

    static int children_count(QQmlListProperty<QQuickItem> *prop) {
        return static_cast<QQuickVisualItemModelPrivate *>(prop->data)->children.count();
    }

    static QQuickItem *children_at(QQmlListProperty<QQuickItem> *prop, int index) {
        return static_cast<QQuickVisualItemModelPrivate *>(prop->data)->children.at(index).item;
    }

    void itemAppended() {
        Q_Q(QQuickVisualItemModel);
        QQuickVisualItemModelAttached *attached = QQuickVisualItemModelAttached::properties(children.last().item);
        attached->setIndex(children.count()-1);
        QQuickChangeSet changeSet;
        changeSet.insert(children.count() - 1, 1);
        emit q->modelUpdated(changeSet, false);
        emit q->countChanged();
    }

    void emitChildrenChanged() {
        Q_Q(QQuickVisualItemModel);
        emit q->childrenChanged();
    }

    int indexOf(QQuickItem *item) const {
        for (int i = 0; i < children.count(); ++i)
            if (children.at(i).item == item)
                return i;
        return -1;
    }

    class Item {
    public:
        Item(QQuickItem *i) : item(i), ref(0) {}

        void addRef() { ++ref; }
        bool deref() { return --ref == 0; }

        QQuickItem *item;
        int ref;
    };

    QList<Item> children;
};


/*!
    \qmltype VisualItemModel
    \instantiates QQuickVisualItemModel
    \inqmlmodule QtQuick 2
    \ingroup qtquick-models
    \brief Defines items to be used added to a view

    A VisualItemModel contains the visual items to be used in a view.
    When a VisualItemModel is used in a view, the view does not require
    a delegate since the VisualItemModel already contains the visual
    delegate (items).

    An item can determine its index within the
    model via the \l{VisualItemModel::index}{index} attached property.

    The example below places three colored rectangles in a ListView.
    \code
    import QtQuick 2.0

    Rectangle {
        VisualItemModel {
            id: itemModel
            Rectangle { height: 30; width: 80; color: "red" }
            Rectangle { height: 30; width: 80; color: "green" }
            Rectangle { height: 30; width: 80; color: "blue" }
        }

        ListView {
            anchors.fill: parent
            model: itemModel
        }
    }
    \endcode

    \image visualitemmodel.png

    \sa {quick/modelviews/visualitemmodel}{VisualItemModel example}
*/
QQuickVisualItemModel::QQuickVisualItemModel(QObject *parent)
    : QQuickVisualModel(*(new QQuickVisualItemModelPrivate), parent)
{
}

/*!
    \qmlattachedproperty int QtQuick2::VisualItemModel::index
    This attached property holds the index of this delegate's item within the model.

    It is attached to each instance of the delegate.
*/

QQmlListProperty<QQuickItem> QQuickVisualItemModel::children()
{
    Q_D(QQuickVisualItemModel);
    return QQmlListProperty<QQuickItem>(this, d, d->children_append,
                                                      d->children_count, d->children_at);
}

/*!
    \qmlproperty int QtQuick2::VisualItemModel::count

    The number of items in the model.  This property is readonly.
*/
int QQuickVisualItemModel::count() const
{
    Q_D(const QQuickVisualItemModel);
    return d->children.count();
}

bool QQuickVisualItemModel::isValid() const
{
    return true;
}

QQuickItem *QQuickVisualItemModel::item(int index, bool)
{
    Q_D(QQuickVisualItemModel);
    QQuickVisualItemModelPrivate::Item &item = d->children[index];
    item.addRef();
    if (item.ref == 1) {
        emit initItem(index, item.item);
        emit createdItem(index, item.item);
    }
    return item.item;
}

QQuickVisualModel::ReleaseFlags QQuickVisualItemModel::release(QQuickItem *item)
{
    Q_D(QQuickVisualItemModel);
    int idx = d->indexOf(item);
    if (idx >= 0) {
        if (d->children[idx].deref()) {
            // XXX todo - the original did item->scene()->removeItem().  Why?
            item->setParentItem(0);
        } else {
            return QQuickVisualModel::Referenced;
        }
    }
    return 0;
}

QString QQuickVisualItemModel::stringValue(int index, const QString &name)
{
    Q_D(QQuickVisualItemModel);
    if (index < 0 || index >= d->children.count())
        return QString();
    return QQmlEngine::contextForObject(d->children.at(index).item)->contextProperty(name).toString();
}

int QQuickVisualItemModel::indexOf(QQuickItem *item, QObject *) const
{
    Q_D(const QQuickVisualItemModel);
    return d->indexOf(item);
}

QQuickVisualItemModelAttached *QQuickVisualItemModel::qmlAttachedProperties(QObject *obj)
{
    return QQuickVisualItemModelAttached::properties(obj);
}

QT_END_NAMESPACE