/usr/share/doc/libquazip-doc/html/classQuaZIODevice.html is in libquazip-doc 0.7.3-5ubuntu1.
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 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>QuaZIP: QuaZIODevice Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">QuaZIP
 <span id="projectnumber">quazip-0-7-3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classQuaZIODevice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QuaZIODevice Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class to compress/decompress QIODevice.
<a href="classQuaZIODevice.html#details">More...</a></p>
<p><code>#include <<a class="el" href="quaziodevice_8h_source.html">quaziodevice.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for QuaZIODevice:</div>
<div class="dyncontent">
<div class="center"><img src="classQuaZIODevice__inherit__graph.png" border="0" usemap="#QuaZIODevice_inherit__map" alt="Inheritance graph"/></div>
<map name="QuaZIODevice_inherit__map" id="QuaZIODevice_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for QuaZIODevice:</div>
<div class="dyncontent">
<div class="center"><img src="classQuaZIODevice__coll__graph.png" border="0" usemap="#QuaZIODevice_coll__map" alt="Collaboration graph"/></div>
<map name="QuaZIODevice_coll__map" id="QuaZIODevice_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8321ed35ee9b57cf9b1104912e236361"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#a8321ed35ee9b57cf9b1104912e236361">QuaZIODevice</a> (QIODevice *io, QObject *parent=NULL)</td></tr>
<tr class="memdesc:a8321ed35ee9b57cf9b1104912e236361"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a8321ed35ee9b57cf9b1104912e236361">More...</a><br/></td></tr>
<tr class="separator:a8321ed35ee9b57cf9b1104912e236361"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3524cef44c240c21e6b7680ee5f42de"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3524cef44c240c21e6b7680ee5f42de"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#ab3524cef44c240c21e6b7680ee5f42de">~QuaZIODevice</a> ()</td></tr>
<tr class="memdesc:ab3524cef44c240c21e6b7680ee5f42de"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr class="separator:ab3524cef44c240c21e6b7680ee5f42de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25f586eb564841b51c395fd17f1cc080"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#a25f586eb564841b51c395fd17f1cc080">flush</a> ()</td></tr>
<tr class="memdesc:a25f586eb564841b51c395fd17f1cc080"><td class="mdescLeft"> </td><td class="mdescRight">Flushes data waiting to be written. <a href="#a25f586eb564841b51c395fd17f1cc080">More...</a><br/></td></tr>
<tr class="separator:a25f586eb564841b51c395fd17f1cc080"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a175446c18eb20c9aff6faf23f09cc67a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#a175446c18eb20c9aff6faf23f09cc67a">open</a> (QIODevice::OpenMode mode)</td></tr>
<tr class="memdesc:a175446c18eb20c9aff6faf23f09cc67a"><td class="mdescLeft"> </td><td class="mdescRight">Opens the device. <a href="#a175446c18eb20c9aff6faf23f09cc67a">More...</a><br/></td></tr>
<tr class="separator:a175446c18eb20c9aff6faf23f09cc67a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad27e447544d57f897316ee6f44535895"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#ad27e447544d57f897316ee6f44535895">close</a> ()</td></tr>
<tr class="memdesc:ad27e447544d57f897316ee6f44535895"><td class="mdescLeft"> </td><td class="mdescRight">Closes this device, but not the underlying one. <a href="#ad27e447544d57f897316ee6f44535895">More...</a><br/></td></tr>
<tr class="separator:ad27e447544d57f897316ee6f44535895"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad63e7f1717c7d91b3c2c5ace908c98b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad63e7f1717c7d91b3c2c5ace908c98b7"></a>
QIODevice * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#ad63e7f1717c7d91b3c2c5ace908c98b7">getIoDevice</a> () const </td></tr>
<tr class="memdesc:ad63e7f1717c7d91b3c2c5ace908c98b7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the underlying device. <br/></td></tr>
<tr class="separator:ad63e7f1717c7d91b3c2c5ace908c98b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2697f58c228741d3715801bf48a9a8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2697f58c228741d3715801bf48a9a8b"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#af2697f58c228741d3715801bf48a9a8b">isSequential</a> () const </td></tr>
<tr class="memdesc:af2697f58c228741d3715801bf48a9a8b"><td class="mdescLeft"> </td><td class="mdescRight">Returns true. <br/></td></tr>
<tr class="separator:af2697f58c228741d3715801bf48a9a8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae727c48089ca1b161323ec8423a653ab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae727c48089ca1b161323ec8423a653ab"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#ae727c48089ca1b161323ec8423a653ab">atEnd</a> () const </td></tr>
<tr class="memdesc:ae727c48089ca1b161323ec8423a653ab"><td class="mdescLeft"> </td><td class="mdescRight">Returns true iff the end of the compressed stream is reached. <br/></td></tr>
<tr class="separator:ae727c48089ca1b161323ec8423a653ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac18b45c3d7009c8d231b13fe994ebcb9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac18b45c3d7009c8d231b13fe994ebcb9"></a>
virtual qint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#ac18b45c3d7009c8d231b13fe994ebcb9">bytesAvailable</a> () const </td></tr>
<tr class="memdesc:ac18b45c3d7009c8d231b13fe994ebcb9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of the bytes buffered. <br/></td></tr>
<tr class="separator:ac18b45c3d7009c8d231b13fe994ebcb9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aa12b8bc9c923e543eda9ae22dbd1ecbb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa12b8bc9c923e543eda9ae22dbd1ecbb"></a>
virtual qint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#aa12b8bc9c923e543eda9ae22dbd1ecbb">readData</a> (char *data, qint64 maxSize)</td></tr>
<tr class="memdesc:aa12b8bc9c923e543eda9ae22dbd1ecbb"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of QIODevice::readData(). <br/></td></tr>
<tr class="separator:aa12b8bc9c923e543eda9ae22dbd1ecbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab23b6badbc3548eb71ca86bf6211902"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab23b6badbc3548eb71ca86bf6211902"></a>
virtual qint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZIODevice.html#aab23b6badbc3548eb71ca86bf6211902">writeData</a> (const char *data, qint64 maxSize)</td></tr>
<tr class="memdesc:aab23b6badbc3548eb71ca86bf6211902"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of QIODevice::writeData(). <br/></td></tr>
<tr class="separator:aab23b6badbc3548eb71ca86bf6211902"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class to compress/decompress QIODevice. </p>
<p>This class can be used to compress any data written to QIODevice or decompress it back. Compressing data sent over a QTcpSocket is a good example. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8321ed35ee9b57cf9b1104912e236361"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QuaZIODevice::QuaZIODevice </td>
<td>(</td>
<td class="paramtype">QIODevice * </td>
<td class="paramname"><em>io</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QObject * </td>
<td class="paramname"><em>parent</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">io</td><td>The QIODevice to read/write. </td></tr>
<tr><td class="paramname">parent</td><td>The parent object, as per QObject logic. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a25f586eb564841b51c395fd17f1cc080"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool QuaZIODevice::flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flushes data waiting to be written. </p>
<p>Unfortunately, as QIODevice doesn't support <a class="el" href="classQuaZIODevice.html#a25f586eb564841b51c395fd17f1cc080" title="Flushes data waiting to be written. ">flush()</a> by itself, the only thing this method does is write the compressed data into the device using Z_SYNC_FLUSH mode. If you need the compressed data to actually be flushed from the buffer of the underlying QIODevice, you need to call its <a class="el" href="classQuaZIODevice.html#a25f586eb564841b51c395fd17f1cc080" title="Flushes data waiting to be written. ">flush()</a> method as well, providing it supports it (like QTcpSocket does). Example: </p>
<div class="fragment"><div class="line"><a class="code" href="classQuaZIODevice.html">QuaZIODevice</a> dev(&sock);</div>
<div class="line">dev.open(QIODevice::Write);</div>
<div class="line">dev.write(yourDataGoesHere);</div>
<div class="line">dev.flush();</div>
<div class="line">sock->flush(); <span class="comment">// this actually sends data to network</span></div>
</div><!-- fragment --><p>This may change in the future versions of QuaZIP by implementing an ugly hack: trying to cast the QIODevice using qobject_cast to known <a class="el" href="classQuaZIODevice.html#a25f586eb564841b51c395fd17f1cc080" title="Flushes data waiting to be written. ">flush()</a>-supporting subclasses, and calling flush if the resulting pointer is not zero. </p>
<p>Referenced by <a class="el" href="classQuaZIODevice.html#ad27e447544d57f897316ee6f44535895">close()</a>.</p>
</div>
</div>
<a class="anchor" id="a175446c18eb20c9aff6faf23f09cc67a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool QuaZIODevice::open </td>
<td>(</td>
<td class="paramtype">QIODevice::OpenMode </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens the device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>Neither QIODevice::ReadWrite nor QIODevice::Append are not supported. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad27e447544d57f897316ee6f44535895"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void QuaZIODevice::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes this device, but not the underlying one. </p>
<p>The underlying QIODevice is not closed in case you want to write something else to it. </p>
<p>References <a class="el" href="classQuaZIODevice.html#a25f586eb564841b51c395fd17f1cc080">flush()</a>.</p>
<p>Referenced by <a class="el" href="classQuaZIODevice.html#ab3524cef44c240c21e6b7680ee5f42de">~QuaZIODevice()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>quazip/<a class="el" href="quaziodevice_8h_source.html">quaziodevice.h</a></li>
<li>quazip/quaziodevice.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 4 2017 22:19:38 for QuaZIP by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|