/usr/share/qt5/doc/qtbluetooth/qbluetoothtransferreply.html is in qtconnectivity5-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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qbluetoothtransferreply.cpp -->
<title>QBluetoothTransferReply Class | Qt Bluetooth 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="qtbluetooth-index.html">Qt Bluetooth</a></td><td ><a href="qtbluetooth-module.html">C++ Classes</a></td><td >QBluetoothTransferReply</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="#public-types">Public Types</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="#protected-functions">Protected Functions</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">QBluetoothTransferReply Class</h1>
<!-- $$$QBluetoothTransferReply-brief -->
<p>The <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> class stores the response for a data transfer request. <a href="#details">More...</a></p>
<!-- @@@QBluetoothTransferReply -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QBluetoothTransferReply></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += bluetooth</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qbluetoothtransferreply-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#TransferError-enum">TransferError</a></b> { NoError, UnknownError, FileNotFoundError, HostNotFoundError, ..., SessionError }</td></tr>
</table></div>
<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="qbluetoothtransferreply.html#dtor.QBluetoothTransferReply">~QBluetoothTransferReply</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual TransferError </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#error">error</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#errorString">errorString</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#isFinished">isFinished</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#isRunning">isRunning</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBluetoothTransferManager *</td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#manager">manager</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBluetoothTransferRequest </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#request">request</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<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="qbluetoothtransferreply.html#abort">abort</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
</ul>
<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="qbluetoothtransferreply.html#error-1">error</a></b>(QBluetoothTransferReply::TransferError <i>errorType</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#finished">finished</a></b>(QBluetoothTransferReply *<i>reply</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#transferProgress">transferProgress</a></b>(qint64 <i>bytesTransferred</i>, qint64 <i>bytesTotal</i>)</td></tr>
</table></div>
<ul>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#QBluetoothTransferReply">QBluetoothTransferReply</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#setManager">setManager</a></b>(QBluetoothTransferManager *<i>manager</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbluetoothtransferreply.html#setRequest">setRequest</a></b>(const QBluetoothTransferRequest &<i>request</i>)</td></tr>
</table></div>
<ul>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QBluetoothTransferReply-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> class stores the response for a data transfer request.</p>
<p>In additional to a copy of the <a href="qbluetoothtransferrequest.html">QBluetoothTransferRequest</a> object used to create the request, <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> contains the contents of the reply itself.</p>
<p>After the file transfer has started, <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> emits the <a href="qbluetoothtransferreply.html#transferProgress">transferProgress</a>() signal, which indicates the progress of the file transfer.</p>
</div>
<!-- @@@QBluetoothTransferReply -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$TransferError$$$NoError$$$UnknownError$$$FileNotFoundError$$$HostNotFoundError$$$UserCanceledTransferError$$$IODeviceNotReadableError$$$ResourceBusyError$$$SessionError -->
<h3 class="fn" id="TransferError-enum"><a name="TransferError-enum"></a>enum QBluetoothTransferReply::<span class="name">TransferError</span></h3>
<p>This enum describes the type of error that occurred</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QBluetoothTransferReply::NoError</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">No error.</td></tr>
<tr><td class="topAlign"><code>QBluetoothTransferReply::UnknownError</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Unknown error, no better enum available.</td></tr>
<tr><td class="topAlign"><code>QBluetoothTransferReply::FileNotFoundError</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Unable to open the file specified.</td></tr>
<tr><td class="topAlign"><code>QBluetoothTransferReply::HostNotFoundError</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Unable to connect to the target host.</td></tr>
<tr><td class="topAlign"><code>QBluetoothTransferReply::UserCanceledTransferError</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">User terminated the transfer.</td></tr>
<tr><td class="topAlign"><code>QBluetoothTransferReply::IODeviceNotReadableError</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">File was not open before initiating the sending command.</td></tr>
<tr><td class="topAlign"><code>QBluetoothTransferReply::ResourceBusyError</code></td><td class="topAlign tblval"><code>6</code></td><td class="topAlign">Unable to access the resource..</td></tr>
<tr><td class="topAlign"><code>QBluetoothTransferReply::SessionError</code></td><td class="topAlign tblval"><code>7</code></td><td class="topAlign">An error occurred during the handling of the session. This enum was introduced by Qt 5.4.</td></tr>
</table></div>
<!-- @@@TransferError -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QBluetoothTransferReply[overload1]$$$QBluetoothTransferReplyQObject* -->
<h3 class="fn" id="QBluetoothTransferReply"><a name="QBluetoothTransferReply"></a><code>[protected] </code>QBluetoothTransferReply::<span class="name">QBluetoothTransferReply</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a new <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> with <i>parent</i>.</p>
<!-- @@@QBluetoothTransferReply -->
<!-- $$$~QBluetoothTransferReply[overload1]$$$~QBluetoothTransferReply -->
<h3 class="fn" id="dtor.QBluetoothTransferReply"><a name="dtor.QBluetoothTransferReply"></a>QBluetoothTransferReply::<span class="name">~QBluetoothTransferReply</span>()</h3>
<p>Destroys the <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> object.</p>
<!-- @@@~QBluetoothTransferReply -->
<!-- $$$abort[overload1]$$$abort -->
<h3 class="fn" id="abort"><a name="abort"></a><code>[slot] </code><span class="type">void</span> QBluetoothTransferReply::<span class="name">abort</span>()</h3>
<p>Aborts this reply.</p>
<!-- @@@abort -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn" id="error"><a name="error"></a><code>[pure virtual] </code><span class="type"><a href="qbluetoothtransferreply.html#TransferError-enum">TransferError</a></span> QBluetoothTransferReply::<span class="name">error</span>() const</h3>
<p>The error code of the error that occurred.</p>
<p><b>See also </b><a href="qbluetoothtransferreply.html#errorString">errorString</a>().</p>
<!-- @@@error -->
<!-- $$$error$$$errorQBluetoothTransferReply::TransferError -->
<h3 class="fn" id="error-1"><a name="error-1"></a><code>[signal] </code><span class="type">void</span> QBluetoothTransferReply::<span class="name">error</span>(<span class="type"><a href="qbluetoothtransferreply.html#TransferError-enum">QBluetoothTransferReply::TransferError</a></span> <i>errorType</i>)</h3>
<p>This signal is emitted whenever an error has occurred. The <i>errorType</i> parameter indicates the type of error.</p>
<p>To avoid the loss of signal emissions it is recommend to immidiately connect to this signal once a <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> instance has been created.</p>
<p><b>Note:</b> Signal <i>error</i> is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:<pre class="cpp">
connect(bluetoothTransferReply<span class="operator">,</span> <span class="keyword">static_cast</span><span class="operator"><</span><span class="type">void</span>(<span class="type"><a href="qbluetoothtransferreply.html#QBluetoothTransferReply">QBluetoothTransferReply</a></span><span class="operator">::</span><span class="operator">*</span>)(<span class="type"><a href="qbluetoothtransferreply.html#QBluetoothTransferReply">QBluetoothTransferReply</a></span><span class="operator">::</span>TransferError)<span class="operator">></span>(<span class="operator">&</span><span class="type"><a href="qbluetoothtransferreply.html#QBluetoothTransferReply">QBluetoothTransferReply</a></span><span class="operator">::</span>error)<span class="operator">,</span>
<span class="operator">[</span><span class="operator">=</span><span class="operator">]</span>(<span class="type"><a href="qbluetoothtransferreply.html#QBluetoothTransferReply">QBluetoothTransferReply</a></span><span class="operator">::</span>TransferError errorType){ <span class="comment">/* ... */</span> });
</pre>
<p>This function was introduced in Qt 5.4.</p>
<p><b>See also </b><a href="qbluetoothtransferreply.html#error">error</a>() and <a href="qbluetoothtransferreply.html#errorString">errorString</a>().</p>
<!-- @@@error -->
<!-- $$$errorString[overload1]$$$errorString -->
<h3 class="fn" id="errorString"><a name="errorString"></a><code>[pure virtual] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QBluetoothTransferReply::<span class="name">errorString</span>() const</h3>
<p>String describing the error. Can be displayed to the user.</p>
<p><b>See also </b><a href="qbluetoothtransferreply.html#error">error</a>().</p>
<!-- @@@errorString -->
<!-- $$$finished[overload1]$$$finishedQBluetoothTransferReply* -->
<h3 class="fn" id="finished"><a name="finished"></a><code>[signal] </code><span class="type">void</span> QBluetoothTransferReply::<span class="name">finished</span>(<span class="type"><a href="qbluetoothtransferreply.html#QBluetoothTransferReply">QBluetoothTransferReply</a></span> *<i>reply</i>)</h3>
<p>This signal is emitted when the transfer is complete for <i>reply</i>.</p>
<p>To avoid the loss of signal emissions it is recommend to immidiately connect to this signal once a <code>QBluetoothTransferReply</code> instance has been created.</p>
<!-- @@@finished -->
<!-- $$$isFinished[overload1]$$$isFinished -->
<h3 class="fn" id="isFinished"><a name="isFinished"></a><code>[pure virtual] </code><span class="type">bool</span> QBluetoothTransferReply::<span class="name">isFinished</span>() const</h3>
<p>Returns true if this reply has finished, otherwise false.</p>
<!-- @@@isFinished -->
<!-- $$$isRunning[overload1]$$$isRunning -->
<h3 class="fn" id="isRunning"><a name="isRunning"></a><code>[pure virtual] </code><span class="type">bool</span> QBluetoothTransferReply::<span class="name">isRunning</span>() const</h3>
<p>Returns true if this reply is running, otherwise false.</p>
<!-- @@@isRunning -->
<!-- $$$manager[overload1]$$$manager -->
<h3 class="fn" id="manager"><a name="manager"></a><span class="type"><a href="qbluetoothtransfermanager.html">QBluetoothTransferManager</a></span> *QBluetoothTransferReply::<span class="name">manager</span>() const</h3>
<p>Returns the <a href="qbluetoothtransfermanager.html">QBluetoothTransferManager</a> that was used to create this <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> object. Initially, it is also the parent object.</p>
<p><b>See also </b><a href="qbluetoothtransferreply.html#setManager">setManager</a>().</p>
<!-- @@@manager -->
<!-- $$$request[overload1]$$$request -->
<h3 class="fn" id="request"><a name="request"></a><span class="type"><a href="qbluetoothtransferrequest.html">QBluetoothTransferRequest</a></span> QBluetoothTransferReply::<span class="name">request</span>() const</h3>
<p>Returns the <a href="qbluetoothtransferrequest.html">QBluetoothTransferRequest</a> that was used to create this <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> object.</p>
<p><b>See also </b><a href="qbluetoothtransferreply.html#setRequest">setRequest</a>().</p>
<!-- @@@request -->
<!-- $$$setManager[overload1]$$$setManagerQBluetoothTransferManager* -->
<h3 class="fn" id="setManager"><a name="setManager"></a><code>[protected] </code><span class="type">void</span> QBluetoothTransferReply::<span class="name">setManager</span>(<span class="type"><a href="qbluetoothtransfermanager.html">QBluetoothTransferManager</a></span> *<i>manager</i>)</h3>
<p>Set the reply's manager to the <i>manager</i>.</p>
<p><b>See also </b><a href="qbluetoothtransferreply.html#manager">manager</a>().</p>
<!-- @@@setManager -->
<!-- $$$setRequest[overload1]$$$setRequestconstQBluetoothTransferRequest& -->
<h3 class="fn" id="setRequest"><a name="setRequest"></a><code>[protected] </code><span class="type">void</span> QBluetoothTransferReply::<span class="name">setRequest</span>(const <span class="type"><a href="qbluetoothtransferrequest.html">QBluetoothTransferRequest</a></span> &<i>request</i>)</h3>
<p>Set the reply's request to <i>request</i>.</p>
<p><b>See also </b><a href="qbluetoothtransferreply.html#request">request</a>().</p>
<!-- @@@setRequest -->
<!-- $$$transferProgress[overload1]$$$transferProgressqint64qint64 -->
<h3 class="fn" id="transferProgress"><a name="transferProgress"></a><code>[signal] </code><span class="type">void</span> QBluetoothTransferReply::<span class="name">transferProgress</span>(<span class="type"><a href="../qtcore/qtglobal.html#qint64-typedef">qint64</a></span> <i>bytesTransferred</i>, <span class="type"><a href="../qtcore/qtglobal.html#qint64-typedef">qint64</a></span> <i>bytesTotal</i>)</h3>
<p>This signal is emitted whenever data is transferred. The <i>bytesTransferred</i> parameter contains the total number of bytes transferred so far out of <i>bytesTotal</i>.</p>
<p>To avoid the loss of signal emissions it is recommend to immidiately connect to this signal once a <a href="qbluetoothtransferreply.html">QBluetoothTransferReply</a> instance has been created.</p>
<!-- @@@transferProgress -->
</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>
|