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
112
113
114
|
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Copyright (C) 2013 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 QWebChannel module on Qt labs.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QTMETAOBJECTPUBLISHER_H
#define QTMETAOBJECTPUBLISHER_H
#include <QObject>
#include <QVariant>
class QWebChannel;
struct QtMetaObjectPublisherPrivate;
class QtMetaObjectPublisher : public QObject
{
Q_OBJECT
Q_PROPERTY(QWebChannel *webChannel READ webChannel WRITE setWebChannel NOTIFY webChannelChanged);
Q_PROPERTY(bool blockUpdates READ blockUpdates WRITE setBlockUpdates NOTIFY blockUpdatesChanged);
public:
explicit QtMetaObjectPublisher(QObject *parent = 0);
virtual ~QtMetaObjectPublisher();
Q_INVOKABLE QVariantMap classInfoForObjects(const QVariantMap &objects) const;
Q_INVOKABLE QVariantMap classInfoForObject(QObject *object) const;
/**
* 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.
*/
Q_INVOKABLE void registerObjects(const QVariantMap &objects);
/**
* Handle the given WebChannel client request and potentially give a response.
*
* @return true if the request was handled, false otherwise.
*/
Q_INVOKABLE bool handleRequest(const QJsonObject &message);
QWebChannel *webChannel() const;
void setWebChannel(QWebChannel *webChannel);
/**
* When updates are blocked, no property updates are transmitted to remote clients.
*/
bool blockUpdates() const;
void setBlockUpdates(bool block);
/// TODO: cleanup: rewrite tests in C++ and access PIMPL data from there
Q_INVOKABLE void bench_ensureUpdatesInitialized();
Q_INVOKABLE void bench_sendPendingPropertyUpdates();
Q_INVOKABLE void bench_registerObjects(const QVariantMap &objects);
Q_INVOKABLE void bench_initializeClients();
Q_INVOKABLE bool test_clientIsIdle() const;
signals:
void webChannelChanged(QWebChannel *channel);
void blockUpdatesChanged(bool block);
protected:
virtual void timerEvent(QTimerEvent *);
private:
QScopedPointer<QtMetaObjectPublisherPrivate> d;
friend struct QtMetaObjectPublisherPrivate;
};
#endif // QTMETAOBJECTPUBLISHER_H
|
