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 QtQml 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 QQMLPROPERTYMAP_H
41#define QQMLPROPERTYMAP_H
42
43#include <QtQml/qtqmlglobal.h>
44
45#include <QtCore/QObject>
46#include <QtCore/QHash>
47#include <QtCore/QStringList>
48#include <QtCore/QVariant>
49
50QT_BEGIN_NAMESPACE
51
52
53class QQmlPropertyMapPrivate;
54class Q_QML_EXPORT QQmlPropertyMap : public QObject
55{
56 Q_OBJECT
57public:
58 explicit QQmlPropertyMap(QObject *parent = nullptr);
59 ~QQmlPropertyMap() override;
60
61 QVariant value(const QString &key) const;
62 void insert(const QString &key, const QVariant &value);
63 void clear(const QString &key);
64
65 Q_INVOKABLE QStringList keys() const;
66
67 int count() const;
68 int size() const;
69 bool isEmpty() const;
70 bool contains(const QString &key) const;
71
72 QVariant &operator[](const QString &key);
73 QVariant operator[](const QString &key) const;
74
75Q_SIGNALS:
76 void valueChanged(const QString &key, const QVariant &value);
77
78protected:
79 virtual QVariant updateValue(const QString &key, const QVariant &input);
80
81 template<class DerivedType>
82 QQmlPropertyMap(DerivedType *derived, QObject *parentObj)
83 : QQmlPropertyMap(&DerivedType::staticMetaObject, parentObj)
84 {
85 Q_UNUSED(derived)
86 }
87
88private:
89 QQmlPropertyMap(const QMetaObject *staticMetaObject, QObject *parent);
90
91 Q_DECLARE_PRIVATE(QQmlPropertyMap)
92 Q_DISABLE_COPY(QQmlPropertyMap)
93};
94
95QT_END_NAMESPACE
96
97#endif
98

source code of qtdeclarative/src/qml/util/qqmlpropertymap.h