1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
3 |
<head> |
4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
5 |
<title>QuaZIP: quazip/quazip.h Source File</title> |
6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
8 |
</head> |
9 |
<body> |
10 |
<!-- Generated by Doxygen 1.7.4 --> |
11 |
<div id="top"> |
12 |
<div id="titlearea"> |
13 |
<table cellspacing="0" cellpadding="0"> |
14 |
<tbody> |
15 |
<tr style="height: 56px;"> |
16 |
<td style="padding-left: 0.5em;"> |
17 |
<div id="projectname">QuaZIP <span id="projectnumber">quazip-0-7-2</span></div> |
18 |
</td> |
19 |
</tr> |
20 |
</tbody> |
21 |
</table> |
22 |
</div> |
23 |
<div id="navrow1" class="tabs"> |
24 |
<ul class="tablist"> |
25 |
<li><a href="index.html"><span>Main Page</span></a></li> |
26 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
27 |
<li><a href="annotated.html"><span>Classes</span></a></li> |
28 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
29 |
<li><a href="dirs.html"><span>Directories</span></a></li> |
30 |
</ul> |
31 |
</div> |
32 |
<div id="navrow2" class="tabs2"> |
33 |
<ul class="tablist"> |
34 |
<li><a href="files.html"><span>File List</span></a></li> |
35 |
</ul> |
36 |
</div> |
37 |
<div id="nav-path" class="navpath"> |
38 |
<ul> |
39 |
<li class="navelem"><a class="el" href="dir_e7d3eab1e7c75d6cf2e0a967be43a7d0.html">quazip</a> </li> |
40 |
</ul> |
41 |
</div> |
42 |
</div> |
43 |
<div class="header"> |
44 |
<div class="headertitle"> |
45 |
<div class="title">quazip.h</div> </div> |
46 |
</div> |
47 |
<div class="contents"> |
48 |
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef QUA_ZIP_H</span> |
49 |
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define QUA_ZIP_H</span> |
50 |
<a name="l00003"></a>00003 <span class="preprocessor"></span> |
51 |
<a name="l00004"></a>00004 <span class="comment">/*</span> |
52 |
<a name="l00005"></a>00005 <span class="comment">Copyright (C) 2005-2014 Sergey A. Tachenov</span> |
53 |
<a name="l00006"></a>00006 <span class="comment"></span> |
54 |
<a name="l00007"></a>00007 <span class="comment">This file is part of QuaZIP.</span> |
55 |
<a name="l00008"></a>00008 <span class="comment"></span> |
56 |
<a name="l00009"></a>00009 <span class="comment">QuaZIP is free software: you can redistribute it and/or modify</span> |
57 |
<a name="l00010"></a>00010 <span class="comment">it under the terms of the GNU Lesser General Public License as published by</span> |
58 |
<a name="l00011"></a>00011 <span class="comment">the Free Software Foundation, either version 2.1 of the License, or</span> |
59 |
<a name="l00012"></a>00012 <span class="comment">(at your option) any later version.</span> |
60 |
<a name="l00013"></a>00013 <span class="comment"></span> |
61 |
<a name="l00014"></a>00014 <span class="comment">QuaZIP is distributed in the hope that it will be useful,</span> |
62 |
<a name="l00015"></a>00015 <span class="comment">but WITHOUT ANY WARRANTY; without even the implied warranty of</span> |
63 |
<a name="l00016"></a>00016 <span class="comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> |
64 |
<a name="l00017"></a>00017 <span class="comment">GNU Lesser General Public License for more details.</span> |
65 |
<a name="l00018"></a>00018 <span class="comment"></span> |
66 |
<a name="l00019"></a>00019 <span class="comment">You should have received a copy of the GNU Lesser General Public License</span> |
67 |
<a name="l00020"></a>00020 <span class="comment">along with QuaZIP. If not, see <http://www.gnu.org/licenses/>.</span> |
68 |
<a name="l00021"></a>00021 <span class="comment"></span> |
69 |
<a name="l00022"></a>00022 <span class="comment">See COPYING file for the full LGPL text.</span> |
70 |
<a name="l00023"></a>00023 <span class="comment"></span> |
71 |
<a name="l00024"></a>00024 <span class="comment">Original ZIP package is copyrighted by Gilles Vollant, see</span> |
72 |
<a name="l00025"></a>00025 <span class="comment">quazip/(un)zip.h files for details, basically it's zlib license.</span> |
73 |
<a name="l00026"></a>00026 <span class="comment"> **/</span> |
74 |
<a name="l00027"></a>00027 |
75 |
<a name="l00028"></a>00028 <span class="preprocessor">#include <QString></span> |
76 |
<a name="l00029"></a>00029 <span class="preprocessor">#include <QStringList></span> |
77 |
<a name="l00030"></a>00030 <span class="preprocessor">#include <QTextCodec></span> |
78 |
<a name="l00031"></a>00031 |
79 |
<a name="l00032"></a>00032 <span class="preprocessor">#include "zip.h"</span> |
80 |
<a name="l00033"></a>00033 <span class="preprocessor">#include "unzip.h"</span> |
81 |
<a name="l00034"></a>00034 |
82 |
<a name="l00035"></a>00035 <span class="preprocessor">#include "quazip_global.h"</span> |
83 |
<a name="l00036"></a>00036 <span class="preprocessor">#include "quazipfileinfo.h"</span> |
84 |
<a name="l00037"></a>00037 |
85 |
<a name="l00038"></a>00038 <span class="comment">// just in case it will be defined in the later versions of the ZIP/UNZIP</span> |
86 |
<a name="l00039"></a>00039 <span class="preprocessor">#ifndef UNZ_OPENERROR</span> |
87 |
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="comment">// define additional error code</span> |
88 |
<a name="l00041"></a>00041 <span class="preprocessor">#define UNZ_OPENERROR -1000</span> |
89 |
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#endif</span> |
90 |
<a name="l00043"></a>00043 <span class="preprocessor"></span> |
91 |
<a name="l00044"></a>00044 <span class="keyword">class </span><a class="code" href="classQuaZipPrivate.html" title="All the internal stuff for the QuaZip class.">QuaZipPrivate</a>; |
92 |
<a name="l00045"></a>00045 |
93 |
<a name="l00047"></a>00047 |
94 |
<a name="l00084"></a><a class="code" href="classQuaZip.html">00084</a> <span class="keyword">class </span>QUAZIP_EXPORT <a class="code" href="classQuaZip.html" title="ZIP archive.">QuaZip</a> { |
95 |
<a name="l00085"></a>00085 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classQuaZipPrivate.html" title="All the internal stuff for the QuaZip class.">QuaZipPrivate</a>; |
96 |
<a name="l00086"></a>00086 <span class="keyword">public</span>: |
97 |
<a name="l00088"></a><a class="code" href="classQuaZip.html#adce46b942c341dbb5c851eadead65459">00088</a> <span class="keyword">enum</span> <a class="code" href="classQuaZip.html#adce46b942c341dbb5c851eadead65459" title="Useful constants.">Constants</a> { |
98 |
<a name="l00089"></a><a class="code" href="classQuaZip.html#adce46b942c341dbb5c851eadead65459ab26ce1a9c9e94f901dc2cf90fa5baa4b">00089</a> MAX_FILE_NAME_LENGTH=256 |
99 |
<a name="l00092"></a>00092 }; |
100 |
<a name="l00094"></a><a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4">00094</a> <span class="keyword">enum</span> <a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4" title="Open mode of the ZIP file.">Mode</a> { |
101 |
<a name="l00095"></a><a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4ac87ddb1e901e1ec700c16ee0d4d398ce">00095</a> <a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4ac87ddb1e901e1ec700c16ee0d4d398ce" title="ZIP file is not open. This is the initial mode.">mdNotOpen</a>, |
102 |
<a name="l00096"></a><a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a803a371910c2dc830d111e9ce5b58897">00096</a> <a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a803a371910c2dc830d111e9ce5b58897" title="ZIP file is open for reading files inside it.">mdUnzip</a>, |
103 |
<a name="l00097"></a><a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a25ae05b12590540af8c66ae8298b928e">00097</a> <a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a25ae05b12590540af8c66ae8298b928e" title="ZIP file was created with open() call.">mdCreate</a>, |
104 |
<a name="l00098"></a><a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4ab807f0c65653a16d77b365801fd25582">00098</a> mdAppend, |
105 |
<a name="l00106"></a><a class="code" href="classQuaZip.html#a47e28d4116ee716fdd6b431b821d0be4a22c745f349f06add449af523254fdaec">00106</a> mdAdd |
106 |
<a name="l00107"></a>00107 }; |
107 |
<a name="l00109"></a>00109 |
108 |
<a name="l00114"></a><a class="code" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbe">00114</a> <span class="keyword">enum</span> <a class="code" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbe" title="Case sensitivity for the file names.">CaseSensitivity</a> { |
109 |
<a name="l00115"></a><a class="code" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbeac3cca8c0b976cf6397a28a5c84e75253">00115</a> csDefault=0, |
110 |
<a name="l00116"></a><a class="code" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbead8d86b0c34203336cad09348cfa5356e">00116</a> csSensitive=1, |
111 |
<a name="l00117"></a><a class="code" href="classQuaZip.html#a6053a1d249ed210a85c9d5eb7cf9cdbea3e492bcc3f64f41a74906cecc45fb366">00117</a> csInsensitive=2 |
112 |
<a name="l00118"></a>00118 }; |
113 |
<a name="l00120"></a>00120 |
114 |
<a name="l00126"></a>00126 <span class="keyword">static</span> Qt::CaseSensitivity convertCaseSensitivity( |
115 |
<a name="l00127"></a>00127 CaseSensitivity cs); |
116 |
<a name="l00128"></a>00128 <span class="keyword">private</span>: |
117 |
<a name="l00129"></a>00129 <a class="code" href="classQuaZipPrivate.html" title="All the internal stuff for the QuaZip class.">QuaZipPrivate</a> *p; |
118 |
<a name="l00130"></a>00130 <span class="comment">// not (and will not be) implemented</span> |
119 |
<a name="l00131"></a>00131 <a class="code" href="classQuaZip.html" title="ZIP archive.">QuaZip</a>(<span class="keyword">const</span> <a class="code" href="classQuaZip.html" title="ZIP archive.">QuaZip</a>& that); |
120 |
<a name="l00132"></a>00132 <span class="comment">// not (and will not be) implemented</span> |
121 |
<a name="l00133"></a>00133 <a class="code" href="classQuaZip.html" title="ZIP archive.">QuaZip</a>& operator=(<span class="keyword">const</span> <a class="code" href="classQuaZip.html" title="ZIP archive.">QuaZip</a>& that); |
122 |
<a name="l00134"></a>00134 <span class="keyword">public</span>: |
123 |
<a name="l00136"></a>00136 |
124 |
<a name="l00137"></a>00137 <a class="code" href="classQuaZip.html" title="ZIP archive.">QuaZip</a>(); |
125 |
<a name="l00139"></a>00139 <a class="code" href="classQuaZip.html" title="ZIP archive.">QuaZip</a>(<span class="keyword">const</span> <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qstring.html">QString</a>& zipName); |
126 |
<a name="l00141"></a>00141 |
127 |
<a name="l00142"></a>00142 <a class="code" href="classQuaZip.html" title="ZIP archive.">QuaZip</a>(<a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qiodevice.html">QIODevice</a> *ioDevice); |
128 |
<a name="l00144"></a>00144 |
129 |
<a name="l00145"></a>00145 ~<a class="code" href="classQuaZip.html" title="ZIP archive.">QuaZip</a>(); |
130 |
<a name="l00147"></a>00147 |
131 |
<a name="l00193"></a>00193 <span class="keywordtype">bool</span> open(Mode mode, zlib_filefunc_def *ioApi =NULL); |
132 |
<a name="l00195"></a>00195 |
133 |
<a name="l00217"></a>00217 <span class="keywordtype">void</span> close(); |
134 |
<a name="l00219"></a>00219 |
135 |
<a name="l00224"></a>00224 <span class="keywordtype">void</span> setFileNameCodec(<a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qtextcodec.html">QTextCodec</a> *fileNameCodec); |
136 |
<a name="l00226"></a>00226 |
137 |
<a name="l00229"></a>00229 <span class="keywordtype">void</span> setFileNameCodec(<span class="keyword">const</span> <span class="keywordtype">char</span> *fileNameCodecName); |
138 |
<a name="l00231"></a>00231 <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qtextcodec.html">QTextCodec</a>* getFileNameCodec() <span class="keyword">const</span>; |
139 |
<a name="l00233"></a>00233 |
140 |
<a name="l00235"></a>00235 <span class="keywordtype">void</span> setCommentCodec(<a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qtextcodec.html">QTextCodec</a> *commentCodec); |
141 |
<a name="l00237"></a>00237 |
142 |
<a name="l00240"></a>00240 <span class="keywordtype">void</span> setCommentCodec(<span class="keyword">const</span> <span class="keywordtype">char</span> *commentCodecName); |
143 |
<a name="l00242"></a>00242 <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qtextcodec.html">QTextCodec</a>* getCommentCodec() <span class="keyword">const</span>; |
144 |
<a name="l00244"></a>00244 |
145 |
<a name="l00249"></a>00249 <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qstring.html">QString</a> getZipName() <span class="keyword">const</span>; |
146 |
<a name="l00251"></a>00251 |
147 |
<a name="l00256"></a>00256 <span class="keywordtype">void</span> setZipName(<span class="keyword">const</span> <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qstring.html">QString</a>& zipName); |
148 |
<a name="l00258"></a>00258 |
149 |
<a name="l00262"></a>00262 <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qiodevice.html">QIODevice</a> *getIoDevice() <span class="keyword">const</span>; |
150 |
<a name="l00264"></a>00264 |
151 |
<a name="l00269"></a>00269 <span class="keywordtype">void</span> setIoDevice(<a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qiodevice.html">QIODevice</a> *ioDevice); |
152 |
<a name="l00271"></a>00271 Mode getMode() <span class="keyword">const</span>; |
153 |
<a name="l00273"></a>00273 <span class="keywordtype">bool</span> isOpen() <span class="keyword">const</span>; |
154 |
<a name="l00275"></a>00275 |
155 |
<a name="l00283"></a>00283 <span class="keywordtype">int</span> getZipError() <span class="keyword">const</span>; |
156 |
<a name="l00285"></a>00285 |
157 |
<a name="l00288"></a>00288 <span class="keywordtype">int</span> getEntriesCount() <span class="keyword">const</span>; |
158 |
<a name="l00290"></a>00290 <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qstring.html">QString</a> getComment() <span class="keyword">const</span>; |
159 |
<a name="l00292"></a>00292 |
160 |
<a name="l00300"></a>00300 <span class="keywordtype">void</span> setComment(<span class="keyword">const</span> <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qstring.html">QString</a>& comment); |
161 |
<a name="l00302"></a>00302 |
162 |
<a name="l00305"></a>00305 <span class="keywordtype">bool</span> goToFirstFile(); |
163 |
<a name="l00307"></a>00307 |
164 |
<a name="l00324"></a>00324 <span class="keywordtype">bool</span> goToNextFile(); |
165 |
<a name="l00326"></a>00326 |
166 |
<a name="l00350"></a>00350 <span class="keywordtype">bool</span> setCurrentFile(<span class="keyword">const</span> <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qstring.html">QString</a>& fileName, CaseSensitivity cs =csDefault); |
167 |
<a name="l00352"></a>00352 <span class="keywordtype">bool</span> hasCurrentFile() <span class="keyword">const</span>; |
168 |
<a name="l00354"></a>00354 |
169 |
<a name="l00375"></a>00375 <span class="keywordtype">bool</span> getCurrentFileInfo(<a class="code" href="structQuaZipFileInfo.html" title="Information about a file inside archive.">QuaZipFileInfo</a>* info)<span class="keyword">const</span>; |
170 |
<a name="l00377"></a>00377 |
171 |
<a name="l00385"></a>00385 <span class="keywordtype">bool</span> getCurrentFileInfo(<a class="code" href="structQuaZipFileInfo64.html" title="Information about a file inside archive (with zip64 support).">QuaZipFileInfo64</a>* info)<span class="keyword">const</span>; |
172 |
<a name="l00387"></a>00387 |
173 |
<a name="l00393"></a>00393 <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qstring.html">QString</a> getCurrentFileName()<span class="keyword">const</span>; |
174 |
<a name="l00395"></a>00395 |
175 |
<a name="l00410"></a>00410 unzFile getUnzFile(); |
176 |
<a name="l00412"></a>00412 |
177 |
<a name="l00416"></a>00416 zipFile getZipFile(); |
178 |
<a name="l00418"></a>00418 |
179 |
<a name="l00445"></a>00445 <span class="keywordtype">void</span> setDataDescriptorWritingEnabled(<span class="keywordtype">bool</span> enabled); |
180 |
<a name="l00447"></a>00447 |
181 |
<a name="l00450"></a>00450 <span class="keywordtype">bool</span> isDataDescriptorWritingEnabled() <span class="keyword">const</span>; |
182 |
<a name="l00452"></a>00452 |
183 |
<a name="l00458"></a>00458 <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qstringlist.html">QStringList</a> getFileNameList() <span class="keyword">const</span>; |
184 |
<a name="l00460"></a>00460 |
185 |
<a name="l00472"></a>00472 <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qlist.html">QList<QuaZipFileInfo></a> getFileInfoList() <span class="keyword">const</span>; |
186 |
<a name="l00474"></a>00474 |
187 |
<a name="l00482"></a>00482 <a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qlist.html">QList<QuaZipFileInfo64></a> getFileInfoList64() <span class="keyword">const</span>; |
188 |
<a name="l00484"></a>00484 |
189 |
<a name="l00497"></a>00497 <span class="keywordtype">void</span> setZip64Enabled(<span class="keywordtype">bool</span> zip64); |
190 |
<a name="l00499"></a>00499 |
191 |
<a name="l00504"></a>00504 <span class="keywordtype">bool</span> isZip64Enabled() <span class="keyword">const</span>; |
192 |
<a name="l00506"></a>00506 |
193 |
<a name="l00509"></a>00509 <span class="keywordtype">bool</span> isAutoClose() <span class="keyword">const</span>; |
194 |
<a name="l00511"></a>00511 |
195 |
<a name="l00531"></a>00531 <span class="keywordtype">void</span> setAutoClose(<span class="keywordtype">bool</span> autoClose) <span class="keyword">const</span>; |
196 |
<a name="l00533"></a>00533 |
197 |
<a name="l00562"></a>00562 <span class="keyword">static</span> <span class="keywordtype">void</span> setDefaultFileNameCodec(<a class="codeRef" doxygen="qtcore.tags:http://doc.qt.io/qt-5//" href="http://doc.qt.io/qt-5/qtextcodec.html">QTextCodec</a> *codec); |
198 |
<a name="l00568"></a>00568 <span class="keyword">static</span> <span class="keywordtype">void</span> setDefaultFileNameCodec(<span class="keyword">const</span> <span class="keywordtype">char</span> *codecName); |
199 |
<a name="l00569"></a>00569 }; |
200 |
<a name="l00570"></a>00570 |
201 |
<a name="l00571"></a>00571 <span class="preprocessor">#endif</span> |
202 |
</pre></div></div> |
203 |
</div> |
204 |
<hr class="footer"/><address class="footer"><small>Generated on Sun Apr 3 2016 08:26:24 for QuaZIP by  |
205 |
<a href="http://www.doxygen.org/index.html"> |
206 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> |
207 |
</body> |
208 |
</html> |