source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1ZipArchive.html @ 657

Revision 657, 35.5 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ZipArchive class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::ZipArchive Class Reference</h1>Specialisation of the <a class="el" href="classOgre_1_1Archive.html">Archive</a> class to allow reading of files from a zip format source archive. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ZipArchive:
16<p><center><img src="classOgre_1_1ZipArchive.png" usemap="#Ogre::ZipArchive_map" border="0" alt=""></center>
17<map name="Ogre::ZipArchive_map">
18<area href="classOgre_1_1Archive.html" alt="Ogre::Archive" shape="rect" coords="0,0,111,24">
19</map>
20<a href="classOgre_1_1ZipArchive-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea0">ZipArchive</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;archType)</td></tr>
24
25<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea1">~ZipArchive</a> ()</td></tr>
26
27<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea2">isCaseSensitive</a> (void) const </td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">  <a href="#Ogre_1_1ZipArchivea2"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea3">load</a> ()</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Remarks:</b></dt><dd>This initializes all the internal data of the class. </dd></dl>
33<dl compact><dt><b>Warning:</b></dt><dd>Do not call this function directly, it is ment to be used only by the <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> class.</dd></dl>
34  <a href="#Ogre_1_1ZipArchivea3"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea4">unload</a> ()</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Warning:</b></dt><dd>Do not call this function directly, it is ment to be used only by the <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> class.</dd></dl>
38  <a href="#Ogre_1_1ZipArchivea4"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea5">open</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;filename) const </td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Note:</b></dt><dd>There is no equivalent 'close' method; the returned stream controls the lifecycle of this file operation. </dd></dl>
42<dl compact><dt><b>Parameters:</b></dt><dd>
43  <table border="0" cellspacing="2" cellpadding="0">
44    <tr><td valign=top><em>filename</em>&nbsp;</td><td>The fully qualified name of the file </td></tr>
45  </table>
46</dl>
47<dl compact><dt><b>Returns:</b></dt><dd>A shared pointer to a <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> which can be used to read / write the file. If the file is not present, returns a null shared pointer.</dd></dl>
48  <a href="#Ogre_1_1ZipArchivea5"></a><br><br></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea6">list</a> (bool recursive=true)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using listFileInfo. </dd></dl>
52<dl compact><dt><b>Parameters:</b></dt><dd>
53  <table border="0" cellspacing="2" cellpadding="0">
54    <tr><td valign=top><em>recursive</em>&nbsp;</td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr>
55  </table>
56</dl>
57<dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified</dd></dl>
58  <a href="#Ogre_1_1ZipArchivea6"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea7">listFileInfo</a> (bool recursive=true)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd>
62  <table border="0" cellspacing="2" cellpadding="0">
63    <tr><td valign=top><em>recursive</em>&nbsp;</td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr>
64  </table>
65</dl>
66<dl compact><dt><b>Returns:</b></dt><dd>A list of structures detailing quite a lot of information about all the files in the archive.</dd></dl>
67  <a href="#Ogre_1_1ZipArchivea7"></a><br><br></td></tr>
68<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea8">find</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;pattern, bool recursive=true)</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using findFileInfo. </dd></dl>
71<dl compact><dt><b>Parameters:</b></dt><dd>
72  <table border="0" cellspacing="2" cellpadding="0">
73    <tr><td valign=top><em>pattern</em>&nbsp;</td><td>The pattern to search for; wildcards (*) are allowed </td></tr>
74    <tr><td valign=top><em>recursive</em>&nbsp;</td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr>
75  </table>
76</dl>
77<dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified</dd></dl>
78  <a href="#Ogre_1_1ZipArchivea8"></a><br><br></td></tr>
79<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea9">findFileInfo</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;pattern, bool recursive=true)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd>
82  <table border="0" cellspacing="2" cellpadding="0">
83    <tr><td valign=top><em>pattern</em>&nbsp;</td><td>The pattern to search for; wildcards (*) are allowed </td></tr>
84    <tr><td valign=top><em>recursive</em>&nbsp;</td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr>
85  </table>
86</dl>
87<dl compact><dt><b>Returns:</b></dt><dd>A list of file information structures for all files matching the criteria.</dd></dl>
88  <a href="#Ogre_1_1ZipArchivea9"></a><br><br></td></tr>
89<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea10">exists</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;filename)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">  <a href="#Ogre_1_1ZipArchivea10"></a><br><br></td></tr>
92<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivea11">getName</a> (void) const </td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of this archive.  <a href="#Ogre_1_1ZipArchivea11"></a><br><br></td></tr>
95<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivea12">getType</a> (void) const </td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the type code of this <a class="el" href="classOgre_1_1Archive.html">Archive</a>.  <a href="#Ogre_1_1ZipArchivea12"></a><br><br></td></tr>
98<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
99<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchiveb0">checkZzipError</a> (int zzipError, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;operation) const </td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handle any errors from zzip.  <a href="#Ogre_1_1ZipArchiveb0"></a><br><br></td></tr>
102<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
103<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="OgreZip_8h.html#a0">ZZIP_DIR</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivep0">mZzipDir</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handle to root zip file.  <a href="#Ogre_1_1ZipArchivep0"></a><br><br></td></tr>
106<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a2">FileInfoList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivep1">mFileList</a></td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">File list (since zziplib seems to only allow scanning of dir tree once).  <a href="#Ogre_1_1ZipArchivep1"></a><br><br></td></tr>
109<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivep2">mName</a></td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOgre_1_1Archive.html">Archive</a> name.  <a href="#Ogre_1_1ZipArchivep2"></a><br><br></td></tr>
112<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivep3">mType</a></td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOgre_1_1Archive.html">Archive</a> type code.  <a href="#Ogre_1_1ZipArchivep3"></a><br><br></td></tr>
115</table>
116<hr><a name="_details"></a><h2>Detailed Description</h2>
117Specialisation of the <a class="el" href="classOgre_1_1Archive.html">Archive</a> class to allow reading of files from a zip format source archive.
118<p>
119<dl compact><dt><b>Remarks:</b></dt><dd>This archive format supports all archives compressed in the standard zip format, including iD pk3 files. </dd></dl>
120
121<p>
122
123<p>
124Definition at line <a class="el" href="OgreZip_8h-source.html#l00045">45</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
125<a class="anchor" name="Ogre_1_1ZipArchivea0" doxytag="Ogre::ZipArchive::ZipArchive" ></a><p>
126<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
127  <tr>
128    <td class="mdRow">
129      <table cellpadding="0" cellspacing="0" border="0">
130        <tr>
131          <td class="md" nowrap valign="top"> Ogre::ZipArchive::ZipArchive </td>
132          <td class="md" valign="top">(&nbsp;</td>
133          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
134          <td class="mdname" nowrap> <em>name</em>, </td>
135        </tr>
136        <tr>
137          <td class="md" nowrap align="right"></td>
138          <td></td>
139          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
140          <td class="mdname" nowrap> <em>archType</em></td>
141        </tr>
142        <tr>
143          <td></td>
144          <td class="md">)&nbsp;</td>
145          <td class="md" colspan="2"></td>
146        </tr>
147
148      </table>
149    </td>
150  </tr>
151</table>
152<table cellspacing=5 cellpadding=0 border=0>
153  <tr>
154    <td>
155      &nbsp;
156    </td>
157    <td>
158
159<p>
160    </td>
161  </tr>
162</table>
163<a class="anchor" name="Ogre_1_1ZipArchivea1" doxytag="Ogre::ZipArchive::~ZipArchive" ></a><p>
164<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
165  <tr>
166    <td class="mdRow">
167      <table cellpadding="0" cellspacing="0" border="0">
168        <tr>
169          <td class="md" nowrap valign="top"> Ogre::ZipArchive::~<a class="el" href="classOgre_1_1ZipArchive.html">ZipArchive</a> </td>
170          <td class="md" valign="top">(&nbsp;</td>
171          <td class="mdname1" valign="top" nowrap>          </td>
172          <td class="md" valign="top">&nbsp;)&nbsp;</td>
173          <td class="md" nowrap></td>
174        </tr>
175
176      </table>
177    </td>
178  </tr>
179</table>
180<table cellspacing=5 cellpadding=0 border=0>
181  <tr>
182    <td>
183      &nbsp;
184    </td>
185    <td>
186
187<p>
188    </td>
189  </tr>
190</table>
191<hr><h2>Member Function Documentation</h2>
192<a class="anchor" name="Ogre_1_1ZipArchiveb0" doxytag="Ogre::ZipArchive::checkZzipError" ></a><p>
193<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
194  <tr>
195    <td class="mdRow">
196      <table cellpadding="0" cellspacing="0" border="0">
197        <tr>
198          <td class="md" nowrap valign="top"> void Ogre::ZipArchive::checkZzipError </td>
199          <td class="md" valign="top">(&nbsp;</td>
200          <td class="md" nowrap valign="top">int&nbsp;</td>
201          <td class="mdname" nowrap> <em>zzipError</em>, </td>
202        </tr>
203        <tr>
204          <td class="md" nowrap align="right"></td>
205          <td></td>
206          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
207          <td class="mdname" nowrap> <em>operation</em></td>
208        </tr>
209        <tr>
210          <td></td>
211          <td class="md">)&nbsp;</td>
212          <td class="md" colspan="2"> const<code> [protected]</code></td>
213        </tr>
214
215      </table>
216    </td>
217  </tr>
218</table>
219<table cellspacing=5 cellpadding=0 border=0>
220  <tr>
221    <td>
222      &nbsp;
223    </td>
224    <td>
225
226<p>
227Handle any errors from zzip.
228<p>
229    </td>
230  </tr>
231</table>
232<a class="anchor" name="Ogre_1_1ZipArchivea10" doxytag="Ogre::ZipArchive::exists" ></a><p>
233<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
234  <tr>
235    <td class="mdRow">
236      <table cellpadding="0" cellspacing="0" border="0">
237        <tr>
238          <td class="md" nowrap valign="top"> bool Ogre::ZipArchive::exists </td>
239          <td class="md" valign="top">(&nbsp;</td>
240          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
241          <td class="mdname1" valign="top" nowrap> <em>filename</em>          </td>
242          <td class="md" valign="top">&nbsp;)&nbsp;</td>
243          <td class="md" nowrap><code> [virtual]</code></td>
244        </tr>
245
246      </table>
247    </td>
248  </tr>
249</table>
250<table cellspacing=5 cellpadding=0 border=0>
251  <tr>
252    <td>
253      &nbsp;
254    </td>
255    <td>
256
257<p>
258 
259<p>
260
261<p>
262Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea10">Ogre::Archive</a>.    </td>
263  </tr>
264</table>
265<a class="anchor" name="Ogre_1_1ZipArchivea8" doxytag="Ogre::ZipArchive::find" ></a><p>
266<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
267  <tr>
268    <td class="mdRow">
269      <table cellpadding="0" cellspacing="0" border="0">
270        <tr>
271          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a> Ogre::ZipArchive::find </td>
272          <td class="md" valign="top">(&nbsp;</td>
273          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
274          <td class="mdname" nowrap> <em>pattern</em>, </td>
275        </tr>
276        <tr>
277          <td class="md" nowrap align="right"></td>
278          <td></td>
279          <td class="md" nowrap>bool&nbsp;</td>
280          <td class="mdname" nowrap> <em>recursive</em> = true</td>
281        </tr>
282        <tr>
283          <td></td>
284          <td class="md">)&nbsp;</td>
285          <td class="md" colspan="2"><code> [virtual]</code></td>
286        </tr>
287
288      </table>
289    </td>
290  </tr>
291</table>
292<table cellspacing=5 cellpadding=0 border=0>
293  <tr>
294    <td>
295      &nbsp;
296    </td>
297    <td>
298
299<p>
300<dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using findFileInfo. </dd></dl>
301<dl compact><dt><b>Parameters:</b></dt><dd>
302  <table border="0" cellspacing="2" cellpadding="0">
303    <tr><td valign=top><em>pattern</em>&nbsp;</td><td>The pattern to search for; wildcards (*) are allowed </td></tr>
304    <tr><td valign=top><em>recursive</em>&nbsp;</td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr>
305  </table>
306</dl>
307<dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified</dd></dl>
308 
309<p>
310
311<p>
312Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea9">Ogre::Archive</a>.    </td>
313  </tr>
314</table>
315<a class="anchor" name="Ogre_1_1ZipArchivea9" doxytag="Ogre::ZipArchive::findFileInfo" ></a><p>
316<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
317  <tr>
318    <td class="mdRow">
319      <table cellpadding="0" cellspacing="0" border="0">
320        <tr>
321          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a> Ogre::ZipArchive::findFileInfo </td>
322          <td class="md" valign="top">(&nbsp;</td>
323          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
324          <td class="mdname" nowrap> <em>pattern</em>, </td>
325        </tr>
326        <tr>
327          <td class="md" nowrap align="right"></td>
328          <td></td>
329          <td class="md" nowrap>bool&nbsp;</td>
330          <td class="mdname" nowrap> <em>recursive</em> = true</td>
331        </tr>
332        <tr>
333          <td></td>
334          <td class="md">)&nbsp;</td>
335          <td class="md" colspan="2"><code> [virtual]</code></td>
336        </tr>
337
338      </table>
339    </td>
340  </tr>
341</table>
342<table cellspacing=5 cellpadding=0 border=0>
343  <tr>
344    <td>
345      &nbsp;
346    </td>
347    <td>
348
349<p>
350<dl compact><dt><b>Parameters:</b></dt><dd>
351  <table border="0" cellspacing="2" cellpadding="0">
352    <tr><td valign=top><em>pattern</em>&nbsp;</td><td>The pattern to search for; wildcards (*) are allowed </td></tr>
353    <tr><td valign=top><em>recursive</em>&nbsp;</td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr>
354  </table>
355</dl>
356<dl compact><dt><b>Returns:</b></dt><dd>A list of file information structures for all files matching the criteria.</dd></dl>
357 
358<p>
359
360<p>
361Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea11">Ogre::Archive</a>.    </td>
362  </tr>
363</table>
364<a class="anchor" name="Ogre_1_1ZipArchivea11" doxytag="Ogre::ZipArchive::getName" ></a><p>
365<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
366  <tr>
367    <td class="mdRow">
368      <table cellpadding="0" cellspacing="0" border="0">
369        <tr>
370          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::Archive::getName </td>
371          <td class="md" valign="top">(&nbsp;</td>
372          <td class="md" nowrap valign="top">void&nbsp;</td>
373          <td class="mdname1" valign="top" nowrap>          </td>
374          <td class="md" valign="top">&nbsp;)&nbsp;</td>
375          <td class="md" nowrap> const<code> [inherited]</code></td>
376        </tr>
377
378      </table>
379    </td>
380  </tr>
381</table>
382<table cellspacing=5 cellpadding=0 border=0>
383  <tr>
384    <td>
385      &nbsp;
386    </td>
387    <td>
388
389<p>
390Get the name of this archive.
391<p>
392
393<p>
394Definition at line <a class="el" href="OgreArchive_8h-source.html#l00096">96</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>.
395<p>
396References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
397  </tr>
398</table>
399<a class="anchor" name="Ogre_1_1ZipArchivea12" doxytag="Ogre::ZipArchive::getType" ></a><p>
400<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
401  <tr>
402    <td class="mdRow">
403      <table cellpadding="0" cellspacing="0" border="0">
404        <tr>
405          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::Archive::getType </td>
406          <td class="md" valign="top">(&nbsp;</td>
407          <td class="md" nowrap valign="top">void&nbsp;</td>
408          <td class="mdname1" valign="top" nowrap>          </td>
409          <td class="md" valign="top">&nbsp;)&nbsp;</td>
410          <td class="md" nowrap> const<code> [inherited]</code></td>
411        </tr>
412
413      </table>
414    </td>
415  </tr>
416</table>
417<table cellspacing=5 cellpadding=0 border=0>
418  <tr>
419    <td>
420      &nbsp;
421    </td>
422    <td>
423
424<p>
425Return the type code of this <a class="el" href="classOgre_1_1Archive.html">Archive</a>.
426<p>
427
428<p>
429Definition at line <a class="el" href="OgreArchive_8h-source.html#l00172">172</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>.
430<p>
431References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
432  </tr>
433</table>
434<a class="anchor" name="Ogre_1_1ZipArchivea2" doxytag="Ogre::ZipArchive::isCaseSensitive" ></a><p>
435<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
436  <tr>
437    <td class="mdRow">
438      <table cellpadding="0" cellspacing="0" border="0">
439        <tr>
440          <td class="md" nowrap valign="top"> bool Ogre::ZipArchive::isCaseSensitive </td>
441          <td class="md" valign="top">(&nbsp;</td>
442          <td class="md" nowrap valign="top">void&nbsp;</td>
443          <td class="mdname1" valign="top" nowrap>          </td>
444          <td class="md" valign="top">&nbsp;)&nbsp;</td>
445          <td class="md" nowrap> const<code> [virtual]</code></td>
446        </tr>
447
448      </table>
449    </td>
450  </tr>
451</table>
452<table cellspacing=5 cellpadding=0 border=0>
453  <tr>
454    <td>
455      &nbsp;
456    </td>
457    <td>
458
459<p>
460 
461<p>
462
463<p>
464Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea3">Ogre::Archive</a>.
465<p>
466Definition at line <a class="el" href="OgreZip_8h-source.html#l00058">58</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.    </td>
467  </tr>
468</table>
469<a class="anchor" name="Ogre_1_1ZipArchivea6" doxytag="Ogre::ZipArchive::list" ></a><p>
470<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
471  <tr>
472    <td class="mdRow">
473      <table cellpadding="0" cellspacing="0" border="0">
474        <tr>
475          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a> Ogre::ZipArchive::list </td>
476          <td class="md" valign="top">(&nbsp;</td>
477          <td class="md" nowrap valign="top">bool&nbsp;</td>
478          <td class="mdname1" valign="top" nowrap> <em>recursive</em> = true          </td>
479          <td class="md" valign="top">&nbsp;)&nbsp;</td>
480          <td class="md" nowrap><code> [virtual]</code></td>
481        </tr>
482
483      </table>
484    </td>
485  </tr>
486</table>
487<table cellspacing=5 cellpadding=0 border=0>
488  <tr>
489    <td>
490      &nbsp;
491    </td>
492    <td>
493
494<p>
495<dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using listFileInfo. </dd></dl>
496<dl compact><dt><b>Parameters:</b></dt><dd>
497  <table border="0" cellspacing="2" cellpadding="0">
498    <tr><td valign=top><em>recursive</em>&nbsp;</td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr>
499  </table>
500</dl>
501<dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified</dd></dl>
502 
503<p>
504
505<p>
506Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea7">Ogre::Archive</a>.    </td>
507  </tr>
508</table>
509<a class="anchor" name="Ogre_1_1ZipArchivea7" doxytag="Ogre::ZipArchive::listFileInfo" ></a><p>
510<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
511  <tr>
512    <td class="mdRow">
513      <table cellpadding="0" cellspacing="0" border="0">
514        <tr>
515          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a> Ogre::ZipArchive::listFileInfo </td>
516          <td class="md" valign="top">(&nbsp;</td>
517          <td class="md" nowrap valign="top">bool&nbsp;</td>
518          <td class="mdname1" valign="top" nowrap> <em>recursive</em> = true          </td>
519          <td class="md" valign="top">&nbsp;)&nbsp;</td>
520          <td class="md" nowrap><code> [virtual]</code></td>
521        </tr>
522
523      </table>
524    </td>
525  </tr>
526</table>
527<table cellspacing=5 cellpadding=0 border=0>
528  <tr>
529    <td>
530      &nbsp;
531    </td>
532    <td>
533
534<p>
535<dl compact><dt><b>Parameters:</b></dt><dd>
536  <table border="0" cellspacing="2" cellpadding="0">
537    <tr><td valign=top><em>recursive</em>&nbsp;</td><td>Whether all paths of the archive are searched (if the archive has a concept of that) </td></tr>
538  </table>
539</dl>
540<dl compact><dt><b>Returns:</b></dt><dd>A list of structures detailing quite a lot of information about all the files in the archive.</dd></dl>
541 
542<p>
543
544<p>
545Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea8">Ogre::Archive</a>.    </td>
546  </tr>
547</table>
548<a class="anchor" name="Ogre_1_1ZipArchivea3" doxytag="Ogre::ZipArchive::load" ></a><p>
549<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
550  <tr>
551    <td class="mdRow">
552      <table cellpadding="0" cellspacing="0" border="0">
553        <tr>
554          <td class="md" nowrap valign="top"> void Ogre::ZipArchive::load </td>
555          <td class="md" valign="top">(&nbsp;</td>
556          <td class="mdname1" valign="top" nowrap>          </td>
557          <td class="md" valign="top">&nbsp;)&nbsp;</td>
558          <td class="md" nowrap><code> [virtual]</code></td>
559        </tr>
560
561      </table>
562    </td>
563  </tr>
564</table>
565<table cellspacing=5 cellpadding=0 border=0>
566  <tr>
567    <td>
568      &nbsp;
569    </td>
570    <td>
571
572<p>
573<dl compact><dt><b>Remarks:</b></dt><dd>This initializes all the internal data of the class. </dd></dl>
574<dl compact><dt><b>Warning:</b></dt><dd>Do not call this function directly, it is ment to be used only by the <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> class.</dd></dl>
575 
576<p>
577
578<p>
579Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea4">Ogre::Archive</a>.    </td>
580  </tr>
581</table>
582<a class="anchor" name="Ogre_1_1ZipArchivea5" doxytag="Ogre::ZipArchive::open" ></a><p>
583<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
584  <tr>
585    <td class="mdRow">
586      <table cellpadding="0" cellspacing="0" border="0">
587        <tr>
588          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> Ogre::ZipArchive::open </td>
589          <td class="md" valign="top">(&nbsp;</td>
590          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
591          <td class="mdname1" valign="top" nowrap> <em>filename</em>          </td>
592          <td class="md" valign="top">&nbsp;)&nbsp;</td>
593          <td class="md" nowrap> const<code> [virtual]</code></td>
594        </tr>
595
596      </table>
597    </td>
598  </tr>
599</table>
600<table cellspacing=5 cellpadding=0 border=0>
601  <tr>
602    <td>
603      &nbsp;
604    </td>
605    <td>
606
607<p>
608<dl compact><dt><b>Note:</b></dt><dd>There is no equivalent 'close' method; the returned stream controls the lifecycle of this file operation. </dd></dl>
609<dl compact><dt><b>Parameters:</b></dt><dd>
610  <table border="0" cellspacing="2" cellpadding="0">
611    <tr><td valign=top><em>filename</em>&nbsp;</td><td>The fully qualified name of the file </td></tr>
612  </table>
613</dl>
614<dl compact><dt><b>Returns:</b></dt><dd>A shared pointer to a <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> which can be used to read / write the file. If the file is not present, returns a null shared pointer.</dd></dl>
615 
616<p>
617
618<p>
619Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea6">Ogre::Archive</a>.    </td>
620  </tr>
621</table>
622<a class="anchor" name="Ogre_1_1ZipArchivea4" doxytag="Ogre::ZipArchive::unload" ></a><p>
623<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
624  <tr>
625    <td class="mdRow">
626      <table cellpadding="0" cellspacing="0" border="0">
627        <tr>
628          <td class="md" nowrap valign="top"> void Ogre::ZipArchive::unload </td>
629          <td class="md" valign="top">(&nbsp;</td>
630          <td class="mdname1" valign="top" nowrap>          </td>
631          <td class="md" valign="top">&nbsp;)&nbsp;</td>
632          <td class="md" nowrap><code> [virtual]</code></td>
633        </tr>
634
635      </table>
636    </td>
637  </tr>
638</table>
639<table cellspacing=5 cellpadding=0 border=0>
640  <tr>
641    <td>
642      &nbsp;
643    </td>
644    <td>
645
646<p>
647<dl compact><dt><b>Warning:</b></dt><dd>Do not call this function directly, it is ment to be used only by the <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> class.</dd></dl>
648 
649<p>
650
651<p>
652Implements <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea5">Ogre::Archive</a>.    </td>
653  </tr>
654</table>
655<hr><h2>Member Data Documentation</h2>
656<a class="anchor" name="Ogre_1_1ZipArchivep1" doxytag="Ogre::ZipArchive::mFileList" ></a><p>
657<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
658  <tr>
659    <td class="mdRow">
660      <table cellpadding="0" cellspacing="0" border="0">
661        <tr>
662          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a2">FileInfoList</a> <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivep1">Ogre::ZipArchive::mFileList</a><code> [protected]</code>
663      </table>
664    </td>
665  </tr>
666</table>
667<table cellspacing=5 cellpadding=0 border=0>
668  <tr>
669    <td>
670      &nbsp;
671    </td>
672    <td>
673
674<p>
675File list (since zziplib seems to only allow scanning of dir tree once).
676<p>
677
678<p>
679Definition at line <a class="el" href="OgreZip_8h-source.html#l00053">53</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.    </td>
680  </tr>
681</table>
682<a class="anchor" name="Ogre_1_1ZipArchivep2" doxytag="Ogre::ZipArchive::mName" ></a><p>
683<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
684  <tr>
685    <td class="mdRow">
686      <table cellpadding="0" cellspacing="0" border="0">
687        <tr>
688          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivep2">Ogre::Archive::mName</a><code> [protected, inherited]</code>
689      </table>
690    </td>
691  </tr>
692</table>
693<table cellspacing=5 cellpadding=0 border=0>
694  <tr>
695    <td>
696      &nbsp;
697    </td>
698    <td>
699
700<p>
701<a class="el" href="classOgre_1_1Archive.html">Archive</a> name.
702<p>
703
704<p>
705Definition at line <a class="el" href="OgreArchive_8h-source.html#l00080">80</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>.    </td>
706  </tr>
707</table>
708<a class="anchor" name="Ogre_1_1ZipArchivep3" doxytag="Ogre::ZipArchive::mType" ></a><p>
709<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
710  <tr>
711    <td class="mdRow">
712      <table cellpadding="0" cellspacing="0" border="0">
713        <tr>
714          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1Archive.html#Ogre_1_1ZipArchivep3">Ogre::Archive::mType</a><code> [protected, inherited]</code>
715      </table>
716    </td>
717  </tr>
718</table>
719<table cellspacing=5 cellpadding=0 border=0>
720  <tr>
721    <td>
722      &nbsp;
723    </td>
724    <td>
725
726<p>
727<a class="el" href="classOgre_1_1Archive.html">Archive</a> type code.
728<p>
729
730<p>
731Definition at line <a class="el" href="OgreArchive_8h-source.html#l00082">82</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>.    </td>
732  </tr>
733</table>
734<a class="anchor" name="Ogre_1_1ZipArchivep0" doxytag="Ogre::ZipArchive::mZzipDir" ></a><p>
735<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
736  <tr>
737    <td class="mdRow">
738      <table cellpadding="0" cellspacing="0" border="0">
739        <tr>
740          <td class="md" nowrap valign="top"> <a class="el" href="OgreZip_8h.html#a0">ZZIP_DIR</a>* <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivep0">Ogre::ZipArchive::mZzipDir</a><code> [protected]</code>
741      </table>
742    </td>
743  </tr>
744</table>
745<table cellspacing=5 cellpadding=0 border=0>
746  <tr>
747    <td>
748      &nbsp;
749    </td>
750    <td>
751
752<p>
753Handle to root zip file.
754<p>
755
756<p>
757Definition at line <a class="el" href="OgreZip_8h-source.html#l00049">49</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.    </td>
758  </tr>
759</table>
760<hr>The documentation for this class was generated from the following file:<ul>
761<li><a class="el" href="OgreZip_8h-source.html">OgreZip.h</a></ul>
762<hr>
763<p>
764Copyright &copy; 2000-2005 by The OGRE Team<br />
765<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
766This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
767                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
768                <Work rdf:about="">
769                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
770        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
771                </Work>
772                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
773
774Last modified Sun Feb 12 13:05:05 2006
775</p>
776</body>
777</html>
Note: See TracBrowser for help on using the repository browser.