/usr/share/qt5/doc/qtwebchannel/qwebchannel.html is in qtwebchannel5-doc-html 5.9.5-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwebchannel.cpp -->
<title>QWebChannel Class | Qt WebChannel 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtwebchannel-index.html">Qt WebChannel</a></td><td ><a href="qtwebchannel-module.html">C++ Classes</a></td><td >QWebChannel</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QWebChannel Class</h1>
<!-- $$$QWebChannel-brief -->
<p>Exposes QObjects to remote HTML clients. <a href="#details">More...</a></p>
<!-- @@@QWebChannel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWebChannel></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += webchannel</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.4</td></tr></table></div><ul>
<li><a href="qwebchannel-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qwebchannel.html#blockUpdates-prop">blockUpdates</a></b> : bool</li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#QWebChannel">QWebChannel</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#dtor.QWebChannel">~QWebChannel</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#blockUpdates-prop">blockUpdates</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#deregisterObject">deregisterObject</a></b>(QObject *<i>object</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#registerObject">registerObject</a></b>(const QString &<i>id</i>, QObject *<i>object</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#registerObjects">registerObjects</a></b>(const QHash<QString, QObject *> &<i>objects</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHash<QString, QObject *> </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#registeredObjects">registeredObjects</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#blockUpdates-prop">setBlockUpdates</a></b>(bool <i>block</i>)</td></tr>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#connectTo">connectTo</a></b>(QWebChannelAbstractTransport *<i>transport</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#disconnectFrom">disconnectFrom</a></b>(QWebChannelAbstractTransport *<i>transport</i>)</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwebchannel.html#blockUpdates-prop">blockUpdatesChanged</a></b>(bool <i>block</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QWebChannel-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Exposes QObjects to remote HTML clients.</p>
<p>The <a href="qwebchannel.html">QWebChannel</a> fills the gap between C++ applications and HTML/JavaScript applications. By publishing a QObject derived object to a <a href="qwebchannel.html">QWebChannel</a> and using the <a href="qtwebchannel-javascript.html">qwebchannel.js</a> on the HTML side, one can transparently access properties and public slots and methods of the QObject. No manual message passing and serialization of data is required, property updates and signal emission on the C++ side get automatically transmitted to the potentially remotely running HTML clients. On the client side, a JavaScript object will be created for any published C++ QObject. It mirrors the C++ object's API and thus is intuitively useable.</p>
<p>The C++ <a href="qwebchannel.html">QWebChannel</a> API makes it possible to talk to any HTML client, which could run on a local or even remote machine. The only limitation is that the HTML client supports the JavaScript features used by <code>qwebchannel.js</code>. As such, one can interact with basically any modern HTML browser or standalone JavaScript runtime, such as node.js.</p>
<p>There also exists a declarative <a href="qtwebchannel-qmlmodule.html">WebChannel API</a>.</p>
</div>
<p><b>See also </b><a href="qtwebchannel-standalone-example.html">Qt WebChannel Standalone Example</a> and <a href="qtwebchannel-javascript.html">JavaScript API</a>.</p>
<!-- @@@QWebChannel -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$blockUpdates-prop$$$blockUpdates$$$setBlockUpdatesbool$$$blockUpdatesChangedbool -->
<h3 class="fn" id="blockUpdates-prop"><a name="blockUpdates-prop"></a><span class="name">blockUpdates</span> : <span class="type">bool</span></h3>
<p>When set to true, updates are blocked and remote clients will not be notified about property changes.</p>
<p>The changes are recorded and sent to the clients once updates become unblocked again by setting this property to false. By default, updates are not blocked.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>blockUpdates</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBlockUpdates</b></span>(bool <i>block</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>blockUpdatesChanged</b></span>(bool <i>block</i>)</td></tr>
</table></div>
<!-- @@@blockUpdates -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWebChannel[overload1]$$$QWebChannelQObject* -->
<h3 class="fn" id="QWebChannel"><a name="QWebChannel"></a>QWebChannel::<span class="name">QWebChannel</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs the <a href="qwebchannel.html">QWebChannel</a> object with the given <i>parent</i>.</p>
<p>Note that a <a href="qwebchannel.html">QWebChannel</a> is only fully operational once you connect it to a <a href="qwebchannelabstracttransport.html">QWebChannelAbstractTransport</a>. The HTML clients also need to be setup appropriately using <a href="qtwebchannel-javascript.html"><code>qwebchannel.js</code></a>.</p>
<!-- @@@QWebChannel -->
<!-- $$$~QWebChannel[overload1]$$$~QWebChannel -->
<h3 class="fn" id="dtor.QWebChannel"><a name="dtor.QWebChannel"></a>QWebChannel::<span class="name">~QWebChannel</span>()</h3>
<p>Destroys the <a href="qwebchannel.html">QWebChannel</a>.</p>
<!-- @@@~QWebChannel -->
<!-- $$$connectTo[overload1]$$$connectToQWebChannelAbstractTransport* -->
<h3 class="fn" id="connectTo"><a name="connectTo"></a><code>[slot] </code><span class="type">void</span> QWebChannel::<span class="name">connectTo</span>(<span class="type"><a href="qwebchannelabstracttransport.html">QWebChannelAbstractTransport</a></span> *<i>transport</i>)</h3>
<p>Connects the <a href="qwebchannel.html">QWebChannel</a> to the given <i>transport</i> object.</p>
<p>The transport object then handles the communication between the C++ application and a remote HTML client.</p>
<p><b>See also </b><a href="qwebchannelabstracttransport.html">QWebChannelAbstractTransport</a> and <a href="qwebchannel.html#disconnectFrom">QWebChannel::disconnectFrom</a>().</p>
<!-- @@@connectTo -->
<!-- $$$deregisterObject[overload1]$$$deregisterObjectQObject* -->
<h3 class="fn" id="deregisterObject"><a name="deregisterObject"></a><span class="type">void</span> QWebChannel::<span class="name">deregisterObject</span>(<span class="type">QObject</span> *<i>object</i>)</h3>
<p>Deregisters the given <i>object</i> from the <a href="qwebchannel.html">QWebChannel</a>.</p>
<p>Remote clients will receive a <code>destroyed</code> signal for the given object.</p>
<p><b>See also </b><a href="qwebchannel.html#registerObjects">QWebChannel::registerObjects</a>(), <a href="qwebchannel.html#registerObject">QWebChannel::registerObject</a>(), and <a href="qwebchannel.html#registeredObjects">QWebChannel::registeredObjects</a>().</p>
<!-- @@@deregisterObject -->
<!-- $$$disconnectFrom[overload1]$$$disconnectFromQWebChannelAbstractTransport* -->
<h3 class="fn" id="disconnectFrom"><a name="disconnectFrom"></a><code>[slot] </code><span class="type">void</span> QWebChannel::<span class="name">disconnectFrom</span>(<span class="type"><a href="qwebchannelabstracttransport.html">QWebChannelAbstractTransport</a></span> *<i>transport</i>)</h3>
<p>Disconnects the <a href="qwebchannel.html">QWebChannel</a> from the <i>transport</i> object.</p>
<p><b>See also </b><a href="qwebchannel.html#connectTo">QWebChannel::connectTo</a>().</p>
<!-- @@@disconnectFrom -->
<!-- $$$registerObject[overload1]$$$registerObjectconstQString&QObject* -->
<h3 class="fn" id="registerObject"><a name="registerObject"></a><span class="type">void</span> QWebChannel::<span class="name">registerObject</span>(const <span class="type">QString</span> &<i>id</i>, <span class="type">QObject</span> *<i>object</i>)</h3>
<p>Registers a single object to the <a href="qwebchannel.html">QWebChannel</a>.</p>
<p>The properties, signals and public methods of the <i>object</i> are published to the remote clients. There, an object with the identifier <i>id</i> is then constructed.</p>
<p><b>Note: </b>A current limitation is that objects must be registered before any client is initialized.</p><p><b>See also </b><a href="qwebchannel.html#registerObjects">QWebChannel::registerObjects</a>(), <a href="qwebchannel.html#deregisterObject">QWebChannel::deregisterObject</a>(), and <a href="qwebchannel.html#registeredObjects">QWebChannel::registeredObjects</a>().</p>
<!-- @@@registerObject -->
<!-- $$$registerObjects[overload1]$$$registerObjectsconstQHash<QString,QObject*>& -->
<h3 class="fn" id="registerObjects"><a name="registerObjects"></a><span class="type">void</span> QWebChannel::<span class="name">registerObjects</span>(const <span class="type">QHash</span><<span class="type">QString</span>, <span class="type">QObject</span> *> &<i>objects</i>)</h3>
<p>Registers a group of objects to the <a href="qwebchannel.html">QWebChannel</a>.</p>
<p>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 <i>objects</i> map is then constructed.</p>
<p><b>Note: </b>A current limitation is that objects must be registered before any client is initialized.</p><p><b>See also </b><a href="qwebchannel.html#registerObject">QWebChannel::registerObject</a>(), <a href="qwebchannel.html#deregisterObject">QWebChannel::deregisterObject</a>(), and <a href="qwebchannel.html#registeredObjects">QWebChannel::registeredObjects</a>().</p>
<!-- @@@registerObjects -->
<!-- $$$registeredObjects[overload1]$$$registeredObjects -->
<h3 class="fn" id="registeredObjects"><a name="registeredObjects"></a><span class="type">QHash</span><<span class="type">QString</span>, <span class="type">QObject</span> *> QWebChannel::<span class="name">registeredObjects</span>() const</h3>
<p>Returns the map of registered objects that are published to remote clients.</p>
<p><b>See also </b><a href="qwebchannel.html#registerObjects">QWebChannel::registerObjects</a>(), <a href="qwebchannel.html#registerObject">QWebChannel::registerObject</a>(), and <a href="qwebchannel.html#deregisterObject">QWebChannel::deregisterObject</a>().</p>
<!-- @@@registeredObjects -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|