Improve documentation.
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlopenmetaobject_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
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 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.
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 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.
24 **
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.
28 **
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.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QQMLOPENMETAOBJECT_H
43 #define QQMLOPENMETAOBJECT_H
44
45 #include <QtCore/QMetaObject>
46 #include <QtCore/QObject>
47
48 #include <private/qqmlrefcount_p.h>
49 #include <private/qqmlcleanup_p.h>
50 #include <private/qtqmlglobal_p.h>
51 #include <private/qobject_p.h>
52
53 QT_BEGIN_HEADER
54
55 QT_BEGIN_NAMESPACE
56
57
58 class QQmlEngine;
59 class QMetaPropertyBuilder;
60 class QQmlOpenMetaObjectTypePrivate;
61 class Q_QML_PRIVATE_EXPORT QQmlOpenMetaObjectType : public QQmlRefCount, public QQmlCleanup
62 {
63 public:
64     QQmlOpenMetaObjectType(const QMetaObject *base, QQmlEngine *engine);
65     ~QQmlOpenMetaObjectType();
66
67     int createProperty(const QByteArray &name);
68
69     int propertyOffset() const;
70     int signalOffset() const;
71
72     int propertyCount() const;
73     QByteArray propertyName(int) const;
74     QMetaObject *metaObject() const;
75
76 protected:
77     virtual void propertyCreated(int, QMetaPropertyBuilder &);
78     virtual void clear();
79
80 private:
81     QQmlOpenMetaObjectTypePrivate *d;
82     friend class QQmlOpenMetaObject;
83     friend class QQmlOpenMetaObjectPrivate;
84 };
85
86 class QQmlOpenMetaObjectPrivate;
87 class Q_QML_PRIVATE_EXPORT QQmlOpenMetaObject : public QAbstractDynamicMetaObject
88 {
89 public:
90     QQmlOpenMetaObject(QObject *, const QMetaObject * = 0, bool = true);
91     QQmlOpenMetaObject(QObject *, QQmlOpenMetaObjectType *, bool = true);
92     ~QQmlOpenMetaObject();
93
94     QVariant value(const QByteArray &) const;
95     bool setValue(const QByteArray &, const QVariant &);
96     QVariant value(int) const;
97     void setValue(int, const QVariant &);
98     QVariant &operator[](const QByteArray &);
99     QVariant &operator[](int);
100     bool hasValue(int) const;
101
102     int count() const;
103     QByteArray name(int) const;
104
105     QObject *object() const;
106     virtual QVariant initialValue(int);
107
108     // Be careful - once setCached(true) is called createProperty() is no
109     // longer automatically called for new properties.
110     void setCached(bool);
111
112     QQmlOpenMetaObjectType *type() const;
113
114 protected:
115     virtual int metaCall(QMetaObject::Call _c, int _id, void **_a);
116     virtual int createProperty(const char *, const char *);
117
118     virtual void propertyRead(int);
119     virtual void propertyWrite(int);
120     virtual QVariant propertyWriteValue(int, const QVariant &);
121     virtual void propertyWritten(int);
122     virtual void propertyCreated(int, QMetaPropertyBuilder &);
123
124     QAbstractDynamicMetaObject *parent() const;
125
126 private:
127     QQmlOpenMetaObjectPrivate *d;
128     friend class QQmlOpenMetaObjectType;
129 };
130
131 QT_END_NAMESPACE
132
133 QT_END_HEADER
134
135 #endif // QQMLOPENMETAOBJECT_H