/usr/share/doc/libjuce/apiref/classZipFile.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 | <!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: ZipFile 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">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classZipFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ZipFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Decodes a ZIP file from a stream.
<a href="classZipFile.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile_1_1Builder.html">Builder</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Used to create a new zip file. <a href="classZipFile_1_1Builder.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structZipFile_1_1ZipEntry.html">ZipEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Contains information about one of the entries in a <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a>. <a href="structZipFile_1_1ZipEntry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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:aed7c61ad49b425119915544015dab3e8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#aed7c61ad49b425119915544015dab3e8">ZipFile</a> (const <a class="el" href="classFile.html">File</a> &file)</td></tr>
<tr class="memdesc:aed7c61ad49b425119915544015dab3e8"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> to read a specific file. <a href="#aed7c61ad49b425119915544015dab3e8">More...</a><br /></td></tr>
<tr class="separator:aed7c61ad49b425119915544015dab3e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b251067cc8a29f88eeaf02dfe0e3658"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#a8b251067cc8a29f88eeaf02dfe0e3658">ZipFile</a> (<a class="el" href="classInputStream.html">InputStream</a> *inputStream, bool deleteStreamWhenDestroyed)</td></tr>
<tr class="memdesc:a8b251067cc8a29f88eeaf02dfe0e3658"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> for a given stream. <a href="#a8b251067cc8a29f88eeaf02dfe0e3658">More...</a><br /></td></tr>
<tr class="separator:a8b251067cc8a29f88eeaf02dfe0e3658"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafe1b3e2329e6af9c318d03d3aa88704"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#aafe1b3e2329e6af9c318d03d3aa88704">ZipFile</a> (<a class="el" href="classInputStream.html">InputStream</a> &inputStream)</td></tr>
<tr class="memdesc:aafe1b3e2329e6af9c318d03d3aa88704"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> for a given stream. <a href="#aafe1b3e2329e6af9c318d03d3aa88704">More...</a><br /></td></tr>
<tr class="separator:aafe1b3e2329e6af9c318d03d3aa88704"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaaa0dfb96daf669363ef206b48cf889b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#aaaa0dfb96daf669363ef206b48cf889b">ZipFile</a> (<a class="el" href="classInputSource.html">InputSource</a> *inputSource)</td></tr>
<tr class="memdesc:aaaa0dfb96daf669363ef206b48cf889b"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> for an input source. <a href="#aaaa0dfb96daf669363ef206b48cf889b">More...</a><br /></td></tr>
<tr class="separator:aaaa0dfb96daf669363ef206b48cf889b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a748c38101270b6e3856738f8ca02c357"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#a748c38101270b6e3856738f8ca02c357">~ZipFile</a> ()</td></tr>
<tr class="memdesc:a748c38101270b6e3856738f8ca02c357"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a748c38101270b6e3856738f8ca02c357">More...</a><br /></td></tr>
<tr class="separator:a748c38101270b6e3856738f8ca02c357"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33219c1047e6061a6835e5381dc0f06a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#a33219c1047e6061a6835e5381dc0f06a">getNumEntries</a> () const noexcept</td></tr>
<tr class="memdesc:a33219c1047e6061a6835e5381dc0f06a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of items in the zip file. <a href="#a33219c1047e6061a6835e5381dc0f06a">More...</a><br /></td></tr>
<tr class="separator:a33219c1047e6061a6835e5381dc0f06a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7168a5f54bed9f81e006f4f1ba880bf5"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structZipFile_1_1ZipEntry.html">ZipEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#a7168a5f54bed9f81e006f4f1ba880bf5">getEntry</a> (int index) const noexcept</td></tr>
<tr class="memdesc:a7168a5f54bed9f81e006f4f1ba880bf5"><td class="mdescLeft"> </td><td class="mdescRight">Returns a structure that describes one of the entries in the zip file. <a href="#a7168a5f54bed9f81e006f4f1ba880bf5">More...</a><br /></td></tr>
<tr class="separator:a7168a5f54bed9f81e006f4f1ba880bf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae828c6862f8a8305b5c3aca0a42417cf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#ae828c6862f8a8305b5c3aca0a42417cf">getIndexOfFileName</a> (const <a class="el" href="classString.html">String</a> &fileName) const noexcept</td></tr>
<tr class="memdesc:ae828c6862f8a8305b5c3aca0a42417cf"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the first entry with a given filename. <a href="#ae828c6862f8a8305b5c3aca0a42417cf">More...</a><br /></td></tr>
<tr class="separator:ae828c6862f8a8305b5c3aca0a42417cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e0686509a027efcce8adba4ec7b0044"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structZipFile_1_1ZipEntry.html">ZipEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#a6e0686509a027efcce8adba4ec7b0044">getEntry</a> (const <a class="el" href="classString.html">String</a> &fileName) const noexcept</td></tr>
<tr class="memdesc:a6e0686509a027efcce8adba4ec7b0044"><td class="mdescLeft"> </td><td class="mdescRight">Returns a structure that describes one of the entries in the zip file. <a href="#a6e0686509a027efcce8adba4ec7b0044">More...</a><br /></td></tr>
<tr class="separator:a6e0686509a027efcce8adba4ec7b0044"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af33762dfb0bbe8ac0973d239eba4a376"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#af33762dfb0bbe8ac0973d239eba4a376">sortEntriesByFilename</a> ()</td></tr>
<tr class="memdesc:af33762dfb0bbe8ac0973d239eba4a376"><td class="mdescLeft"> </td><td class="mdescRight">Sorts the list of entries, based on the filename. <a href="#af33762dfb0bbe8ac0973d239eba4a376">More...</a><br /></td></tr>
<tr class="separator:af33762dfb0bbe8ac0973d239eba4a376"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cf25194d5a64e2bd0f4cb7b06262fc3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classInputStream.html">InputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#a5cf25194d5a64e2bd0f4cb7b06262fc3">createStreamForEntry</a> (int index)</td></tr>
<tr class="memdesc:a5cf25194d5a64e2bd0f4cb7b06262fc3"><td class="mdescLeft"> </td><td class="mdescRight">Creates a stream that can read from one of the zip file's entries. <a href="#a5cf25194d5a64e2bd0f4cb7b06262fc3">More...</a><br /></td></tr>
<tr class="separator:a5cf25194d5a64e2bd0f4cb7b06262fc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a510549a79f1c552162839c7aa69286a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classInputStream.html">InputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#a510549a79f1c552162839c7aa69286a4">createStreamForEntry</a> (const <a class="el" href="structZipFile_1_1ZipEntry.html">ZipEntry</a> &entry)</td></tr>
<tr class="memdesc:a510549a79f1c552162839c7aa69286a4"><td class="mdescLeft"> </td><td class="mdescRight">Creates a stream that can read from one of the zip file's entries. <a href="#a510549a79f1c552162839c7aa69286a4">More...</a><br /></td></tr>
<tr class="separator:a510549a79f1c552162839c7aa69286a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d8bc0a4215a9464886909e527946155"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classResult.html">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#a4d8bc0a4215a9464886909e527946155">uncompressTo</a> (const <a class="el" href="classFile.html">File</a> &targetDirectory, bool shouldOverwriteFiles=true)</td></tr>
<tr class="memdesc:a4d8bc0a4215a9464886909e527946155"><td class="mdescLeft"> </td><td class="mdescRight">Uncompresses all of the files in the zip file. <a href="#a4d8bc0a4215a9464886909e527946155">More...</a><br /></td></tr>
<tr class="separator:a4d8bc0a4215a9464886909e527946155"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7a3e0db6aa5d2cb75028251501e4dfc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classResult.html">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classZipFile.html#aa7a3e0db6aa5d2cb75028251501e4dfc">uncompressEntry</a> (int index, const <a class="el" href="classFile.html">File</a> &targetDirectory, bool shouldOverwriteFiles=true)</td></tr>
<tr class="memdesc:aa7a3e0db6aa5d2cb75028251501e4dfc"><td class="mdescLeft"> </td><td class="mdescRight">Uncompresses one of the entries from the zip file. <a href="#aa7a3e0db6aa5d2cb75028251501e4dfc">More...</a><br /></td></tr>
<tr class="separator:aa7a3e0db6aa5d2cb75028251501e4dfc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Decodes a ZIP file from a stream. </p>
<p>This can enumerate the items in a ZIP file and can create suitable stream objects to read each one. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aed7c61ad49b425119915544015dab3e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed7c61ad49b425119915544015dab3e8">§ </a></span>ZipFile() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ZipFile::ZipFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> to read a specific file. </p>
</div>
</div>
<a id="a8b251067cc8a29f88eeaf02dfe0e3658"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b251067cc8a29f88eeaf02dfe0e3658">§ </a></span>ZipFile() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ZipFile::ZipFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classInputStream.html">InputStream</a> * </td>
<td class="paramname"><em>inputStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>deleteStreamWhenDestroyed</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> for a given stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inputStream</td><td>the stream to read from </td></tr>
<tr><td class="paramname">deleteStreamWhenDestroyed</td><td>if set to true, the object passed-in will be deleted when this <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> object is deleted </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aafe1b3e2329e6af9c318d03d3aa88704"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafe1b3e2329e6af9c318d03d3aa88704">§ </a></span>ZipFile() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ZipFile::ZipFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classInputStream.html">InputStream</a> & </td>
<td class="paramname"><em>inputStream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> for a given stream. </p>
<p>The stream will not be owned or deleted by this class - if you want the <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> to manage the stream's lifetime, use the other constructor. </p>
</div>
</div>
<a id="aaaa0dfb96daf669363ef206b48cf889b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaaa0dfb96daf669363ef206b48cf889b">§ </a></span>ZipFile() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ZipFile::ZipFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classInputSource.html">InputSource</a> * </td>
<td class="paramname"><em>inputSource</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> for an input source. </p>
<p>The inputSource object will be owned by the zip file, which will delete it later when not needed. </p>
</div>
</div>
<a id="a748c38101270b6e3856738f8ca02c357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a748c38101270b6e3856738f8ca02c357">§ </a></span>~ZipFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ZipFile::~ZipFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a33219c1047e6061a6835e5381dc0f06a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33219c1047e6061a6835e5381dc0f06a">§ </a></span>getNumEntries()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ZipFile::getNumEntries </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of items in the zip file. </p>
</div>
</div>
<a id="a7168a5f54bed9f81e006f4f1ba880bf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7168a5f54bed9f81e006f4f1ba880bf5">§ </a></span>getEntry() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structZipFile_1_1ZipEntry.html">ZipEntry</a>* ZipFile::getEntry </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a structure that describes one of the entries in the zip file. </p>
<p>This may return a nullptr if the index is out of range. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structZipFile_1_1ZipEntry.html" title="Contains information about one of the entries in a ZipFile. ">ZipFile::ZipEntry</a> </dd></dl>
</div>
</div>
<a id="ae828c6862f8a8305b5c3aca0a42417cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae828c6862f8a8305b5c3aca0a42417cf">§ </a></span>getIndexOfFileName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ZipFile::getIndexOfFileName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>fileName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the index of the first entry with a given filename. </p>
<p>This uses a case-sensitive comparison to look for a filename in the list of entries. It might return -1 if no match is found.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structZipFile_1_1ZipEntry.html" title="Contains information about one of the entries in a ZipFile. ">ZipFile::ZipEntry</a> </dd></dl>
</div>
</div>
<a id="a6e0686509a027efcce8adba4ec7b0044"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e0686509a027efcce8adba4ec7b0044">§ </a></span>getEntry() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structZipFile_1_1ZipEntry.html">ZipEntry</a>* ZipFile::getEntry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>fileName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a structure that describes one of the entries in the zip file. </p>
<p>This uses a case-sensitive comparison to look for a filename in the list of entries. It might return 0 if no match is found.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structZipFile_1_1ZipEntry.html" title="Contains information about one of the entries in a ZipFile. ">ZipFile::ZipEntry</a> </dd></dl>
</div>
</div>
<a id="af33762dfb0bbe8ac0973d239eba4a376"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af33762dfb0bbe8ac0973d239eba4a376">§ </a></span>sortEntriesByFilename()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ZipFile::sortEntriesByFilename </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sorts the list of entries, based on the filename. </p>
</div>
</div>
<a id="a5cf25194d5a64e2bd0f4cb7b06262fc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cf25194d5a64e2bd0f4cb7b06262fc3">§ </a></span>createStreamForEntry() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classInputStream.html">InputStream</a>* ZipFile::createStreamForEntry </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a stream that can read from one of the zip file's entries. </p>
<p>The stream that is returned must be deleted by the caller (and a nullptr might be returned if a stream can't be opened for some reason).</p>
<p>The stream must not be used after the <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> object that created has been deleted.</p>
<p>Note that if the <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> was created with a user-supplied <a class="el" href="classInputStream.html" title="The base class for streams that read data. ">InputStream</a> object, then all the streams which are created by this method will by trying to share the same source stream, so cannot be safely used on multiple threads! (But if you create the <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> from a <a class="el" href="classFile.html" title="Represents a local file or directory. ">File</a> or <a class="el" href="classInputSource.html" title="A lightweight object that can create a stream to read some kind of resource. ">InputSource</a>, then it is safe to do this). </p>
</div>
</div>
<a id="a510549a79f1c552162839c7aa69286a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a510549a79f1c552162839c7aa69286a4">§ </a></span>createStreamForEntry() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classInputStream.html">InputStream</a>* ZipFile::createStreamForEntry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structZipFile_1_1ZipEntry.html">ZipEntry</a> & </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a stream that can read from one of the zip file's entries. </p>
<p>The stream that is returned must be deleted by the caller (and a nullptr might be returned if a stream can't be opened for some reason).</p>
<p>The stream must not be used after the <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> object that created has been deleted.</p>
<p>Note that if the <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> was created with a user-supplied <a class="el" href="classInputStream.html" title="The base class for streams that read data. ">InputStream</a> object, then all the streams which are created by this method will by trying to share the same source stream, so cannot be safely used on multiple threads! (But if you create the <a class="el" href="classZipFile.html" title="Decodes a ZIP file from a stream. ">ZipFile</a> from a <a class="el" href="classFile.html" title="Represents a local file or directory. ">File</a> or <a class="el" href="classInputSource.html" title="A lightweight object that can create a stream to read some kind of resource. ">InputSource</a>, then it is safe to do this). </p>
</div>
</div>
<a id="a4d8bc0a4215a9464886909e527946155"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d8bc0a4215a9464886909e527946155">§ </a></span>uncompressTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classResult.html">Result</a> ZipFile::uncompressTo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>targetDirectory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shouldOverwriteFiles</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uncompresses all of the files in the zip file. </p>
<p>This will expand all the entries into a target directory. The relative paths of the entries are used.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">targetDirectory</td><td>the root folder to uncompress to </td></tr>
<tr><td class="paramname">shouldOverwriteFiles</td><td>whether to overwrite existing files with similarly-named ones </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success if the file is successfully unzipped </dd></dl>
</div>
</div>
<a id="aa7a3e0db6aa5d2cb75028251501e4dfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7a3e0db6aa5d2cb75028251501e4dfc">§ </a></span>uncompressEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classResult.html">Result</a> ZipFile::uncompressEntry </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>targetDirectory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shouldOverwriteFiles</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uncompresses one of the entries from the zip file. </p>
<p>This will expand the entry and write it in a target directory. The entry's path is used to determine which subfolder of the target should contain the new file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>the index of the entry to uncompress - this must be a valid index between 0 and (<a class="el" href="classZipFile.html#a33219c1047e6061a6835e5381dc0f06a" title="Returns the number of items in the zip file. ">getNumEntries()</a> - 1). </td></tr>
<tr><td class="paramname">targetDirectory</td><td>the root folder to uncompress into </td></tr>
<tr><td class="paramname">shouldOverwriteFiles</td><td>whether to overwrite existing files with similarly-named ones </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success if all the files are successfully unzipped </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ZipFile_8h.html">juce_ZipFile.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|