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 QQMLPROPERTY_H
41#define QQMLPROPERTY_H
42
43#include <QtQml/qtqmlglobal.h>
44#include <QtCore/qmetaobject.h>
45
46QT_BEGIN_NAMESPACE
47
48
49class QObject;
50class QVariant;
51class QQmlContext;
52class QQmlEngine;
53
54class QQmlPropertyPrivate;
55class Q_QML_EXPORT QQmlProperty
56{
57public:
58 enum PropertyTypeCategory {
59 InvalidCategory,
60 List,
61 Object,
62 Normal
63 };
64
65 enum Type {
66 Invalid,
67 Property,
68 SignalProperty
69 };
70
71 QQmlProperty();
72 ~QQmlProperty();
73
74 QQmlProperty(QObject *);
75 QQmlProperty(QObject *, QQmlContext *);
76 QQmlProperty(QObject *, QQmlEngine *);
77
78 QQmlProperty(QObject *, const QString &);
79 QQmlProperty(QObject *, const QString &, QQmlContext *);
80 QQmlProperty(QObject *, const QString &, QQmlEngine *);
81
82 QQmlProperty(const QQmlProperty &);
83 QQmlProperty &operator=(const QQmlProperty &);
84
85 bool operator==(const QQmlProperty &) const;
86
87 Type type() const;
88 bool isValid() const;
89 bool isProperty() const;
90 bool isSignalProperty() const;
91
92 int propertyType() const;
93 PropertyTypeCategory propertyTypeCategory() const;
94 const char *propertyTypeName() const;
95
96 QString name() const;
97
98 QVariant read() const;
99 static QVariant read(const QObject *, const QString &);
100 static QVariant read(const QObject *, const QString &, QQmlContext *);
101 static QVariant read(const QObject *, const QString &, QQmlEngine *);
102
103 bool write(const QVariant &) const;
104 static bool write(QObject *, const QString &, const QVariant &);
105 static bool write(QObject *, const QString &, const QVariant &, QQmlContext *);
106 static bool write(QObject *, const QString &, const QVariant &, QQmlEngine *);
107
108 bool reset() const;
109
110 bool hasNotifySignal() const;
111 bool needsNotifySignal() const;
112 bool connectNotifySignal(QObject *dest, const char *slot) const;
113 bool connectNotifySignal(QObject *dest, int method) const;
114
115 bool isWritable() const;
116 bool isDesignable() const;
117 bool isResettable() const;
118 QObject *object() const;
119
120 int index() const;
121 QMetaProperty property() const;
122 QMetaMethod method() const;
123
124private:
125 friend class QQmlPropertyPrivate;
126 QQmlPropertyPrivate *d;
127};
128typedef QList<QQmlProperty> QQmlProperties;
129
130inline uint qHash (const QQmlProperty &key)
131{
132 return qHash(key.object()) + qHash(key.name());
133}
134
135Q_DECLARE_TYPEINFO(QQmlProperty, Q_MOVABLE_TYPE);
136
137QT_END_NAMESPACE
138
139#endif // QQMLPROPERTY_H
140