summaryrefslogtreecommitdiff
path: root/src/webchannel/doc/src/index.qdoc
blob: 5f354bd21355811d7ee52a96042b1667d4ca0539 (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
/****************************************************************************
**
** 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.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 the host
    (QML/C++ application) and the client (HTML/JavaScript application). The
    transport mechanism is supported out of the box by the two popular web
    engines, Qt WebKit 2 and Qt WebEngine (experimental). It works on all
    browsers that support Qt WebSockets, enabling Qt WebChannel applications
    to run in any JavaScript runtime. Additionally, a custom transport
    mechanism can also be implemented using Qt WebSockets to support Qt
    WebChannel-based communication.

    The module provides a JavaScript library for seamless integration of C++
    and QML applications with HTML/JavaScript clients. The client must use the
    JavaScript library to access the serialized QObjects published by the host
    applications.

    \section1 Related Information

    \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}
    \li \l{Qt WebChannel Examples}{Examples} - show how use the API in practice
    \endlist
*/