diff options
author | Milian Wolff <milian.wolff@kdab.com> | 2014-07-16 17:39:31 +0200 |
---|---|---|
committer | Sumedha Widyadharma <sumedha.widyadharma@basyskom.com> | 2014-08-01 09:16:16 +0200 |
commit | b84e46090b5230d7ebcdbdabd8c03a9ae5d2f860 (patch) | |
tree | 9687c3b47f4e77e931916a8afe1d516d3b280101 /src/webchannel/qwebchannel.h | |
parent | 5051411b92b4aca4ed5ec462e7b0e52af4d3951e (diff) | |
download | qtwebchannel-b84e46090b5230d7ebcdbdabd8c03a9ae5d2f860.tar.gz |
Add documentation for the QtWebChannel module.
Please proof-read it and tell me what needs to be improved. I assume
most people will probably not use the QWebChannel directly. Rather, they
will only consume its features indirectly through the integration in
QtWebKit/QtWebEngine. Thus the documentation here is for QWebChannel as
a library. User-end documentation should be added to QtWebKit, I think.
Change-Id: I259c204e24331271b8dc74ea11695988234a79d3
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/webchannel/qwebchannel.h')
-rw-r--r-- | src/webchannel/qwebchannel.h | 19 |
1 files changed, 0 insertions, 19 deletions
diff --git a/src/webchannel/qwebchannel.h b/src/webchannel/qwebchannel.h index 46d77a3..7701751 100644 --- a/src/webchannel/qwebchannel.h +++ b/src/webchannel/qwebchannel.h @@ -62,32 +62,13 @@ public: explicit QWebChannel(QObject *parent = 0); ~QWebChannel(); - /** - * Register a map of string ID to QObject* objects. - * - * The properties, signals and public methods of the QObject are - * published to the remote client, where an object with the given identifier - * is constructed. - * - * TODO: This must be called, before clients are initialized. - */ void registerObjects(const QHash<QString, QObject*> &objects); QHash<QString, QObject*> registeredObjects() const; Q_INVOKABLE void registerObject(const QString &id, QObject *object); Q_INVOKABLE void deregisterObject(QObject *object); - /** - * @return true when property updates are blocked, false otherwise. - */ bool blockUpdates() const; - /** - * Set whether property updates should be blocked or not. - * - * When they are blocked, the remote clients will not be notified about - * property changes. The changes are recorded and sent to the clients once - * setBlockUpdates(false) is called. - */ void setBlockUpdates(bool block); Q_SIGNALS: |