1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtQml module of the Qt Toolkit.
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
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 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
42 #ifndef QQMLPROPERTY_H
43 #define QQMLPROPERTY_H
45 #include <QtQml/qtqmlglobal.h>
46 #include <QtCore/qmetaobject.h>
58 class QQmlPropertyPrivate;
59 class Q_QML_EXPORT QQmlProperty
62 enum PropertyTypeCategory {
78 QQmlProperty(QObject *);
79 QQmlProperty(QObject *, QQmlContext *);
80 QQmlProperty(QObject *, QQmlEngine *);
82 QQmlProperty(QObject *, const QString &);
83 QQmlProperty(QObject *, const QString &, QQmlContext *);
84 QQmlProperty(QObject *, const QString &, QQmlEngine *);
86 QQmlProperty(const QQmlProperty &);
87 QQmlProperty &operator=(const QQmlProperty &);
89 bool operator==(const QQmlProperty &) const;
93 bool isProperty() const;
94 bool isSignalProperty() const;
96 int propertyType() const;
97 PropertyTypeCategory propertyTypeCategory() const;
98 const char *propertyTypeName() const;
100 QString name() const;
102 QVariant read() const;
103 static QVariant read(QObject *, const QString &);
104 static QVariant read(QObject *, const QString &, QQmlContext *);
105 static QVariant read(QObject *, const QString &, QQmlEngine *);
107 bool write(const QVariant &) const;
108 static bool write(QObject *, const QString &, const QVariant &);
109 static bool write(QObject *, const QString &, const QVariant &, QQmlContext *);
110 static bool write(QObject *, const QString &, const QVariant &, QQmlEngine *);
114 bool hasNotifySignal() const;
115 bool needsNotifySignal() const;
116 bool connectNotifySignal(QObject *dest, const char *slot) const;
117 bool connectNotifySignal(QObject *dest, int method) const;
119 bool isWritable() const;
120 bool isDesignable() const;
121 bool isResettable() const;
122 QObject *object() const;
125 QMetaProperty property() const;
126 QMetaMethod method() const;
129 friend class QQmlPropertyPrivate;
130 QQmlPropertyPrivate *d;
132 typedef QList<QQmlProperty> QQmlProperties;
134 inline uint qHash (const QQmlProperty &key)
136 return qHash(key.object()) + qHash(key.name());
139 Q_DECLARE_TYPEINFO(QQmlProperty, Q_MOVABLE_TYPE);
145 #endif // QQMLPROPERTY_H