1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Copyright (C) 2014 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtWebChannel module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QWEBCHANNEL_H
#define QWEBCHANNEL_H
#include <QObject>
#include <QJsonValue>
#include <QtWebChannel/qwebchannelglobal.h>
QT_BEGIN_NAMESPACE
struct QWebChannelPrivate;
class QWebChannelTransportInterface;
class Q_WEBCHANNEL_EXPORT QWebChannel : public QObject
{
Q_OBJECT
Q_DISABLE_COPY(QWebChannel)
Q_PROPERTY(bool blockUpdates READ blockUpdates WRITE setBlockUpdates NOTIFY blockUpdatesChanged);
public:
explicit QWebChannel(QObject *parent = 0);
~QWebChannel();
/**
* Register a map of string ID to QObject* objects.
*
* The properties, signals and public methods of the QObject are
* published to the remote client, where an object with the given identifier
* is constructed.
*
* TODO: This must be called, before clients are initialized.
*/
void registerObjects(const QHash<QString, QObject*> &objects);
Q_INVOKABLE void registerObject(const QString &id, QObject *object);
Q_INVOKABLE void deregisterObject(QObject *object);
/**
* @return true when property updates are blocked, false otherwise.
*/
bool blockUpdates() const;
/**
* Set whether property updates should be blocked or not.
*
* When they are blocked, the remote clients will not be notified about
* property changes. The changes are recorded and sent to the clients once
* setBlockUpdates(false) is called.
*/
void setBlockUpdates(bool block);
void connectTo(QWebChannelTransportInterface *transport);
void disconnectFrom(QWebChannelTransportInterface *transport);
signals:
void blockUpdatesChanged(bool block);
public slots:
void sendMessage(const QJsonValue &id, const QJsonValue &data = QJsonValue()) const;
void respond(const QJsonValue &messageId, const QJsonValue &data = QJsonValue()) const;
private:
QScopedPointer<QWebChannelPrivate> d;
friend class QmlWebChannel;
friend class TestWebChannel;
};
QT_END_NAMESPACE
#endif // QWEBCHANNEL_H
|
