<!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.11"/>
<title>FGx: QuaZip 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FGx
 <span id="projectnumber">1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classQuaZip-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QuaZip Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>ZIP archive.
<a href="classQuaZip.html#details">More...</a></p>
<p><code>#include <<a class="el" href="quazip_8h_source.html">quazip/quazip.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:adce46b942c341dbb5c851eadead65459"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#adce46b942c341dbb5c851eadead65459">Constants</a> { <a class="el" href="classQuaZip.html#adce46b942c341dbb5c851eadead65459ab26ce1a9c9e94f901dc2cf90fa5baa4b">MAX_FILE_NAME_LENGTH</a> =256
}<tr class="memdesc:adce46b942c341dbb5c851eadead65459"><td class="mdescLeft"> </td><td class="mdescRight">Useful constants. <a href="classQuaZip.html#adce46b942c341dbb5c851eadead65459">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:adce46b942c341dbb5c851eadead65459"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47e28d4116ee716fdd6b431b821d0be4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4">Mode</a> { <br />
  <a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4ac87ddb1e901e1ec700c16ee0d4d398ce">mdNotOpen</a>,
<a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a803a371910c2dc830d111e9ce5b58897">mdUnzip</a>,
<a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a25ae05b12590540af8c66ae8298b928e">mdCreate</a>,
<a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4ab807f0c65653a16d77b365801fd25582">mdAppend</a>,
<br />
  <a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a22c745f349f06add449af523254fdaec">mdAdd</a>
<br />
}<tr class="memdesc:a47e28d4116ee716fdd6b431b821d0be4"><td class="mdescLeft"> </td><td class="mdescRight">Open mode of the ZIP file. <a href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a47e28d4116ee716fdd6b431b821d0be4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6053a1d249ed210a85c9d5eb7cf9cdbe"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbe">CaseSensitivity</a> { <a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbeac3cca8c0b976cf6397a28a5c84e75253">csDefault</a> =0,
<a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbead8d86b0c34203336cad09348cfa5356e">csSensitive</a> =1,
<a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbea3e492bcc3f64f41a74906cecc45fb366">csInsensitive</a> =2
}<tr class="memdesc:a6053a1d249ed210a85c9d5eb7cf9cdbe"><td class="mdescLeft"> </td><td class="mdescRight">Case sensitivity for the file names. <a href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbe">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a6053a1d249ed210a85c9d5eb7cf9cdbe"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a970e0f401c7cfd7a78e78572f758eec4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a970e0f401c7cfd7a78e78572f758eec4">QuaZip</a> ()</td></tr>
<tr class="memdesc:a970e0f401c7cfd7a78e78572f758eec4"><td class="mdescLeft"> </td><td class="mdescRight">Constructs <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> object. <a href="#a970e0f401c7cfd7a78e78572f758eec4">More...</a><br /></td></tr>
<tr class="separator:a970e0f401c7cfd7a78e78572f758eec4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaea7294b02abd22379cc3a9fccb754b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaea7294b02abd22379cc3a9fccb754b7"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#aaea7294b02abd22379cc3a9fccb754b7">QuaZip</a> (const QString &zipName)</td></tr>
<tr class="memdesc:aaea7294b02abd22379cc3a9fccb754b7"><td class="mdescLeft"> </td><td class="mdescRight">Constructs <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> object associated with ZIP file <em>zipName</em>. <br /></td></tr>
<tr class="separator:aaea7294b02abd22379cc3a9fccb754b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae52ebadd5ce64cdb49d7e198904b0b8c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#ae52ebadd5ce64cdb49d7e198904b0b8c">QuaZip</a> (QIODevice *ioDevice)</td></tr>
<tr class="memdesc:ae52ebadd5ce64cdb49d7e198904b0b8c"><td class="mdescLeft"> </td><td class="mdescRight">Constructs <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> object associated with ZIP file represented by <em>ioDevice</em>. <a href="#ae52ebadd5ce64cdb49d7e198904b0b8c">More...</a><br /></td></tr>
<tr class="separator:ae52ebadd5ce64cdb49d7e198904b0b8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af60a2d3930b90f3b25a3148baecad81e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#af60a2d3930b90f3b25a3148baecad81e">~QuaZip</a> ()</td></tr>
<tr class="memdesc:af60a2d3930b90f3b25a3148baecad81e"><td class="mdescLeft"> </td><td class="mdescRight">Destroys <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> object. <a href="#af60a2d3930b90f3b25a3148baecad81e">More...</a><br /></td></tr>
<tr class="separator:af60a2d3930b90f3b25a3148baecad81e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfa4e6018b2964a3d10a4c54e5ab3962"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#abfa4e6018b2964a3d10a4c54e5ab3962">open</a> (<a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4">Mode</a> mode, <a class="el" href="structzlib__filefunc__def__s.html">zlib_filefunc_def</a> *ioApi=NULL)</td></tr>
<tr class="memdesc:abfa4e6018b2964a3d10a4c54e5ab3962"><td class="mdescLeft"> </td><td class="mdescRight">Opens ZIP file. <a href="#abfa4e6018b2964a3d10a4c54e5ab3962">More...</a><br /></td></tr>
<tr class="separator:abfa4e6018b2964a3d10a4c54e5ab3962"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a4323b73e12f3b4470109f200728f9f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a7a4323b73e12f3b4470109f200728f9f">close</a> ()</td></tr>
<tr class="memdesc:a7a4323b73e12f3b4470109f200728f9f"><td class="mdescLeft"> </td><td class="mdescRight">Closes ZIP file. <a href="#a7a4323b73e12f3b4470109f200728f9f">More...</a><br /></td></tr>
<tr class="separator:a7a4323b73e12f3b4470109f200728f9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a339010b5566704ba3c9cafbfe848d8fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a339010b5566704ba3c9cafbfe848d8fb">setFileNameCodec</a> (QTextCodec *fileNameCodec)</td></tr>
<tr class="memdesc:a339010b5566704ba3c9cafbfe848d8fb"><td class="mdescLeft"> </td><td class="mdescRight">Sets the codec used to encode/decode file names inside archive. <a href="#a339010b5566704ba3c9cafbfe848d8fb">More...</a><br /></td></tr>
<tr class="separator:a339010b5566704ba3c9cafbfe848d8fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f283519a195aa1d9076bbbb01ea0497"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a8f283519a195aa1d9076bbbb01ea0497">setFileNameCodec</a> (const char *fileNameCodecName)</td></tr>
<tr class="memdesc:a8f283519a195aa1d9076bbbb01ea0497"><td class="mdescLeft"> </td><td class="mdescRight">Sets the codec used to encode/decode file names inside archive. <a href="#a8f283519a195aa1d9076bbbb01ea0497">More...</a><br /></td></tr>
<tr class="separator:a8f283519a195aa1d9076bbbb01ea0497"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27b866aa2c75ea6f9c438cbb6e32b43c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27b866aa2c75ea6f9c438cbb6e32b43c"></a>
QTextCodec * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a27b866aa2c75ea6f9c438cbb6e32b43c">getFileNameCodec</a> () const </td></tr>
<tr class="memdesc:a27b866aa2c75ea6f9c438cbb6e32b43c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the codec used to encode/decode comments inside archive. <br /></td></tr>
<tr class="separator:a27b866aa2c75ea6f9c438cbb6e32b43c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c81fca7215a4374f6f03872ade4885b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a1c81fca7215a4374f6f03872ade4885b">setCommentCodec</a> (QTextCodec *commentCodec)</td></tr>
<tr class="memdesc:a1c81fca7215a4374f6f03872ade4885b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the codec used to encode/decode comments inside archive. <a href="#a1c81fca7215a4374f6f03872ade4885b">More...</a><br /></td></tr>
<tr class="separator:a1c81fca7215a4374f6f03872ade4885b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a413f3c56b54a9a47258d53802cb606e7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a413f3c56b54a9a47258d53802cb606e7">setCommentCodec</a> (const char *commentCodecName)</td></tr>
<tr class="memdesc:a413f3c56b54a9a47258d53802cb606e7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the codec used to encode/decode comments inside archive. <a href="#a413f3c56b54a9a47258d53802cb606e7">More...</a><br /></td></tr>
<tr class="separator:a413f3c56b54a9a47258d53802cb606e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a008260161781d8b5d2a0a28493fddaf4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a008260161781d8b5d2a0a28493fddaf4"></a>
QTextCodec * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a008260161781d8b5d2a0a28493fddaf4">getCommentCodec</a> () const </td></tr>
<tr class="memdesc:a008260161781d8b5d2a0a28493fddaf4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the codec used to encode/decode comments inside archive. <br /></td></tr>
<tr class="separator:a008260161781d8b5d2a0a28493fddaf4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f7deef08ff40aeb1a7a04bcd7f228c2"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a4f7deef08ff40aeb1a7a04bcd7f228c2">getZipName</a> () const </td></tr>
<tr class="memdesc:a4f7deef08ff40aeb1a7a04bcd7f228c2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the ZIP file. <a href="#a4f7deef08ff40aeb1a7a04bcd7f228c2">More...</a><br /></td></tr>
<tr class="separator:a4f7deef08ff40aeb1a7a04bcd7f228c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa80b661de1262af905d1677dbcb008cc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#aa80b661de1262af905d1677dbcb008cc">setZipName</a> (const QString &zipName)</td></tr>
<tr class="memdesc:aa80b661de1262af905d1677dbcb008cc"><td class="mdescLeft"> </td><td class="mdescRight">Sets the name of the ZIP file. <a href="#aa80b661de1262af905d1677dbcb008cc">More...</a><br /></td></tr>
<tr class="separator:aa80b661de1262af905d1677dbcb008cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd3ba12fe68748acbf8b7cc14a5a1c29"><td class="memItemLeft" align="right" valign="top">QIODevice * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#afd3ba12fe68748acbf8b7cc14a5a1c29">getIoDevice</a> () const </td></tr>
<tr class="memdesc:afd3ba12fe68748acbf8b7cc14a5a1c29"><td class="mdescLeft"> </td><td class="mdescRight">Returns the device representing this ZIP file. <a href="#afd3ba12fe68748acbf8b7cc14a5a1c29">More...</a><br /></td></tr>
<tr class="separator:afd3ba12fe68748acbf8b7cc14a5a1c29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64642948b6531ee54f5522f29e388cc6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a64642948b6531ee54f5522f29e388cc6">setIoDevice</a> (QIODevice *ioDevice)</td></tr>
<tr class="memdesc:a64642948b6531ee54f5522f29e388cc6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the device representing the ZIP file. <a href="#a64642948b6531ee54f5522f29e388cc6">More...</a><br /></td></tr>
<tr class="separator:a64642948b6531ee54f5522f29e388cc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a129ceff04d28fb00531f7bf7f9329664"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a129ceff04d28fb00531f7bf7f9329664"></a>
<a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4">Mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a129ceff04d28fb00531f7bf7f9329664">getMode</a> () const </td></tr>
<tr class="memdesc:a129ceff04d28fb00531f7bf7f9329664"><td class="mdescLeft"> </td><td class="mdescRight">Returns the mode in which ZIP file was opened. <br /></td></tr>
<tr class="separator:a129ceff04d28fb00531f7bf7f9329664"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b869a9c0d4f49955b759592fec08888"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b869a9c0d4f49955b759592fec08888"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a5b869a9c0d4f49955b759592fec08888">isOpen</a> () const </td></tr>
<tr class="memdesc:a5b869a9c0d4f49955b759592fec08888"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if ZIP file is open, <code>false</code> otherwise. <br /></td></tr>
<tr class="separator:a5b869a9c0d4f49955b759592fec08888"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28b91a6282ddd9382c96a069572c6fb4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4">getZipError</a> () const </td></tr>
<tr class="memdesc:a28b91a6282ddd9382c96a069572c6fb4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the error code of the last operation. <a href="#a28b91a6282ddd9382c96a069572c6fb4">More...</a><br /></td></tr>
<tr class="separator:a28b91a6282ddd9382c96a069572c6fb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ea4bd1fca948637c35c2d2752bb5a80"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a2ea4bd1fca948637c35c2d2752bb5a80">getEntriesCount</a> () const </td></tr>
<tr class="memdesc:a2ea4bd1fca948637c35c2d2752bb5a80"><td class="mdescLeft"> </td><td class="mdescRight">Returns number of the entries in the ZIP central directory. <a href="#a2ea4bd1fca948637c35c2d2752bb5a80">More...</a><br /></td></tr>
<tr class="separator:a2ea4bd1fca948637c35c2d2752bb5a80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae55cfbf2296132df808c557b62433051"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae55cfbf2296132df808c557b62433051"></a>
QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#ae55cfbf2296132df808c557b62433051">getComment</a> () const </td></tr>
<tr class="memdesc:ae55cfbf2296132df808c557b62433051"><td class="mdescLeft"> </td><td class="mdescRight">Returns global comment in the ZIP file. <br /></td></tr>
<tr class="separator:ae55cfbf2296132df808c557b62433051"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b5d936a203859340574d5908ffa2222"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a1b5d936a203859340574d5908ffa2222">setComment</a> (const QString &comment)</td></tr>
<tr class="memdesc:a1b5d936a203859340574d5908ffa2222"><td class="mdescLeft"> </td><td class="mdescRight">Sets global comment in the ZIP file. <a href="#a1b5d936a203859340574d5908ffa2222">More...</a><br /></td></tr>
<tr class="separator:a1b5d936a203859340574d5908ffa2222"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a745488f9177bcec3cdb858587584e033"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a745488f9177bcec3cdb858587584e033">goToFirstFile</a> ()</td></tr>
<tr class="memdesc:a745488f9177bcec3cdb858587584e033"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current file to the first file in the archive. <a href="#a745488f9177bcec3cdb858587584e033">More...</a><br /></td></tr>
<tr class="separator:a745488f9177bcec3cdb858587584e033"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee6779b6cd338420c2e8c5655fa8ba97"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#aee6779b6cd338420c2e8c5655fa8ba97">goToNextFile</a> ()</td></tr>
<tr class="memdesc:aee6779b6cd338420c2e8c5655fa8ba97"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current file to the next file in the archive. <a href="#aee6779b6cd338420c2e8c5655fa8ba97">More...</a><br /></td></tr>
<tr class="separator:aee6779b6cd338420c2e8c5655fa8ba97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c657bfcfccb59d728e0da24c677d899"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a6c657bfcfccb59d728e0da24c677d899">setCurrentFile</a> (const QString &fileName, <a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbe">CaseSensitivity</a> cs=<a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbeac3cca8c0b976cf6397a28a5c84e75253">csDefault</a>)</td></tr>
<tr class="memdesc:a6c657bfcfccb59d728e0da24c677d899"><td class="mdescLeft"> </td><td class="mdescRight">Sets current file by its name. <a href="#a6c657bfcfccb59d728e0da24c677d899">More...</a><br /></td></tr>
<tr class="separator:a6c657bfcfccb59d728e0da24c677d899"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00b237d926648f45da86db25e7cfb697"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00b237d926648f45da86db25e7cfb697"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a00b237d926648f45da86db25e7cfb697">hasCurrentFile</a> () const </td></tr>
<tr class="memdesc:a00b237d926648f45da86db25e7cfb697"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if the current file has been set. <br /></td></tr>
<tr class="separator:a00b237d926648f45da86db25e7cfb697"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c91a53ed4c2038e153c64bdc097ebe8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a9c91a53ed4c2038e153c64bdc097ebe8">getCurrentFileInfo</a> (<a class="el" href="structQuaZipFileInfo.html">QuaZipFileInfo</a> *info) const </td></tr>
<tr class="memdesc:a9c91a53ed4c2038e153c64bdc097ebe8"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about the current file. <a href="#a9c91a53ed4c2038e153c64bdc097ebe8">More...</a><br /></td></tr>
<tr class="separator:a9c91a53ed4c2038e153c64bdc097ebe8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9783f8b4f39cd55e71e975aea78fd54a"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a9783f8b4f39cd55e71e975aea78fd54a">getCurrentFileName</a> () const </td></tr>
<tr class="memdesc:a9783f8b4f39cd55e71e975aea78fd54a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current file name. <a href="#a9783f8b4f39cd55e71e975aea78fd54a">More...</a><br /></td></tr>
<tr class="separator:a9783f8b4f39cd55e71e975aea78fd54a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b78a652f296ff4a678a791e8294e642"><td class="memItemLeft" align="right" valign="top">unzFile </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a3b78a652f296ff4a678a791e8294e642">getUnzFile</a> ()</td></tr>
<tr class="memdesc:a3b78a652f296ff4a678a791e8294e642"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>unzFile</code> handle. <a href="#a3b78a652f296ff4a678a791e8294e642">More...</a><br /></td></tr>
<tr class="separator:a3b78a652f296ff4a678a791e8294e642"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a425043a4d7cc31e2fe2bba73d954f15c"><td class="memItemLeft" align="right" valign="top">zipFile </td><td class="memItemRight" valign="bottom"><a class="el" href="classQuaZip.html#a425043a4d7cc31e2fe2bba73d954f15c">getZipFile</a> ()</td></tr>
<tr class="memdesc:a425043a4d7cc31e2fe2bba73d954f15c"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>zipFile</code> handle. <a href="#a425043a4d7cc31e2fe2bba73d954f15c">More...</a><br /></td></tr>
<tr class="separator:a425043a4d7cc31e2fe2bba73d954f15c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a5d400b33a69412e9d419a484aaf476cd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d400b33a69412e9d419a484aaf476cd"></a>
class </td><td class="memItemRight" valign="bottom"><b>QuaZipPrivate</b></td></tr>
<tr class="separator:a5d400b33a69412e9d419a484aaf476cd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>ZIP archive. </p>
<p>This class implements basic interface to the ZIP archive. It can be used to read table contents of the ZIP archive and retreiving information about the files inside it.</p>
<p>You can also use this class to open files inside archive by passing pointer to the instance of this class to the constructor of the <a class="el" href="classQuaZipFile.html" title="A file inside ZIP archive. ">QuaZipFile</a> class. But see <a class="el" href="classQuaZipFile.html#a54e944a6b3d27030f64c8f30d2cc33bb" title="Constructs a QuaZipFile instance. ">QuaZipFile::QuaZipFile(QuaZip*, QObject*)</a> for the possible pitfalls.</p>
<p>This class is indended to provide interface to the ZIP subpackage of the ZIP/UNZIP package as well as to the UNZIP subpackage. But currently it supports only UNZIP.</p>
<p>The use of this class is simple - just create instance using constructor, then set ZIP archive file name using setFile() function (if you did not passed the name to the constructor), then <a class="el" href="classQuaZip.html#abfa4e6018b2964a3d10a4c54e5ab3962" title="Opens ZIP file. ">open()</a> and then use different functions to work with it! Well, if you are paranoid, you may also wish to call close before destructing the instance, to check for errors on close.</p>
<p>You may also use <a class="el" href="classQuaZip.html#a3b78a652f296ff4a678a791e8294e642" title="Returns unzFile handle. ">getUnzFile()</a> and <a class="el" href="classQuaZip.html#a425043a4d7cc31e2fe2bba73d954f15c" title="Returns zipFile handle. ">getZipFile()</a> functions to get the ZIP archive handle and use it with ZIP/UNZIP package API directly.</p>
<p>This class supports localized file names inside ZIP archive, but you have to set up proper codec with setCodec() function. By default, locale codec will be used, which is probably ok for UNIX systems, but will almost certainly fail with ZIP archives created in Windows. This is because Windows ZIP programs have strange habit of using DOS encoding for file names in ZIP archives. For example, ZIP archive with cyrillic names created in Windows will have file names in <code>IBM866</code> encoding instead of <code>WINDOWS-1251</code>. I think that calling one function is not much trouble, but for true platform independency it would be nice to have some mechanism for file name encoding auto detection using locale information. Does anyone know a good way to do it? </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a6053a1d249ed210a85c9d5eb7cf9cdbe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbe">QuaZip::CaseSensitivity</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Case sensitivity for the file names. </p>
<p>This is what you specify when accessing files in the archive. Works perfectly fine with any characters thanks to Qt's great unicode support. This is different from ZIP/UNZIP API, where only US-ASCII characters was supported. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a6053a1d249ed210a85c9d5eb7cf9cdbeac3cca8c0b976cf6397a28a5c84e75253"></a>csDefault </td><td class="fielddoc">
<p>Default for platform. Case sensitive for UNIX, not for Windows. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6053a1d249ed210a85c9d5eb7cf9cdbead8d86b0c34203336cad09348cfa5356e"></a>csSensitive </td><td class="fielddoc">
<p>Case sensitive. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6053a1d249ed210a85c9d5eb7cf9cdbea3e492bcc3f64f41a74906cecc45fb366"></a>csInsensitive </td><td class="fielddoc">
<p>Case insensitive. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="adce46b942c341dbb5c851eadead65459"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classQuaZip.html#adce46b942c341dbb5c851eadead65459">QuaZip::Constants</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Useful constants. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="adce46b942c341dbb5c851eadead65459ab26ce1a9c9e94f901dc2cf90fa5baa4b"></a>MAX_FILE_NAME_LENGTH </td><td class="fielddoc">
<p>Maximum file name length. Taken from <code>UNZ_MAXFILENAMEINZIP</code> constant in unzip.c. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="a47e28d4116ee716fdd6b431b821d0be4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4">QuaZip::Mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open mode of the ZIP file. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a47e28d4116ee716fdd6b431b821d0be4ac87ddb1e901e1ec700c16ee0d4d398ce"></a>mdNotOpen </td><td class="fielddoc">
<p>ZIP file is not open. This is the initial mode. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a47e28d4116ee716fdd6b431b821d0be4a803a371910c2dc830d111e9ce5b58897"></a>mdUnzip </td><td class="fielddoc">
<p>ZIP file is open for reading files inside it. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a47e28d4116ee716fdd6b431b821d0be4a25ae05b12590540af8c66ae8298b928e"></a>mdCreate </td><td class="fielddoc">
<p>ZIP file was created with <a class="el" href="classQuaZip.html#abfa4e6018b2964a3d10a4c54e5ab3962" title="Opens ZIP file. ">open()</a> call. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a47e28d4116ee716fdd6b431b821d0be4ab807f0c65653a16d77b365801fd25582"></a>mdAppend </td><td class="fielddoc">
<p>ZIP file was opened in append mode. This refers to <code>APPEND_STATUS_CREATEAFTER</code> mode in ZIP/UNZIP package and means that zip is appended to some existing file what is useful when that file contains self-extractor code. This is obviously <em>not</em> what you whant to use to add files to the existing ZIP archive. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a47e28d4116ee716fdd6b431b821d0be4a22c745f349f06add449af523254fdaec"></a>mdAdd </td><td class="fielddoc">
<p>ZIP file was opened for adding files in the archive. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a970e0f401c7cfd7a78e78572f758eec4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QuaZip::QuaZip </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> object. </p>
<p>Call setName() before opening constructed object. </p>
</div>
</div>
<a class="anchor" id="ae52ebadd5ce64cdb49d7e198904b0b8c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QuaZip::QuaZip </td>
<td>(</td>
<td class="paramtype">QIODevice * </td>
<td class="paramname"><em>ioDevice</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> object associated with ZIP file represented by <em>ioDevice</em>. </p>
<p>The IO device must be seekable, otherwise an error will occur when opening. </p>
</div>
</div>
<a class="anchor" id="af60a2d3930b90f3b25a3148baecad81e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QuaZip::~QuaZip </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> object. </p>
<p>Calls <a class="el" href="classQuaZip.html#a7a4323b73e12f3b4470109f200728f9f" title="Closes ZIP file. ">close()</a> if necessary. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7a4323b73e12f3b4470109f200728f9f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QuaZip::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes ZIP file. </p>
<p>Call <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a> to determine if the close was successful. The underlying QIODevice is also closed, regardless of whether it was set explicitly or not. </p>
</div>
</div>
<a class="anchor" id="a9c91a53ed4c2038e153c64bdc097ebe8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QuaZip::getCurrentFileInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structQuaZipFileInfo.html">QuaZipFileInfo</a> * </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves information about the current file. </p>
<p>Fills the structure pointed by <em>info</em>. Returns <code>true</code> on success, <code>false</code> otherwise. In the latter case structure pointed by <em>info</em> remains untouched. If there was an error, <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a> returns error code.</p>
<p>Should be used only in <a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a803a371910c2dc830d111e9ce5b58897" title="ZIP file is open for reading files inside it. ">QuaZip::mdUnzip</a> mode.</p>
<p>Does nothing and returns <code>false</code> in any of the following cases.</p><ul>
<li>ZIP is not open;</li>
<li>ZIP does not have current file;</li>
<li><em>info</em> is <code>NULL</code>;</li>
</ul>
<p>In all these cases <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a> returns <code>UNZ_OK</code> since there is no ZIP/UNZIP API call. </p>
</div>
</div>
<a class="anchor" id="a9783f8b4f39cd55e71e975aea78fd54a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString QuaZip::getCurrentFileName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current file name. </p>
<p>Equivalent to calling <a class="el" href="classQuaZip.html#a9c91a53ed4c2038e153c64bdc097ebe8" title="Retrieves information about the current file. ">getCurrentFileInfo()</a> and then getting <code>name</code> field of the <a class="el" href="structQuaZipFileInfo.html" title="Information about a file inside archive. ">QuaZipFileInfo</a> structure, but faster and more convenient.</p>
<p>Should be used only in <a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a803a371910c2dc830d111e9ce5b58897" title="ZIP file is open for reading files inside it. ">QuaZip::mdUnzip</a> mode. </p>
</div>
</div>
<a class="anchor" id="a2ea4bd1fca948637c35c2d2752bb5a80"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int QuaZip::getEntriesCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns number of the entries in the ZIP central directory. </p>
<p>Returns negative error code in the case of error. The same error code will be returned by subsequent <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a> call. </p>
</div>
</div>
<a class="anchor" id="afd3ba12fe68748acbf8b7cc14a5a1c29"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QIODevice * QuaZip::getIoDevice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the device representing this ZIP file. </p>
<p>Returns null string if no device has been set explicitly, for example when opening a ZIP file by name. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classQuaZip.html#a64642948b6531ee54f5522f29e388cc6" title="Sets the device representing the ZIP file. ">setIoDevice()</a>, <a class="el" href="classQuaZip.html#a4f7deef08ff40aeb1a7a04bcd7f228c2" title="Returns the name of the ZIP file. ">getZipName()</a>, <a class="el" href="classQuaZip.html#aa80b661de1262af905d1677dbcb008cc" title="Sets the name of the ZIP file. ">setZipName()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3b78a652f296ff4a678a791e8294e642"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unzFile QuaZip::getUnzFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>unzFile</code> handle. </p>
<p>You can use this handle to directly call UNZIP part of the ZIP/UNZIP package functions (see unzip.h).</p>
<dl class="section warning"><dt>Warning</dt><dd>When using the handle returned by this function, please keep in mind that <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> class is unable to detect any changes you make in the ZIP file state (e. g. changing current file, or closing the handle). So please do not do anything with this handle that is possible to do with the functions of this class. Or at least return the handle in the original state before calling some another function of this class (including implicit destructor calls and calls from the <a class="el" href="classQuaZipFile.html" title="A file inside ZIP archive. ">QuaZipFile</a> objects that refer to this <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> instance!). So if you have changed the current file in the ZIP archive - then change it back or you may experience some strange behavior or even crashes. </dd></dl>
</div>
</div>
<a class="anchor" id="a28b91a6282ddd9382c96a069572c6fb4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int QuaZip::getZipError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the error code of the last operation. </p>
<p>Returns <code>UNZ_OK</code> if the last operation was successful.</p>
<p>Error code resets to <code>UNZ_OK</code> every time you call any function that accesses something inside ZIP archive, even if it is <code>const</code> (like <a class="el" href="classQuaZip.html#a2ea4bd1fca948637c35c2d2752bb5a80" title="Returns number of the entries in the ZIP central directory. ">getEntriesCount()</a>). <a class="el" href="classQuaZip.html#abfa4e6018b2964a3d10a4c54e5ab3962" title="Opens ZIP file. ">open()</a> and <a class="el" href="classQuaZip.html#a7a4323b73e12f3b4470109f200728f9f" title="Closes ZIP file. ">close()</a> calls reset error code too. See documentation for the specific functions for details on error detection. </p>
</div>
</div>
<a class="anchor" id="a425043a4d7cc31e2fe2bba73d954f15c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">zipFile QuaZip::getZipFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <code>zipFile</code> handle. </p>
<p>You can use this handle to directly call ZIP part of the ZIP/UNZIP package functions (see zip.h). Warnings about the <a class="el" href="classQuaZip.html#a3b78a652f296ff4a678a791e8294e642" title="Returns unzFile handle. ">getUnzFile()</a> function also apply to this function. </p>
</div>
</div>
<a class="anchor" id="a4f7deef08ff40aeb1a7a04bcd7f228c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString QuaZip::getZipName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the ZIP file. </p>
<p>Returns null string if no ZIP file name has been set, for example when the <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> instance is set up to use a QIODevice instead. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classQuaZip.html#aa80b661de1262af905d1677dbcb008cc" title="Sets the name of the ZIP file. ">setZipName()</a>, <a class="el" href="classQuaZip.html#a64642948b6531ee54f5522f29e388cc6" title="Sets the device representing the ZIP file. ">setIoDevice()</a>, <a class="el" href="classQuaZip.html#afd3ba12fe68748acbf8b7cc14a5a1c29" title="Returns the device representing this ZIP file. ">getIoDevice()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a745488f9177bcec3cdb858587584e033"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QuaZip::goToFirstFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the current file to the first file in the archive. </p>
<p>Returns <code>true</code> on success, <code>false</code> otherwise. Call <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a> to get the error code. </p>
</div>
</div>
<a class="anchor" id="aee6779b6cd338420c2e8c5655fa8ba97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QuaZip::goToNextFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the current file to the next file in the archive. </p>
<p>Returns <code>true</code> on success, <code>false</code> otherwise. Call <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a> to determine if there was an error.</p>
<p>Should be used only in <a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a803a371910c2dc830d111e9ce5b58897" title="ZIP file is open for reading files inside it. ">QuaZip::mdUnzip</a> mode.</p>
<dl class="section note"><dt>Note</dt><dd>If the end of file was reached, <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a> will return <code>UNZ_OK</code> instead of <code>UNZ_END_OF_LIST_OF_FILE</code>. This is to make things like this easier: <div class="fragment"><div class="line"><span class="keywordflow">for</span>(<span class="keywordtype">bool</span> more=zip.goToFirstFile(); more; more=zip.goToNextFile()) {</div><div class="line"> <span class="comment">// do something</span></div><div class="line">}</div><div class="line"><span class="keywordflow">if</span>(zip.getZipError()==UNZ_OK) {</div><div class="line"> <span class="comment">// ok, there was no error</span></div><div class="line">}</div></div><!-- fragment --> </dd></dl>
</div>
</div>
<a class="anchor" id="abfa4e6018b2964a3d10a4c54e5ab3962"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QuaZip::open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4">Mode</a> </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structzlib__filefunc__def__s.html">zlib_filefunc_def</a> * </td>
<td class="paramname"><em>ioApi</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens ZIP file. </p>
<p>Argument <em>mode</em> specifies open mode of the ZIP archive. See Mode for details. Note that there is zipOpen2() function in the ZIP/UNZIP API which accepts <em>globalcomment</em> argument, but it does not use it anywhere, so this <a class="el" href="classQuaZip.html#abfa4e6018b2964a3d10a4c54e5ab3962" title="Opens ZIP file. ">open()</a> function does not have this argument. See <a class="el" href="classQuaZip.html#a1b5d936a203859340574d5908ffa2222" title="Sets global comment in the ZIP file. ">setComment()</a> if you need to set global comment.</p>
<p>If the ZIP file is accessed via explicitly set QIODevice, then this device is opened in the necessary mode. If the device was already opened by some other means, then the behaviour is defined by the device implementation, but generally it is not a very good idea. For example, QFile will at least issue a warning.</p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if successful, <code>false</code> otherwise.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>ZIP/UNZIP API open calls do not return error code - they just return <code>NULL</code> indicating an error. But to make things easier, <a class="el" href="quazip_8h_source.html">quazip.h</a> header defines additional error code <code>UNZ_ERROROPEN</code> and <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a> will return it if the open call of the ZIP/UNZIP API returns <code>NULL</code>.</dd></dl>
<p>Argument <em>ioApi</em> specifies IO function set for ZIP/UNZIP package to use. See unzip.h, zip.h and <a class="el" href="ioapi_8h_source.html">ioapi.h</a> for details. Note that IO API for <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> is different from the original package. The file path argument was changed to be of type <code>voidpf</code>, and <a class="el" href="classQuaZip.html" title="ZIP archive. ">QuaZip</a> passes a QIODevice pointer there. This QIODevice is either set explicitly via <a class="el" href="classQuaZip.html#a64642948b6531ee54f5522f29e388cc6" title="Sets the device representing the ZIP file. ">setIoDevice()</a> or the <a class="el" href="classQuaZip.html#ae52ebadd5ce64cdb49d7e198904b0b8c" title="Constructs QuaZip object associated with ZIP file represented by ioDevice. ">QuaZip(QIODevice*)</a> constructor, or it is created internally when opening the archive by its file name. The default API (qioapi.cpp) just delegates everything to the QIODevice API. Not only this allows to use a QIODevice instead of file name, but also has a nice side effect of raising the file size limit from 2G to 4G.</p>
<p>In short: just forget about the <em>ioApi</em> argument and you'll be fine. </p>
</div>
</div>
<a class="anchor" id="a1b5d936a203859340574d5908ffa2222"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QuaZip::setComment </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>comment</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets global comment in the ZIP file. </p>
<p>Comment will be written to the archive on close operation.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQuaZip.html#abfa4e6018b2964a3d10a4c54e5ab3962" title="Opens ZIP file. ">open()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1c81fca7215a4374f6f03872ade4885b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QuaZip::setCommentCodec </td>
<td>(</td>
<td class="paramtype">QTextCodec * </td>
<td class="paramname"><em>commentCodec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the codec used to encode/decode comments inside archive. </p>
<p>This codec defaults to locale codec, which is probably ok. </p>
</div>
</div>
<a class="anchor" id="a413f3c56b54a9a47258d53802cb606e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QuaZip::setCommentCodec </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>commentCodecName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the codec used to encode/decode comments inside archive. </p>
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Equivalent to calling setCommentCodec(QTextCodec::codecForName(codecName)); </p>
</div>
</div>
<a class="anchor" id="a6c657bfcfccb59d728e0da24c677d899"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool QuaZip::setCurrentFile </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbe">CaseSensitivity</a> </td>
<td class="paramname"><em>cs</em> = <code><a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbeac3cca8c0b976cf6397a28a5c84e75253">csDefault</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets current file by its name. </p>
<p>Returns <code>true</code> if successful, <code>false</code> otherwise. Argument <em>cs</em> specifies case sensitivity of the file name. Call <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a> in the case of a failure to get error code.</p>
<p>This is not a wrapper to unzLocateFile() function. That is because I had to implement locale-specific case-insensitive comparison.</p>
<p>Here are the differences from the original implementation:</p>
<ul>
<li>If the file was not found, error code is <code>UNZ_OK</code>, not <code>UNZ_END_OF_LIST_OF_FILE</code> (see also <a class="el" href="classQuaZip.html#aee6779b6cd338420c2e8c5655fa8ba97" title="Sets the current file to the next file in the archive. ">goToNextFile()</a>).</li>
<li>If this function fails, it unsets the current file rather than resetting it back to what it was before the call.</li>
</ul>
<p>If <em>fileName</em> is null string then this function unsets the current file and return <code>true</code>. Note that you should close the file first if it is open! See <a class="el" href="classQuaZipFile.html#a54e944a6b3d27030f64c8f30d2cc33bb" title="Constructs a QuaZipFile instance. ">QuaZipFile::QuaZipFile(QuaZip*,QObject*)</a> for the details.</p>
<p>Should be used only in <a class="el" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a803a371910c2dc830d111e9ce5b58897" title="ZIP file is open for reading files inside it. ">QuaZip::mdUnzip</a> mode.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classQuaZip.html#a339010b5566704ba3c9cafbfe848d8fb" title="Sets the codec used to encode/decode file names inside archive. ">setFileNameCodec()</a>, <a class="el" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbe" title="Case sensitivity for the file names. ">CaseSensitivity</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a339010b5566704ba3c9cafbfe848d8fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QuaZip::setFileNameCodec </td>
<td>(</td>
<td class="paramtype">QTextCodec * </td>
<td class="paramname"><em>fileNameCodec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the codec used to encode/decode file names inside archive. </p>
<p>This is necessary to access files in the ZIP archive created under Windows with non-latin characters in file names. For example, file names with cyrillic letters will be in <code>IBM866</code> encoding. </p>
</div>
</div>
<a class="anchor" id="a8f283519a195aa1d9076bbbb01ea0497"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QuaZip::setFileNameCodec </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fileNameCodecName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the codec used to encode/decode file names inside archive. </p>
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Equivalent to calling setFileNameCodec(QTextCodec::codecForName(codecName)); </p>
</div>
</div>
<a class="anchor" id="a64642948b6531ee54f5522f29e388cc6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QuaZip::setIoDevice </td>
<td>(</td>
<td class="paramtype">QIODevice * </td>
<td class="paramname"><em>ioDevice</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the device representing the ZIP file. </p>
<p>Does nothing if the ZIP file is open.</p>
<p>Does not reset error code returned by <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classQuaZip.html#afd3ba12fe68748acbf8b7cc14a5a1c29" title="Returns the device representing this ZIP file. ">getIoDevice()</a>, <a class="el" href="classQuaZip.html#a4f7deef08ff40aeb1a7a04bcd7f228c2" title="Returns the name of the ZIP file. ">getZipName()</a>, <a class="el" href="classQuaZip.html#aa80b661de1262af905d1677dbcb008cc" title="Sets the name of the ZIP file. ">setZipName()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa80b661de1262af905d1677dbcb008cc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void QuaZip::setZipName </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>zipName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the name of the ZIP file. </p>
<p>Does nothing if the ZIP file is open.</p>
<p>Does not reset error code returned by <a class="el" href="classQuaZip.html#a28b91a6282ddd9382c96a069572c6fb4" title="Returns the error code of the last operation. ">getZipError()</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classQuaZip.html#a64642948b6531ee54f5522f29e388cc6" title="Sets the device representing the ZIP file. ">setIoDevice()</a>, <a class="el" href="classQuaZip.html#afd3ba12fe68748acbf8b7cc14a5a1c29" title="Returns the device representing this ZIP file. ">getIoDevice()</a>, <a class="el" href="classQuaZip.html#a4f7deef08ff40aeb1a7a04bcd7f228c2" title="Returns the name of the ZIP file. ">getZipName()</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/utilities/quazip/<a class="el" href="quazip_8h_source.html">quazip.h</a></li>
<li>src/utilities/quazip/quazip.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Feb 4 2016 13:59:24 for FGx by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
004fd8e0018ea6f0df74e9703299ee08
>
files
>
114
