Make the QWebChannel QML API publically accessible.

This is required for proper QtWebKit/QtWebEngine integration, as
otherwise these modules would have to redo a lot of the QtWebChannel
QML API. Furthermore, without this, we could not use the WebChannel.id
attached property everywhere, independent of the web browser technology.

Change-Id: I032a9326841d505c2f77959a240bbfc71e94b6e8
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

1 files changed, 97 insertions, 0 deletions

diff --git a/src/webchannel/qqmlwebchannel.h b/src/webchannel/qqmlwebchannel.h
new file mode 100644
index 0000000..3bbd2a0
--- /dev/null
+++ b/src/webchannel/qqmlwebchannel.h
@@ -0,0 +1,97 @@
+/****************************************************************************
+**
+** 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 QQMLWEBCHANNEL_H
+#define QQMLWEBCHANNEL_H
+
+#include <QtWebChannel/QWebChannel>
+#include <QtWebChannel/qwebchannelglobal.h>
+
+#include <QtQml/qqml.h>
+#include <QtQml/QQmlListProperty>
+
+QT_BEGIN_NAMESPACE
+
+class QQmlWebChannelPrivate;
+class QQmlWebChannelAttached;
+class Q_WEBCHANNEL_EXPORT QQmlWebChannel : public QWebChannel
+{
+    Q_OBJECT
+    Q_DISABLE_COPY(QQmlWebChannel)
+
+    Q_PROPERTY( QQmlListProperty<QObject> transports READ transports );
+    Q_PROPERTY( QQmlListProperty<QObject> registeredObjects READ registeredObjects )
+
+public:
+    explicit QQmlWebChannel(QObject *parent = 0);
+    virtual ~QQmlWebChannel();
+
+    Q_INVOKABLE void registerObjects(const QVariantMap &objects);
+    QQmlListProperty<QObject> registeredObjects();
+
+    QQmlListProperty<QObject> transports();
+
+    static QQmlWebChannelAttached *qmlAttachedProperties(QObject *obj);
+
+    Q_INVOKABLE void connectTo(QObject *transport);
+    Q_INVOKABLE void disconnectFrom(QObject *transport);
+
+private:
+    Q_DECLARE_PRIVATE(QQmlWebChannel)
+    Q_PRIVATE_SLOT(d_func(), void _q_objectIdChanged(const QString &newId));
+
+    static void registeredObjects_append(QQmlListProperty<QObject> *prop, QObject *item);
+    static int registeredObjects_count(QQmlListProperty<QObject> *prop);
+    static QObject *registeredObjects_at(QQmlListProperty<QObject> *prop, int index);
+    static void registeredObjects_clear(QQmlListProperty<QObject> *prop);
+
+    static void transports_append(QQmlListProperty<QObject> *prop, QObject *item);
+    static int transports_count(QQmlListProperty<QObject> *prop);
+    static QObject *transports_at(QQmlListProperty<QObject> *prop, int index);
+    static void transports_clear(QQmlListProperty<QObject> *prop);
+};
+
+QML_DECLARE_TYPE( QQmlWebChannel )
+QML_DECLARE_TYPEINFO( QQmlWebChannel, QML_HAS_ATTACHED_PROPERTIES )
+
+QT_END_NAMESPACE
+
+#endif // QQMLWEBCHANNEL_H