/usr/share/qt5/doc/qtwebchannel/qml-qtwebchannel-webchannel.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qqmlwebchannel.cpp -->
<title>WebChannel QML Type | 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-qmlmodule.html">QML Types</a></td><td >WebChannel QML Type</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="#attached-properties">Attached Properties</a></li>
<li class="level1"><a href="#methods">Methods</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">WebChannel QML Type</h1>
<span class="subtitle"></span>
<!-- $$$WebChannel-brief -->
<p>QML interface to <a href="qwebchannel.html">QWebChannel</a>. <a href="#details">More...</a></p>
<!-- @@@WebChannel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtWebChannel 1.0</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="qml-qtwebchannel-webchannel-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><b><a href="qml-qtwebchannel-webchannel.html#registeredObjects-prop">registeredObjects</a></b></b> : QQmlListProperty<QObject></li>
<li class="fn"><b><b><a href="qml-qtwebchannel-webchannel.html#transports-prop">transports</a></b></b> : QQmlListProperty<QObject></li>
</ul>
<a name="attached-properties"></a>
<h2 id="attached-properties">Attached Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtwebchannel-webchannel.html#id-attached-prop">id</a></b></b> : QString</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtwebchannel-webchannel.html#connectTo-method">connectTo</a></b></b>(QWebChannelAbstractTransport <i>transport</i>)</li>
<li class="fn">void <b><b><a href="qml-qtwebchannel-webchannel.html#disconnectFrom-method">disconnectFrom</a></b></b>(QWebChannelAbstractTransport <i>transport</i>)</li>
<li class="fn">void <b><b><a href="qml-qtwebchannel-webchannel.html#registerObjects-method">registerObjects</a></b></b>(QVariantMap <i>objects</i>)</li>
</ul>
<!-- $$$WebChannel-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The WebChannel provides a mechanism to transparently access QObject or QML objects from HTML clients. All properties, signals and public slots can be used from the HTML clients.</p>
<p><b>See also </b><a href="qwebchannel.html">QWebChannel</a> and <a href="qtwebchannel-javascript.html">JavaScript API</a>.</p>
<!-- @@@WebChannel -->
<h2>Property Documentation</h2>
<!-- $$$registeredObjects -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="registeredObjects-prop">
<td class="tblQmlPropNode"><p>
<a name="registeredObjects-prop"></a><span class="name">registeredObjects</span> : <span class="type">QQmlListProperty</span><<span class="type">QObject</span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>A list of objects which should be accessible to remote clients.</p>
<p>The objects must have the attached <a href="qml-qtwebchannel-webchannel.html#id-attached-prop">id</a> property set to an identifier, under which the object is then known on the HTML side.</p>
<p>Once registered, all signals and property changes are automatically propagated to the clients. Public invokable methods, including slots, are also accessible to the clients.</p>
<p>If one needs to register objects which are not available when the component is created, use the imperative <a href="qml-qtwebchannel-webchannel.html#registerObjects-method">registerObjects</a> method.</p>
<p><b>See also </b><a href="qml-qtwebchannel-webchannel.html#registerObjects-method">registerObjects()</a> and <a href="qml-qtwebchannel-webchannel.html#id-attached-prop">id</a>.</p>
</div></div><!-- @@@registeredObjects -->
<br/>
<!-- $$$transports -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="transports-prop">
<td class="tblQmlPropNode"><p>
<a name="transports-prop"></a><span class="name">transports</span> : <span class="type">QQmlListProperty</span><<span class="type">QObject</span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>A list of transport objects, which implement <a href="qwebchannelabstracttransport.html">QWebChannelAbstractTransport</a>. The transports are used to talk to the remote clients.</p>
<p><b>See also </b><a href="qml-qtwebchannel-webchannel.html#connectTo-method">connectTo()</a> and <a href="qml-qtwebchannel-webchannel.html#disconnectFrom-method">disconnectFrom()</a>.</p>
</div></div><!-- @@@transports -->
<br/>
<h2>Attached Property Documentation</h2>
<!-- $$$id -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="id-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="id-attached-prop"></a><span class="name">WebChannel.id</span> : <span class="type">QString</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The identifier under which an object, registered to a WebChannel, is known to remote clients.</p>
<p>This property must be set for every object that should be published over the WebChannel. While no restrictions are enforced on the format of the id, it is usually a good idea to choose a string that is also a valid JavaScript identifier.</p>
</div></div><!-- @@@id -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$connectTo -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="connectTo-method">
<td class="tblQmlFuncNode"><p>
<a name="connectTo-method"></a><span class="type">void</span> <span class="name">connectTo</span>(<span class="type">QWebChannelAbstractTransport</span> <i>transport</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Connects to the <i>transport</i>, which represents a communication channel to a single client.</p>
<p>The transport object must be an implementation of <a href="qwebchannelabstracttransport.html">QWebChannelAbstractTransport</a>.</p>
<p><b>See also </b><a href="qml-qtwebchannel-webchannel.html#transports-prop">transports</a> and <a href="qml-qtwebchannel-webchannel.html#disconnectFrom-method">disconnectFrom()</a>.</p>
</div></div><!-- @@@connectTo -->
<br/>
<!-- $$$disconnectFrom -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="disconnectFrom-method">
<td class="tblQmlFuncNode"><p>
<a name="disconnectFrom-method"></a><span class="type">void</span> <span class="name">disconnectFrom</span>(<span class="type">QWebChannelAbstractTransport</span> <i>transport</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Disconnects the <i>transport</i> from this WebChannel.</p>
<p>The client will not be able to communicate with the WebChannel anymore, nor will it receive any signals or property updates.</p>
<p><b>See also </b><a href="qml-qtwebchannel-webchannel.html#connectTo-method">connectTo()</a>.</p>
</div></div><!-- @@@disconnectFrom -->
<br/>
<!-- $$$registerObjects -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="registerObjects-method">
<td class="tblQmlFuncNode"><p>
<a name="registerObjects-method"></a><span class="type">void</span> <span class="name">registerObjects</span>(<span class="type">QVariantMap</span> <i>objects</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Registers objects to make them accessible to HTML clients. The key of the map is used as an identifier for the object on the client side.</p>
<p>Once registered, all signals and property changes are automatically propagated to the clients. Public invokable methods, including slots, are also accessible to the clients.</p>
<p>This imperative API can be used to register objects on the fly. For static objects, the declarative <a href="qml-qtwebchannel-webchannel.html#registeredObjects-prop">registeredObjects</a> property should be preferred.</p>
<p><b>See also </b><a href="qml-qtwebchannel-webchannel.html#registeredObjects-prop">registeredObjects</a>.</p>
</div></div><!-- @@@registerObjects -->
<br/>
</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>
|