1 /****************************************************************************
2 **
3 ** Copyright (C) 2017 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtLocation module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL3$
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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free
28 ** Software Foundation and appearing in the file LICENSE.GPL included in
29 ** the packaging of this file. Please review the following information to
30 ** ensure the GNU General Public License version 2.0 requirements will be
31 ** met: http://www.gnu.org/licenses/gpl-2.0.html.
32 **
33 ** $QT_END_LICENSE$
34 **
35 ****************************************************************************/
36 
37 #ifndef QMAPOBJECTVIEW_P_H
38 #define QMAPOBJECTVIEW_P_H
39 
40 //
41 //  W A R N I N G
42 //  -------------
43 //
44 // This file is not part of the Qt API.  It exists purely as an
45 // implementation detail.  This header file may change from version to
46 // version without notice, or even be removed.
47 //
48 // We mean it.
49 //
50 
51 #include <QtLocation/private/qlocationglobal_p.h>
52 #include <QtLocation/private/qgeomapobject_p.h>
53 #include <QQmlComponent>
54 #include <QVector>
55 
56 QT_BEGIN_NAMESPACE
57 
58 class QQmlDelegateModel;
59 class QMapObjectViewPrivate;
60 class QQmlChangeSet;
61 class Q_LOCATION_PRIVATE_EXPORT QMapObjectView : public QGeoMapObject
62 {
63     Q_OBJECT
64     Q_PROPERTY(QVariant model READ model WRITE setModel NOTIFY modelChanged)
65     Q_PROPERTY(QQmlComponent *delegate READ delegate WRITE setDelegate NOTIFY delegateChanged)
66     Q_INTERFACES(QQmlParserStatus)
67 public:
68     QMapObjectView(QObject *parent = nullptr);
69     ~QMapObjectView() override;
70 
71     // QGeoMapObject interface
72     QList<QGeoMapObject *> geoMapObjectChildren() const override;
73     void setMap(QGeoMap *map) override;
74 
75     // QQmlParserStatus interface
76     void classBegin() override;
77     void componentComplete() override;
78 
79     QVariant model() const;
80     void setModel(QVariant model);
81 
82     QQmlComponent *delegate() const;
83     void setDelegate(QQmlComponent * delegate);
84 
85 public Q_SLOTS:
86     // The dynamic API that matches Map.add/remove MapItem
87     void addMapObject(QGeoMapObject *object);
88     void removeMapObject(QGeoMapObject *object);
89 
90 signals:
91     void modelChanged(QVariant model);
92     void delegateChanged(QQmlComponent * delegate);
93 
94 protected Q_SLOTS:
95     void destroyingItem(QObject *object);
96     void initItem(int index, QObject *object);
97     void createdItem(int index, QObject *object);
98     void modelUpdated(const QQmlChangeSet &changeSet, bool reset);
99 
100 protected:
101     void addMapObjectToMap(QGeoMapObject *object, int index);
102     void removeMapObjectFromMap(int index);
103     void flushDelegateModel();
104     void flushUserAddedMapObjects();
105 
106     QQmlDelegateModel *m_delegateModel = nullptr;
107     QVector<QPointer<QGeoMapObject>> m_instantiatedMapObjects;
108     QVector<QPointer<QGeoMapObject>> m_pendingMapObjects; // for items instantiated before the map is set
109     QVector<QPointer<QGeoMapObject>> m_userAddedMapObjects; // A third list containing the objects dynamically added through addMapObject
110     bool m_creatingObject = false;
111 };
112 
113 QT_END_NAMESPACE
114 
115 #endif // QMAPOBJECTVIEW_P_H
116