diff options
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | src/webchannel/doc/src/javascript.qdoc | 4 | ||||
| -rw-r--r-- | src/webchannel/doc/src/module.qdoc | 2 | ||||
| -rw-r--r-- | src/webchannel/qwebchannel.cpp | 4 | ||||
| -rw-r--r-- | src/webchannel/qwebchannelabstracttransport.cpp | 2 |
5 files changed, 9 insertions, 9 deletions
@@ -3,7 +3,7 @@ The Qt WebChannel module offers Qt applications a seamless way to publish `QObjects` for interaction with HTML/JavaScript clients. These clients can either be inside local Qt `WebView`s or any other, potentially remote, client which supports JavaScript, as long as a communication channel such -as WebSockets is available. +as WebSocket is available. Qt WebChannel uses introspection on the `QObject`s and sends this serialized data to the clients. There, with the help of a small JavaScript library, an object is created which simulates the API of @@ -12,7 +12,7 @@ written. Additionally you can connect to signals and register JavaScript callbac ### Dependencies -This module depends on Qt Core only. Optionally, an additional plugin for Qt Quick is build, which +This module depends on Qt Core only. Optionally, an additional plugin for Qt Quick can be built, which makes it easy to use a `QWebChannel` from QML. Note that this module alone is not functional. It is being used in e.g. Qt WebKit to provide a seamless integration of QML/C++ QObjects into JavaScript clients. You can integrate it in your projects as well, by providing an implementation of the @@ -30,7 +30,7 @@ To use the Qt/C++ library, add the following to your `QMake` project: QT += webchannel -Then, in your C++ code, construct a a webchannel, then publish your `QObject`s: +Then, in your C++ code, construct a webchannel, then publish your `QObject`s: QWebChannel channel; channel.registerObject(QStringLiteral("foo"), myFooObj); diff --git a/src/webchannel/doc/src/javascript.qdoc b/src/webchannel/doc/src/javascript.qdoc index 36bc4ab..de211d0 100644 --- a/src/webchannel/doc/src/javascript.qdoc +++ b/src/webchannel/doc/src/javascript.qdoc @@ -34,7 +34,7 @@ \section1 Setup To communicate with a QWebChannel or WebChannel, any HTML client must use and setup the - JavaScript API provided by \c qwebchannel.js. For HTML clients run inside QtWebKit, you + JavaScript API provided by \c qwebchannel.js. For HTML clients run inside Qt WebKit, you can load the file via \c qrc:///qtwebchannel/qwebchannel.js. For external clients you will need to copy the file to your webserver. Then instantiate a QWebChannel object and pass it a transport object and a callback function, which will be invoked once the @@ -44,7 +44,7 @@ with a \c send() function, which takes a stringified JSON message and transmits it to the server-side QWebChannelAbstractTransport object. Furthermore, its \c onmessage property should be called when a message from the server was received. This interface is implemented internally - by the QtWebKit navigator.qtWebChannelTransport object. Alternatively, you can also use a + by the Qt WebKit navigator.qtWebChannelTransport object. Alternatively, you can also use a WebSocket, which also implements this interface. Note that the JavaScript QWebChannel object should be constructed once the transport object is diff --git a/src/webchannel/doc/src/module.qdoc b/src/webchannel/doc/src/module.qdoc index 345485e..2c07873 100644 --- a/src/webchannel/doc/src/module.qdoc +++ b/src/webchannel/doc/src/module.qdoc @@ -31,7 +31,7 @@ \ingroup modules \qtvariable webchannel \since 5.4 - \brief List of C++ classes that provide the QtWebChannel functionality. + \brief List of C++ classes that provide the Qt WebChannel functionality. To use these classes in your application, use the following include statement: diff --git a/src/webchannel/qwebchannel.cpp b/src/webchannel/qwebchannel.cpp index 0d096b4..99becfb 100644 --- a/src/webchannel/qwebchannel.cpp +++ b/src/webchannel/qwebchannel.cpp @@ -140,7 +140,7 @@ QWebChannel::~QWebChannel() /*! Register a group of objects to the QWebChannel. - The properties, signals and public methods of the objects are published to the remote clients. + The properties, signals and public invokable methods of the objects are published to the remote clients. There, an object with the identifier used as key in the \a objects map is then constructed. \note A current limitation is that objects must be registered before any client is initialized. @@ -203,7 +203,7 @@ void QWebChannel::deregisterObject(QObject *object) \brief When set to true, updates are blocked and remote clients will not be notified about property changes. The changes are recorded and sent to the clients once updates become unblocked again by setting - this property to false. + this property to false. By default, updates are not blocked. */ diff --git a/src/webchannel/qwebchannelabstracttransport.cpp b/src/webchannel/qwebchannelabstracttransport.cpp index 0d56ff6..f261698 100644 --- a/src/webchannel/qwebchannelabstracttransport.cpp +++ b/src/webchannel/qwebchannelabstracttransport.cpp @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE Users of the QWebChannel must implement this interface and connect instances of it to the QWebChannel server for every client that should be connected to the QWebChannel. - The {Standalone Example} shows how this can be done using QtWebSockets. QtWebKit implements + The {Standalone Example} shows how this can be done using Qt WebSockets. Qt WebKit implements this interface internally and uses the native WebKit IPC mechanism to transmit messages to HTML clients. |