summaryrefslogtreecommitdiff
path: root/examples/webchannel/standalone/doc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/webchannel/standalone/doc')
-rw-r--r--examples/webchannel/standalone/doc/images/standalone-screenshot.pngbin0 -> 30363 bytes
-rw-r--r--examples/webchannel/standalone/doc/src/standalone.qdoc62
2 files changed, 62 insertions, 0 deletions
diff --git a/examples/webchannel/standalone/doc/images/standalone-screenshot.png b/examples/webchannel/standalone/doc/images/standalone-screenshot.png
new file mode 100644
index 0000000..3c55e19
--- /dev/null
+++ b/examples/webchannel/standalone/doc/images/standalone-screenshot.png
Binary files differ
diff --git a/examples/webchannel/standalone/doc/src/standalone.qdoc b/examples/webchannel/standalone/doc/src/standalone.qdoc
new file mode 100644
index 0000000..a445bb9
--- /dev/null
+++ b/examples/webchannel/standalone/doc/src/standalone.qdoc
@@ -0,0 +1,62 @@
+/****************************************************************************
+**
+** 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:LGPL21$
+** 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 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file. Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** 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.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \example standalone
+ \title Qt WebChannel Standalone Example
+ \ingroup qtwebchannel-examples
+ \image standalone-screenshot.png
+ \brief Shows how to use the QWebChannel C++ API to communicate with an external client.
+
+ The standalone example is a simple chat between a C++ application and a remote HTML
+ client running in your default browser.
+
+ \include examples-run.qdocinc
+
+ \section1 Overview
+
+ The C++ application sets up a QWebChannel instance and publishes a Dialog object over it.
+ For the remote client side, \l {standalone/index.html}{index.html} is opened. Both show a
+ dialog with the list of received messages and an input box to send messages to the other end.
+
+ The Dialog emits the Dialog::sendText() signal when the user sends a message. The signal
+ automatically gets propagated to the HTML client. When the user enters a message on the HTML
+ side, Dialog::receiveText() is called.
+
+ All communication between the HTML client and the C++ server is done over a WebSocket.
+ The C++ side instantiates a QWebSocketServer and wraps incoming QWebSocket connections
+ in WebSocketTransport objects, which implement QWebChannelAbstractTransport. These objects are
+ then connected to the QWebChannel instance.
+
+ \sa {Qt WebChannel JavaScript API}
+*/