<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FGx: Zip 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>
<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.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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="classZip-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Zip Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classZip.html" title="Zip file compression. ">Zip</a> file compression.
<a href="classZip.html#details">More...</a></p>
<p><code>#include <<a class="el" href="quazip_2zip_8h_source.html">zip.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:aa445490ca64ce3051470bed52ee9198c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> { <br />
  <b>Ok</b>,
<b>ZlibInit</b>,
<b>ZlibError</b>,
<b>FileExists</b>,
<br />
  <b>OpenFailed</b>,
<b>NoOpenArchive</b>,
<b>FileNotFound</b>,
<b>ReadFailed</b>,
<br />
  <b>WriteFailed</b>,
<b>SeekFailed</b>
<br />
}</td></tr>
<tr class="separator:aa445490ca64ce3051470bed52ee9198c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb46e5882e74520cead7d950e0fa7ca6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> { <br />
  <b>Store</b>,
<b>Deflate1</b> = 1,
<b>Deflate2</b>,
<b>Deflate3</b>,
<br />
  <b>Deflate4</b>,
<b>Deflate5</b>,
<b>Deflate6</b>,
<b>Deflate7</b>,
<br />
  <b>Deflate8</b>,
<b>Deflate9</b>,
<b>AutoCPU</b>,
<b>AutoMIME</b>,
<br />
  <b>AutoFull</b>
<br />
}</td></tr>
<tr class="separator:afb46e5882e74520cead7d950e0fa7ca6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a939111cf77e16d456d380b8c68f637ab"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637ab">CompressionOption</a> { <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba7e1fd3491d002f4aecba63638327e2a1">RelativePaths</a> = 0x0001,
<a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637abacd08c4e9df1b7ac08622275db0e5ef2d">AbsolutePaths</a> = 0x0002,
<a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4">IgnorePaths</a> = 0x0004
}</td></tr>
<tr class="separator:a939111cf77e16d456d380b8c68f637ab"><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:acb7ef056446ce6020a3b0d79d352c77d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#acb7ef056446ce6020a3b0d79d352c77d">Zip</a> ()</td></tr>
<tr class="separator:acb7ef056446ce6020a3b0d79d352c77d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8073ab04f193fbad82fdf7d1bdf09858"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a8073ab04f193fbad82fdf7d1bdf09858">~Zip</a> ()</td></tr>
<tr class="separator:a8073ab04f193fbad82fdf7d1bdf09858"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbc6a04c3899734901316e6db61288ff"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#afbc6a04c3899734901316e6db61288ff">isOpen</a> () const</td></tr>
<tr class="separator:afbc6a04c3899734901316e6db61288ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86337bb46bb3e98545737c97b3f36c1e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a86337bb46bb3e98545737c97b3f36c1e">setPassword</a> (const QString &pwd)</td></tr>
<tr class="separator:a86337bb46bb3e98545737c97b3f36c1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69a31fc9d8b24c74e94e56149882ff1c"><td class="memItemLeft" align="right" valign="top"><a id="a69a31fc9d8b24c74e94e56149882ff1c"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a69a31fc9d8b24c74e94e56149882ff1c">clearPassword</a> ()</td></tr>
<tr class="memdesc:a69a31fc9d8b24c74e94e56149882ff1c"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method, clears the current password. <br /></td></tr>
<tr class="separator:a69a31fc9d8b24c74e94e56149882ff1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae242df4ab5a04b9e16e47af29dadfba1"><td class="memItemLeft" align="right" valign="top"><a id="ae242df4ab5a04b9e16e47af29dadfba1"></a>
QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#ae242df4ab5a04b9e16e47af29dadfba1">password</a> () const</td></tr>
<tr class="memdesc:ae242df4ab5a04b9e16e47af29dadfba1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the currently used password. <br /></td></tr>
<tr class="separator:ae242df4ab5a04b9e16e47af29dadfba1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad23558059e8870f5c904e5ce9ceecaf5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#ad23558059e8870f5c904e5ce9ceecaf5">createArchive</a> (const QString &file, bool overwrite=true)</td></tr>
<tr class="separator:ad23558059e8870f5c904e5ce9ceecaf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01af46561a82a1571e27be8bdc19f566"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a01af46561a82a1571e27be8bdc19f566">createArchive</a> (QIODevice *device)</td></tr>
<tr class="separator:a01af46561a82a1571e27be8bdc19f566"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc028fb087e7d83ee96091efc0a04f59"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#abc028fb087e7d83ee96091efc0a04f59">archiveComment</a> () const</td></tr>
<tr class="separator:abc028fb087e7d83ee96091efc0a04f59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab756a21c199d2271b933b125b06f98e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#ab756a21c199d2271b933b125b06f98e5">setArchiveComment</a> (const QString &comment)</td></tr>
<tr class="separator:ab756a21c199d2271b933b125b06f98e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48d94831e90916ef42e40acdc69a1b87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a48d94831e90916ef42e40acdc69a1b87">addDirectoryContents</a> (const QString &path, <a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> level=AutoFull)</td></tr>
<tr class="separator:a48d94831e90916ef42e40acdc69a1b87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9655315469924c71d009e00b7c6f8b64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a9655315469924c71d009e00b7c6f8b64">addDirectoryContents</a> (const QString &path, const QString &root, <a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> level=AutoFull)</td></tr>
<tr class="separator:a9655315469924c71d009e00b7c6f8b64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30f7affcdc953c883fd902f8d6ccc7f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a30f7affcdc953c883fd902f8d6ccc7f6">addDirectory</a> (const QString &path, CompressionOptions options=<a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba7e1fd3491d002f4aecba63638327e2a1">RelativePaths</a>, <a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> level=AutoFull)</td></tr>
<tr class="separator:a30f7affcdc953c883fd902f8d6ccc7f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6005a473b934043ae23cfbe66823c832"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a6005a473b934043ae23cfbe66823c832">addDirectory</a> (const QString &path, const QString &root, <a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> level=AutoFull)</td></tr>
<tr class="separator:a6005a473b934043ae23cfbe66823c832"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c91e3555e85e763441908570170d110"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a2c91e3555e85e763441908570170d110">addDirectory</a> (const QString &path, const QString &root, CompressionOptions options=<a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba7e1fd3491d002f4aecba63638327e2a1">RelativePaths</a>, <a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> level=AutoFull)</td></tr>
<tr class="separator:a2c91e3555e85e763441908570170d110"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd007f95c7f942c835cd12ef74d639dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#afd007f95c7f942c835cd12ef74d639dc">closeArchive</a> ()</td></tr>
<tr class="separator:afd007f95c7f942c835cd12ef74d639dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a830d75b5a764cad81bfd772ca7578ec7"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classZip.html#a830d75b5a764cad81bfd772ca7578ec7">formatError</a> (<a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">ErrorCode</a> c) const</td></tr>
<tr class="separator:a830d75b5a764cad81bfd772ca7578ec7"><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="el" href="classZip.html" title="Zip file compression. ">Zip</a> file compression. </p>
<p>Some quick usage examples.</p>
<pre class="fragment">Suppose you have this directory structure:
/root/dir1/
/root/dir1/file1.1
/root/dir1/file1.2
/root/dir1/dir1.1/
/root/dir1/dir1.2/file1.2.1
EXAMPLE 1:
myZipInstance.addDirectory("/root/dir1");
RESULT:
Beheaves like any common zip software and creates a zip file with this structure:
dir1/
dir1/file1.1
dir1/file1.2
dir1/dir1.1/
dir1/dir1.2/file1.2.1
EXAMPLE 2:
myZipInstance.addDirectory("/root/dir1", "myRoot/myFolder");
RESULT:
Adds a custom root to the paths and creates a zip file with this structure:
myRoot/myFolder/dir1/
myRoot/myFolder/dir1/file1.1
myRoot/myFolder/dir1/file1.2
myRoot/myFolder/dir1/dir1.1/
myRoot/myFolder/dir1/dir1.2/file1.2.1
EXAMPLE 3:
myZipInstance.addDirectory("/root/dir1", Zip::AbsolutePaths);
NOTE:
Same as calling addDirectory(SOME_PATH, PARENT_PATH_of_SOME_PATH).
RESULT:
Preserves absolute paths and creates a zip file with this structure:
/root/dir1/
/root/dir1/file1.1
/root/dir1/file1.2
/root/dir1/dir1.1/
/root/dir1/dir1.2/file1.2.1
EXAMPLE 4:
myZipInstance.setPassword("hellopass");
myZipInstance.addDirectory("/root/dir1", "/");
RESULT:
Adds and encrypts the files in /root/dir1, creating the following zip structure:
/dir1/
/dir1/file1.1
/dir1/file1.2
/dir1/dir1.1/
/dir1/dir1.2/file1.2.1</pre> </div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="afb46e5882e74520cead7d950e0fa7ca6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb46e5882e74520cead7d950e0fa7ca6">◆ </a></span>CompressionLevel</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">Zip::CompressionLevel</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the result of a decompression operation. Zip::Store No compression. Zip::Deflate1 Deflate compression level 1(lowest compression). Zip::Deflate1 Deflate compression level 2. Zip::Deflate1 Deflate compression level 3. Zip::Deflate1 Deflate compression level 4. Zip::Deflate1 Deflate compression level 5. Zip::Deflate1 Deflate compression level 6. Zip::Deflate1 Deflate compression level 7. Zip::Deflate1 Deflate compression level 8. Zip::Deflate1 Deflate compression level 9 (maximum compression). Zip::AutoCPU Adapt compression level to CPU speed (faster CPU => better compression). Zip::AutoMIME Adapt compression level to MIME type of the file being compressed. Zip::AutoFull Use both CPU and MIME type detection. </p>
</div>
</div>
<a id="a939111cf77e16d456d380b8c68f637ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a939111cf77e16d456d380b8c68f637ab">◆ </a></span>CompressionOption</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637ab">Zip::CompressionOption</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a939111cf77e16d456d380b8c68f637aba7e1fd3491d002f4aecba63638327e2a1"></a>RelativePaths </td><td class="fielddoc"><p>Does not preserve absolute paths in the zip file when adding a file/directory (default) </p>
</td></tr>
<tr><td class="fieldname"><a id="a939111cf77e16d456d380b8c68f637abacd08c4e9df1b7ac08622275db0e5ef2d"></a>AbsolutePaths </td><td class="fielddoc"><p>Preserve absolute paths. </p>
</td></tr>
<tr><td class="fieldname"><a id="a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4"></a>IgnorePaths </td><td class="fielddoc"><p>Do not store paths. All the files are put in the (evtl. user defined) root of the zip file. </p>
</td></tr>
</table>
</div>
</div>
<a id="aa445490ca64ce3051470bed52ee9198c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa445490ca64ce3051470bed52ee9198c">◆ </a></span>ErrorCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The result of a compression operation. Zip::Ok No error occurred. Zip::ZlibInit Failed to init or load the zlib library. Zip::ZlibError The zlib library returned some error. Zip::FileExists The file already exists and will not be overwritten. Zip::OpenFailed Unable to create or open a device. Zip::NoOpenArchive CreateArchive() has not been called yet. Zip::FileNotFound File or directory does not exist. Zip::ReadFailed Reading of a file failed. Zip::WriteFailed Writing of a file failed. Zip::SeekFailed Seek failed. </p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="acb7ef056446ce6020a3b0d79d352c77d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb7ef056446ce6020a3b0d79d352c77d">◆ </a></span>Zip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Zip::Zip </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="classZip.html" title="Zip file compression. ">Zip</a> file compressor. </p>
</div>
</div>
<a id="a8073ab04f193fbad82fdf7d1bdf09858"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8073ab04f193fbad82fdf7d1bdf09858">◆ </a></span>~Zip()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Zip::~Zip </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 any open archive and releases used resources. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a30f7affcdc953c883fd902f8d6ccc7f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30f7affcdc953c883fd902f8d6ccc7f6">◆ </a></span>addDirectory() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a> Zip::addDirectory </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CompressionOptions </td>
<td class="paramname"><em>options</em> = <code><a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba7e1fd3491d002f4aecba63638327e2a1">RelativePaths</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> </td>
<td class="paramname"><em>level</em> = <code>AutoFull</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method, same as calling <a class="el" href="classZip.html#a6005a473b934043ae23cfbe66823c832">Zip::addDirectory(const QString&,const QString&,CompressionLevel)</a> with an empty <code>root</code> parameter (or with the parent directory of <code>path</code> if the AbsolutePaths options is set).</p>
<p>The ExtractionOptions are checked in the order they are defined in the zip.h heaser file. This means that the last one overwrites the previous one (if some conflict occurs), i.e. <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4" title="Do not store paths. All the files are put in the (evtl. user defined) root of the zip file...">Zip::IgnorePaths</a> | <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637abacd08c4e9df1b7ac08622275db0e5ef2d" title="Preserve absolute paths. ">Zip::AbsolutePaths</a> would be interpreted as <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4" title="Do not store paths. All the files are put in the (evtl. user defined) root of the zip file...">Zip::IgnorePaths</a>. </p>
</div>
</div>
<a id="a6005a473b934043ae23cfbe66823c832"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6005a473b934043ae23cfbe66823c832">◆ </a></span>addDirectory() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a> Zip::addDirectory </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> </td>
<td class="paramname"><em>level</em> = <code>AutoFull</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method, same as calling <a class="el" href="classZip.html#a2c91e3555e85e763441908570170d110">Zip::addDirectory(const QString&,const QString&,CompressionOptions,CompressionLevel)</a> with the <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba7e1fd3491d002f4aecba63638327e2a1" title="Does not preserve absolute paths in the zip file when adding a file/directory (default) ...">Zip::RelativePaths</a> flag as compression option. </p>
</div>
</div>
<a id="a2c91e3555e85e763441908570170d110"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c91e3555e85e763441908570170d110">◆ </a></span>addDirectory() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a> Zip::addDirectory </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CompressionOptions </td>
<td class="paramname"><em>options</em> = <code><a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba7e1fd3491d002f4aecba63638327e2a1">RelativePaths</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> </td>
<td class="paramname"><em>level</em> = <code>AutoFull</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recursively adds files contained in <code>dir</code> to the archive, using <code>root</code> as name for the root folder. Stops adding files if some error occurs.</p>
<p>The ExtractionOptions are checked in the order they are defined in the zip.h heaser file. This means that the last one overwrites the previous one (if some conflict occurs), i.e. <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4" title="Do not store paths. All the files are put in the (evtl. user defined) root of the zip file...">Zip::IgnorePaths</a> | <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637abacd08c4e9df1b7ac08622275db0e5ef2d" title="Preserve absolute paths. ">Zip::AbsolutePaths</a> would be interpreted as <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4" title="Do not store paths. All the files are put in the (evtl. user defined) root of the zip file...">Zip::IgnorePaths</a>.</p>
<p>The <code>root</code> parameter is ignored with the <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4" title="Do not store paths. All the files are put in the (evtl. user defined) root of the zip file...">Zip::IgnorePaths</a> parameter and used as path prefix (a trailing / is always added as directory separator!) otherwise (even with <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637abacd08c4e9df1b7ac08622275db0e5ef2d" title="Preserve absolute paths. ">Zip::AbsolutePaths</a> set!). </p>
</div>
</div>
<a id="a48d94831e90916ef42e40acdc69a1b87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48d94831e90916ef42e40acdc69a1b87">◆ </a></span>addDirectoryContents() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a> Zip::addDirectoryContents </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> </td>
<td class="paramname"><em>level</em> = <code>AutoFull</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method, same as calling <a class="el" href="classZip.html#a2c91e3555e85e763441908570170d110">Zip::addDirectory(const QString&,const QString&,CompressionOptions,CompressionLevel)</a> with the <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4" title="Do not store paths. All the files are put in the (evtl. user defined) root of the zip file...">Zip::IgnorePaths</a> flag as compression option and an empty <code>root</code> parameter. </p>
</div>
</div>
<a id="a9655315469924c71d009e00b7c6f8b64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9655315469924c71d009e00b7c6f8b64">◆ </a></span>addDirectoryContents() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a> Zip::addDirectoryContents </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classZip.html#afb46e5882e74520cead7d950e0fa7ca6">CompressionLevel</a> </td>
<td class="paramname"><em>level</em> = <code>AutoFull</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method, same as calling <a class="el" href="classZip.html#a2c91e3555e85e763441908570170d110">Zip::addDirectory(const QString&,const QString&,CompressionOptions,CompressionLevel)</a> with the <a class="el" href="classZip.html#a939111cf77e16d456d380b8c68f637aba2e40ab516c31fc25aa684628cc1167a4" title="Do not store paths. All the files are put in the (evtl. user defined) root of the zip file...">Zip::IgnorePaths</a> flag as compression option. </p>
</div>
</div>
<a id="abc028fb087e7d83ee96091efc0a04f59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc028fb087e7d83ee96091efc0a04f59">◆ </a></span>archiveComment()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Zip::archiveComment </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current archive comment. </p>
</div>
</div>
<a id="afd007f95c7f942c835cd12ef74d639dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd007f95c7f942c835cd12ef74d639dc">◆ </a></span>closeArchive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a> Zip::closeArchive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes the archive and writes any pending data. </p>
</div>
</div>
<a id="ad23558059e8870f5c904e5ce9ceecaf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad23558059e8870f5c904e5ce9ceecaf5">◆ </a></span>createArchive() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a> Zip::createArchive </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">bool </td>
<td class="paramname"><em>overwrite</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to create a new <a class="el" href="classZip.html" title="Zip file compression. ">Zip</a> archive. If <code>overwrite</code> is true and the file already exist it will be overwritten. Any open archive will be closed. </p>
</div>
</div>
<a id="a01af46561a82a1571e27be8bdc19f566"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01af46561a82a1571e27be8bdc19f566">◆ </a></span>createArchive() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a> Zip::createArchive </td>
<td>(</td>
<td class="paramtype">QIODevice * </td>
<td class="paramname"><em>device</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to create a new <a class="el" href="classZip.html" title="Zip file compression. ">Zip</a> archive. If there is another open archive this will be closed. </p><dl class="section warning"><dt>Warning</dt><dd>The class takes ownership of the device! </dd></dl>
</div>
</div>
<a id="a830d75b5a764cad81bfd772ca7578ec7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a830d75b5a764cad81bfd772ca7578ec7">◆ </a></span>formatError()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Zip::formatError </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classZip.html#aa445490ca64ce3051470bed52ee9198c">Zip::ErrorCode</a> </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a locale translated error string for a given error code. </p>
</div>
</div>
<a id="afbc6a04c3899734901316e6db61288ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbc6a04c3899734901316e6db61288ff">◆ </a></span>isOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Zip::isOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if there is an open archive. </p>
</div>
</div>
<a id="ab756a21c199d2271b933b125b06f98e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab756a21c199d2271b933b125b06f98e5">◆ </a></span>setArchiveComment()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Zip::setArchiveComment </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 the comment for this archive. Note: <a class="el" href="classZip.html#ad23558059e8870f5c904e5ce9ceecaf5">createArchive()</a> should have been called before. </p>
</div>
</div>
<a id="a86337bb46bb3e98545737c97b3f36c1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86337bb46bb3e98545737c97b3f36c1e">◆ </a></span>setPassword()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Zip::setPassword </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>pwd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the password to be used for the next files being added! Files added before calling this method will use the previously set password (if any). Closing the archive won't clear the password! </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/utilities/osdab/<a class="el" href="osdab_2zip_8h_source.html">zip.h</a></li>
<li>src/utilities/osdab/zip.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Sep 24 2018 08:46:34 for FGx by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
8301c559663b22447692a51850976f04
>
files
>
199
