1/****************************************************************************
2**
3** Copyright (C) 2016 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWebChannel 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 QQMLWEBCHANNEL_H
41#define QQMLWEBCHANNEL_H
42
43#include <QtWebChannel/QWebChannel>
44#include <QtWebChannel/qwebchannelglobal.h>
45
46#include <QtQml/qqml.h>
47#include <QtQml/QQmlListProperty>
48
49QT_BEGIN_NAMESPACE
50
51class QQmlWebChannelPrivate;
52class QQmlWebChannelAttached;
53class Q_WEBCHANNEL_EXPORT QQmlWebChannel : public QWebChannel
54{
55 Q_OBJECT
56 Q_DISABLE_COPY(QQmlWebChannel)
57
58 Q_PROPERTY( QQmlListProperty<QObject> transports READ transports )
59 Q_PROPERTY( QQmlListProperty<QObject> registeredObjects READ registeredObjects )
60
61public:
62 explicit QQmlWebChannel(QObject *parent = Q_NULLPTR);
63 virtual ~QQmlWebChannel();
64
65 Q_INVOKABLE void registerObjects(const QVariantMap &objects);
66 QQmlListProperty<QObject> registeredObjects();
67
68 QQmlListProperty<QObject> transports();
69
70 static QQmlWebChannelAttached *qmlAttachedProperties(QObject *obj);
71
72 Q_INVOKABLE void connectTo(QObject *transport);
73 Q_INVOKABLE void disconnectFrom(QObject *transport);
74
75private:
76 Q_DECLARE_PRIVATE(QQmlWebChannel)
77 Q_PRIVATE_SLOT(d_func(), void _q_objectIdChanged(const QString &newId))
78
79 static void registeredObjects_append(QQmlListProperty<QObject> *prop, QObject *item);
80 static int registeredObjects_count(QQmlListProperty<QObject> *prop);
81 static QObject *registeredObjects_at(QQmlListProperty<QObject> *prop, int index);
82 static void registeredObjects_clear(QQmlListProperty<QObject> *prop);
83
84 static void transports_append(QQmlListProperty<QObject> *prop, QObject *item);
85 static int transports_count(QQmlListProperty<QObject> *prop);
86 static QObject *transports_at(QQmlListProperty<QObject> *prop, int index);
87 static void transports_clear(QQmlListProperty<QObject> *prop);
88};
89
90QT_END_NAMESPACE
91
92QML_DECLARE_TYPE( QQmlWebChannel )
93QML_DECLARE_TYPEINFO( QQmlWebChannel, QML_HAS_ATTACHED_PROPERTIES )
94
95#endif // QQMLWEBCHANNEL_H
96

source code of qtwebchannel/src/webchannel/qqmlwebchannel.h