Improve documentation.
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlwatcher_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 QQMLWATCHER_P_H
43 #define QQMLWATCHER_P_H
44
45 //
46 //  W A R N I N G
47 //  -------------
48 //
49 // This file is not part of the Qt API.  It exists purely as an
50 // implementation detail.  This header file may change from version to
51 // version without notice, or even be removed.
52 //
53 // We mean it.
54 //
55
56 #include <QtCore/qobject.h>
57 #include <QtCore/qlist.h>
58 #include <QtCore/qpair.h>
59 #include <QtCore/qhash.h>
60 #include <QtCore/qset.h>
61 #include <QtCore/qpointer.h>
62
63 QT_BEGIN_NAMESPACE
64
65 class QQmlWatchProxy;
66 class QQmlExpression;
67 class QQmlContext;
68 class QMetaProperty;
69
70 class QQmlWatcher : public QObject
71 {
72     Q_OBJECT
73 public:
74     QQmlWatcher(QObject * = 0);
75
76     bool addWatch(int id, quint32 objectId);
77     bool addWatch(int id, quint32 objectId, const QByteArray &property);
78     bool addWatch(int id, quint32 objectId, const QString &expr);
79
80     bool removeWatch(int id);
81
82 Q_SIGNALS:
83     void propertyChanged(int id, int objectId, const QMetaProperty &property, const QVariant &value);
84
85 private:
86     friend class QQmlWatchProxy;
87     void addPropertyWatch(int id, QObject *object, quint32 objectId, const QMetaProperty &property);
88
89     QHash<int, QList<QPointer<QQmlWatchProxy> > > m_proxies;
90 };
91
92 QT_END_NAMESPACE
93
94 #endif // QQMLWATCHER_P_H