blob: ac9c415a73a66e3808cd8b04af1b3b5e84219a6e (
plain)
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
|
/****************************************************************************
**
** 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.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtwebchannel-index.html
\since 5.4
\title Qt WebChannel
\brief Bridges the gap between Qt applications and HTML/JavaScript.
Qt WebChannel enables peer-to-peer communication between a server (QML/C++
application) and a client (HTML/JavaScript or QML application). It is
supported out of the box by \l{Qt WebEngine}. In addition, it can work on
all browsers that support \l{Qt WebSockets}{WebSockets}, enabling Qt
WebChannel clients to run in any JavaScript environment (including QML).
This requires implementing a custom transport based on Qt WebSockets.
The module provides a JavaScript library for seamless integration of C++ and
QML applications with HTML/JavaScript and QML clients. The clients must use
the JavaScript library to access the serialized QObjects published by the
host applications.
\section1 Using the Module
\section2 QML API
\include {module-use.qdocinc} {using the qml api} {QtWebChannel}
\section2 C++ API
\include {module-use.qdocinc} {using the c++ api}
\section3 Building with CMake
\include {module-use.qdocinc} {building with cmake} {WebChannel}
\section3 Building with qmake
\include {module-use.qdocinc} {building_with_qmake} {webchannel}
\section1 Examples
\list
\li \l {Qt WebChannel Examples} {Examples}
\endlist
\section1 Reference
\list
\li \l {Qt WebChannel JavaScript API} {JavaScript API}
\li \l {Qt WebChannel C++ Classes} {C++ API}
\li \l {Qt WebChannel QML Types} {QML API}
\endlist
\section1 Licenses
Qt WebChannel is available under commercial licenses from
\l{The Qt Company}.
In addition, it is available under free software licenses.
These free software licenses are
\l{GNU Lesser General Public License, version 3}, or
the \l{GNU General Public License, version 2}.
See \l{Qt Licensing} for further details.
*/
|
