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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::Archive 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::Archive Class Reference</h1>Archive-handling class. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::Archive:
16<p><center><img src="classOgre_1_1Archive.png" usemap="#Ogre::Archive_map" border="0" alt=""></center>
17<map name="Ogre::Archive_map">
18<area href="classOgre_1_1FileSystemArchive.html" alt="Ogre::FileSystemArchive" shape="rect" coords="0,56,153,80">
19<area href="classOgre_1_1ZipArchive.html" alt="Ogre::ZipArchive" shape="rect" coords="163,56,316,80">
20</map>
21<a href="classOgre_1_1Archive-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
22<tr><td></td></tr>
23<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea0">Archive</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>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor - don't call direct, used by <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a>.  <a href="#Ogre_1_1Archivea0"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea1">~Archive</a> ()</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor.  <a href="#Ogre_1_1Archivea1"></a><br><br></td></tr>
30<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>
31
32<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>
33<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea3">isCaseSensitive</a> (void) const=0</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether this archive is case sensitive in the way it matches files.  <a href="#Ogre_1_1Archivea3"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea4">load</a> ()=0</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads the archive.  <a href="#Ogre_1_1Archivea4"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea5">unload</a> ()=0</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unloads the archive.  <a href="#Ogre_1_1Archivea5"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea6">open</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;filename) const=0</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open a stream on a given file.  <a href="#Ogre_1_1Archivea6"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea7">list</a> (bool recursive=true)=0</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">List all file names in the archive.  <a href="#Ogre_1_1Archivea7"></a><br><br></td></tr>
48<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea8">listFileInfo</a> (bool recursive=true)=0</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">List all files in the archive with accompanying information.  <a href="#Ogre_1_1Archivea8"></a><br><br></td></tr>
51<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea9">find</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;pattern, bool recursive=true)=0</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find all file names matching a given pattern in this archive.  <a href="#Ogre_1_1Archivea9"></a><br><br></td></tr>
54<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea10">exists</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;filename)=0</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find out if the named file exists (note: fully qualified filename required).  <a href="#Ogre_1_1Archivea10"></a><br><br></td></tr>
57<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Archive.html#Ogre_1_1Archivea11">findFileInfo</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;pattern, bool recursive=true)=0</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find all files matching a given pattern in this archive and get some detailed information about them.  <a href="#Ogre_1_1Archivea11"></a><br><br></td></tr>
60<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>
61
62<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>
63<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
64<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>
65
66<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>
67<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>
68
69<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>
70</table>
71<hr><a name="_details"></a><h2>Detailed Description</h2>
72Archive-handling class.
73<p>
74<dl compact><dt><b>Remarks:</b></dt><dd>An archive is a generic term for a container of files. This may be a filesystem folder, it may be a compressed archive, it may even be a remote location shared on the web. This class is designed to be subclassed to provide access to a range of file locations. </dd></dl>
75<dl compact><dt><b></b></dt><dd>Instances of this class are never constructed or even handled by end-user applications. They are constructed by custom <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> classes, which plugins can register new instances of using <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a>. End-user applications will typically use <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> or <a class="el" href="classOgre_1_1ResourceGroupManager.html">ResourceGroupManager</a> to manage resources at a higher level, rather than reading files directly through this class. Doing it this way allows you to benefit from OGRE's automatic searching of multiple file locations for the resources you are looking for. </dd></dl>
76
77<p>
78
79<p>
80Definition at line <a class="el" href="OgreArchive_8h-source.html#l00076">76</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
81<a class="anchor" name="Ogre_1_1Archivea0" doxytag="Ogre::Archive::Archive" ></a><p>
82<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
83  <tr>
84    <td class="mdRow">
85      <table cellpadding="0" cellspacing="0" border="0">
86        <tr>
87          <td class="md" nowrap valign="top"> Ogre::Archive::Archive </td>
88          <td class="md" valign="top">(&nbsp;</td>
89          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
90          <td class="mdname" nowrap> <em>name</em>, </td>
91        </tr>
92        <tr>
93          <td class="md" nowrap align="right"></td>
94          <td></td>
95          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
96          <td class="mdname" nowrap> <em>archType</em></td>
97        </tr>
98        <tr>
99          <td></td>
100          <td class="md">)&nbsp;</td>
101          <td class="md" colspan="2"></td>
102        </tr>
103
104      </table>
105    </td>
106  </tr>
107</table>
108<table cellspacing=5 cellpadding=0 border=0>
109  <tr>
110    <td>
111      &nbsp;
112    </td>
113    <td>
114
115<p>
116Constructor - don't call direct, used by <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a>.
117<p>
118
119<p>
120Definition at line <a class="el" href="OgreArchive_8h-source.html#l00088">88</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>.
121<p>
122References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
123  </tr>
124</table>
125<a class="anchor" name="Ogre_1_1Archivea1" doxytag="Ogre::Archive::~Archive" ></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"> virtual Ogre::Archive::~<a class="el" href="classOgre_1_1Archive.html">Archive</a> </td>
132          <td class="md" valign="top">(&nbsp;</td>
133          <td class="mdname1" valign="top" nowrap>          </td>
134          <td class="md" valign="top">&nbsp;)&nbsp;</td>
135          <td class="md" nowrap><code> [virtual]</code></td>
136        </tr>
137
138      </table>
139    </td>
140  </tr>
141</table>
142<table cellspacing=5 cellpadding=0 border=0>
143  <tr>
144    <td>
145      &nbsp;
146    </td>
147    <td>
148
149<p>
150Default destructor.
151<p>
152
153<p>
154Definition at line <a class="el" href="OgreArchive_8h-source.html#l00093">93</a> of file <a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a>.    </td>
155  </tr>
156</table>
157<hr><h2>Member Function Documentation</h2>
158<a class="anchor" name="Ogre_1_1Archivea10" doxytag="Ogre::Archive::exists" ></a><p>
159<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
160  <tr>
161    <td class="mdRow">
162      <table cellpadding="0" cellspacing="0" border="0">
163        <tr>
164          <td class="md" nowrap valign="top"> virtual bool Ogre::Archive::exists </td>
165          <td class="md" valign="top">(&nbsp;</td>
166          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
167          <td class="mdname1" valign="top" nowrap> <em>filename</em>          </td>
168          <td class="md" valign="top">&nbsp;)&nbsp;</td>
169          <td class="md" nowrap><code> [pure virtual]</code></td>
170        </tr>
171
172      </table>
173    </td>
174  </tr>
175</table>
176<table cellspacing=5 cellpadding=0 border=0>
177  <tr>
178    <td>
179      &nbsp;
180    </td>
181    <td>
182
183<p>
184Find out if the named file exists (note: fully qualified filename required).
185<p>
186
187<p>
188Implemented in <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea10">Ogre::FileSystemArchive</a>, and <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea10">Ogre::ZipArchive</a>.    </td>
189  </tr>
190</table>
191<a class="anchor" name="Ogre_1_1Archivea9" doxytag="Ogre::Archive::find" ></a><p>
192<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
193  <tr>
194    <td class="mdRow">
195      <table cellpadding="0" cellspacing="0" border="0">
196        <tr>
197          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a> Ogre::Archive::find </td>
198          <td class="md" valign="top">(&nbsp;</td>
199          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
200          <td class="mdname" nowrap> <em>pattern</em>, </td>
201        </tr>
202        <tr>
203          <td class="md" nowrap align="right"></td>
204          <td></td>
205          <td class="md" nowrap>bool&nbsp;</td>
206          <td class="mdname" nowrap> <em>recursive</em> = true</td>
207        </tr>
208        <tr>
209          <td></td>
210          <td class="md">)&nbsp;</td>
211          <td class="md" colspan="2"><code> [pure virtual]</code></td>
212        </tr>
213
214      </table>
215    </td>
216  </tr>
217</table>
218<table cellspacing=5 cellpadding=0 border=0>
219  <tr>
220    <td>
221      &nbsp;
222    </td>
223    <td>
224
225<p>
226Find all file names matching a given pattern in this archive.
227<p>
228<dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using findFileInfo. </dd></dl>
229<dl compact><dt><b>Parameters:</b></dt><dd>
230  <table border="0" cellspacing="2" cellpadding="0">
231    <tr><td valign=top><em>pattern</em>&nbsp;</td><td>The pattern to search for; wildcards (*) are allowed </td></tr>
232    <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>
233  </table>
234</dl>
235<dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified </dd></dl>
236
237<p>
238Implemented in <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea8">Ogre::FileSystemArchive</a>, and <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea8">Ogre::ZipArchive</a>.    </td>
239  </tr>
240</table>
241<a class="anchor" name="Ogre_1_1Archivea11" doxytag="Ogre::Archive::findFileInfo" ></a><p>
242<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
243  <tr>
244    <td class="mdRow">
245      <table cellpadding="0" cellspacing="0" border="0">
246        <tr>
247          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a> Ogre::Archive::findFileInfo </td>
248          <td class="md" valign="top">(&nbsp;</td>
249          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
250          <td class="mdname" nowrap> <em>pattern</em>, </td>
251        </tr>
252        <tr>
253          <td class="md" nowrap align="right"></td>
254          <td></td>
255          <td class="md" nowrap>bool&nbsp;</td>
256          <td class="mdname" nowrap> <em>recursive</em> = true</td>
257        </tr>
258        <tr>
259          <td></td>
260          <td class="md">)&nbsp;</td>
261          <td class="md" colspan="2"><code> [pure virtual]</code></td>
262        </tr>
263
264      </table>
265    </td>
266  </tr>
267</table>
268<table cellspacing=5 cellpadding=0 border=0>
269  <tr>
270    <td>
271      &nbsp;
272    </td>
273    <td>
274
275<p>
276Find all files matching a given pattern in this archive and get some detailed information about them.
277<p>
278<dl compact><dt><b>Parameters:</b></dt><dd>
279  <table border="0" cellspacing="2" cellpadding="0">
280    <tr><td valign=top><em>pattern</em>&nbsp;</td><td>The pattern to search for; wildcards (*) are allowed </td></tr>
281    <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>
282  </table>
283</dl>
284<dl compact><dt><b>Returns:</b></dt><dd>A list of file information structures for all files matching the criteria. </dd></dl>
285
286<p>
287Implemented in <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea9">Ogre::FileSystemArchive</a>, and <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea9">Ogre::ZipArchive</a>.    </td>
288  </tr>
289</table>
290<a class="anchor" name="Ogre_1_1ZipArchivea11" doxytag="Ogre::Archive::getName" ></a><p>
291<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
292  <tr>
293    <td class="mdRow">
294      <table cellpadding="0" cellspacing="0" border="0">
295        <tr>
296          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::Archive::getName </td>
297          <td class="md" valign="top">(&nbsp;</td>
298          <td class="md" nowrap valign="top">void&nbsp;</td>
299          <td class="mdname1" valign="top" nowrap>          </td>
300          <td class="md" valign="top">&nbsp;)&nbsp;</td>
301          <td class="md" nowrap> const</td>
302        </tr>
303
304      </table>
305    </td>
306  </tr>
307</table>
308<table cellspacing=5 cellpadding=0 border=0>
309  <tr>
310    <td>
311      &nbsp;
312    </td>
313    <td>
314
315<p>
316Get the name of this archive.
317<p>
318
319<p>
320Definition 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>.
321<p>
322References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
323  </tr>
324</table>
325<a class="anchor" name="Ogre_1_1ZipArchivea12" doxytag="Ogre::Archive::getType" ></a><p>
326<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
327  <tr>
328    <td class="mdRow">
329      <table cellpadding="0" cellspacing="0" border="0">
330        <tr>
331          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::Archive::getType </td>
332          <td class="md" valign="top">(&nbsp;</td>
333          <td class="md" nowrap valign="top">void&nbsp;</td>
334          <td class="mdname1" valign="top" nowrap>          </td>
335          <td class="md" valign="top">&nbsp;)&nbsp;</td>
336          <td class="md" nowrap> const</td>
337        </tr>
338
339      </table>
340    </td>
341  </tr>
342</table>
343<table cellspacing=5 cellpadding=0 border=0>
344  <tr>
345    <td>
346      &nbsp;
347    </td>
348    <td>
349
350<p>
351Return the type code of this <a class="el" href="classOgre_1_1Archive.html">Archive</a>.
352<p>
353
354<p>
355Definition 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>.
356<p>
357References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
358  </tr>
359</table>
360<a class="anchor" name="Ogre_1_1Archivea3" doxytag="Ogre::Archive::isCaseSensitive" ></a><p>
361<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
362  <tr>
363    <td class="mdRow">
364      <table cellpadding="0" cellspacing="0" border="0">
365        <tr>
366          <td class="md" nowrap valign="top"> virtual bool Ogre::Archive::isCaseSensitive </td>
367          <td class="md" valign="top">(&nbsp;</td>
368          <td class="md" nowrap valign="top">void&nbsp;</td>
369          <td class="mdname1" valign="top" nowrap>          </td>
370          <td class="md" valign="top">&nbsp;)&nbsp;</td>
371          <td class="md" nowrap> const<code> [pure virtual]</code></td>
372        </tr>
373
374      </table>
375    </td>
376  </tr>
377</table>
378<table cellspacing=5 cellpadding=0 border=0>
379  <tr>
380    <td>
381      &nbsp;
382    </td>
383    <td>
384
385<p>
386Returns whether this archive is case sensitive in the way it matches files.
387<p>
388
389<p>
390Implemented in <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea2">Ogre::FileSystemArchive</a>, and <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea2">Ogre::ZipArchive</a>.    </td>
391  </tr>
392</table>
393<a class="anchor" name="Ogre_1_1Archivea7" doxytag="Ogre::Archive::list" ></a><p>
394<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
395  <tr>
396    <td class="mdRow">
397      <table cellpadding="0" cellspacing="0" border="0">
398        <tr>
399          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SharedPtr.html">StringVectorPtr</a> Ogre::Archive::list </td>
400          <td class="md" valign="top">(&nbsp;</td>
401          <td class="md" nowrap valign="top">bool&nbsp;</td>
402          <td class="mdname1" valign="top" nowrap> <em>recursive</em> = true          </td>
403          <td class="md" valign="top">&nbsp;)&nbsp;</td>
404          <td class="md" nowrap><code> [pure virtual]</code></td>
405        </tr>
406
407      </table>
408    </td>
409  </tr>
410</table>
411<table cellspacing=5 cellpadding=0 border=0>
412  <tr>
413    <td>
414      &nbsp;
415    </td>
416    <td>
417
418<p>
419List all file names in the archive.
420<p>
421<dl compact><dt><b>Note:</b></dt><dd>This method only returns filenames, you can also retrieve other information using listFileInfo. </dd></dl>
422<dl compact><dt><b>Parameters:</b></dt><dd>
423  <table border="0" cellspacing="2" cellpadding="0">
424    <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>
425  </table>
426</dl>
427<dl compact><dt><b>Returns:</b></dt><dd>A list of filenames matching the criteria, all are fully qualified </dd></dl>
428
429<p>
430Implemented in <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea6">Ogre::FileSystemArchive</a>, and <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea6">Ogre::ZipArchive</a>.    </td>
431  </tr>
432</table>
433<a class="anchor" name="Ogre_1_1Archivea8" doxytag="Ogre::Archive::listFileInfo" ></a><p>
434<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
435  <tr>
436    <td class="mdRow">
437      <table cellpadding="0" cellspacing="0" border="0">
438        <tr>
439          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SharedPtr.html">FileInfoListPtr</a> Ogre::Archive::listFileInfo </td>
440          <td class="md" valign="top">(&nbsp;</td>
441          <td class="md" nowrap valign="top">bool&nbsp;</td>
442          <td class="mdname1" valign="top" nowrap> <em>recursive</em> = true          </td>
443          <td class="md" valign="top">&nbsp;)&nbsp;</td>
444          <td class="md" nowrap><code> [pure virtual]</code></td>
445        </tr>
446
447      </table>
448    </td>
449  </tr>
450</table>
451<table cellspacing=5 cellpadding=0 border=0>
452  <tr>
453    <td>
454      &nbsp;
455    </td>
456    <td>
457
458<p>
459List all files in the archive with accompanying information.
460<p>
461<dl compact><dt><b>Parameters:</b></dt><dd>
462  <table border="0" cellspacing="2" cellpadding="0">
463    <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>
464  </table>
465</dl>
466<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>
467
468<p>
469Implemented in <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea7">Ogre::FileSystemArchive</a>, and <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea7">Ogre::ZipArchive</a>.    </td>
470  </tr>
471</table>
472<a class="anchor" name="Ogre_1_1Archivea4" doxytag="Ogre::Archive::load" ></a><p>
473<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
474  <tr>
475    <td class="mdRow">
476      <table cellpadding="0" cellspacing="0" border="0">
477        <tr>
478          <td class="md" nowrap valign="top"> virtual void Ogre::Archive::load </td>
479          <td class="md" valign="top">(&nbsp;</td>
480          <td class="mdname1" valign="top" nowrap>          </td>
481          <td class="md" valign="top">&nbsp;)&nbsp;</td>
482          <td class="md" nowrap><code> [pure virtual]</code></td>
483        </tr>
484
485      </table>
486    </td>
487  </tr>
488</table>
489<table cellspacing=5 cellpadding=0 border=0>
490  <tr>
491    <td>
492      &nbsp;
493    </td>
494    <td>
495
496<p>
497Loads the archive.
498<p>
499<dl compact><dt><b>Remarks:</b></dt><dd>This initializes all the internal data of the class. </dd></dl>
500<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>
501
502<p>
503Implemented in <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea3">Ogre::FileSystemArchive</a>, and <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea3">Ogre::ZipArchive</a>.    </td>
504  </tr>
505</table>
506<a class="anchor" name="Ogre_1_1Archivea6" doxytag="Ogre::Archive::open" ></a><p>
507<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
508  <tr>
509    <td class="mdRow">
510      <table cellpadding="0" cellspacing="0" border="0">
511        <tr>
512          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> Ogre::Archive::open </td>
513          <td class="md" valign="top">(&nbsp;</td>
514          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
515          <td class="mdname1" valign="top" nowrap> <em>filename</em>          </td>
516          <td class="md" valign="top">&nbsp;)&nbsp;</td>
517          <td class="md" nowrap> const<code> [pure virtual]</code></td>
518        </tr>
519
520      </table>
521    </td>
522  </tr>
523</table>
524<table cellspacing=5 cellpadding=0 border=0>
525  <tr>
526    <td>
527      &nbsp;
528    </td>
529    <td>
530
531<p>
532Open a stream on a given file.
533<p>
534<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>
535<dl compact><dt><b>Parameters:</b></dt><dd>
536  <table border="0" cellspacing="2" cellpadding="0">
537    <tr><td valign=top><em>filename</em>&nbsp;</td><td>The fully qualified name of the file </td></tr>
538  </table>
539</dl>
540<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>
541
542<p>
543Implemented in <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea5">Ogre::FileSystemArchive</a>, and <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea5">Ogre::ZipArchive</a>.    </td>
544  </tr>
545</table>
546<a class="anchor" name="Ogre_1_1Archivea5" doxytag="Ogre::Archive::unload" ></a><p>
547<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
548  <tr>
549    <td class="mdRow">
550      <table cellpadding="0" cellspacing="0" border="0">
551        <tr>
552          <td class="md" nowrap valign="top"> virtual void Ogre::Archive::unload </td>
553          <td class="md" valign="top">(&nbsp;</td>
554          <td class="mdname1" valign="top" nowrap>          </td>
555          <td class="md" valign="top">&nbsp;)&nbsp;</td>
556          <td class="md" nowrap><code> [pure virtual]</code></td>
557        </tr>
558
559      </table>
560    </td>
561  </tr>
562</table>
563<table cellspacing=5 cellpadding=0 border=0>
564  <tr>
565    <td>
566      &nbsp;
567    </td>
568    <td>
569
570<p>
571Unloads the archive.
572<p>
573<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>
574
575<p>
576Implemented in <a class="el" href="classOgre_1_1FileSystemArchive.html#Ogre_1_1FileSystemArchivea4">Ogre::FileSystemArchive</a>, and <a class="el" href="classOgre_1_1ZipArchive.html#Ogre_1_1ZipArchivea4">Ogre::ZipArchive</a>.    </td>
577  </tr>
578</table>
579<hr><h2>Member Data Documentation</h2>
580<a class="anchor" name="Ogre_1_1ZipArchivep2" doxytag="Ogre::Archive::mName" ></a><p>
581<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
582  <tr>
583    <td class="mdRow">
584      <table cellpadding="0" cellspacing="0" border="0">
585        <tr>
586          <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]</code>
587      </table>
588    </td>
589  </tr>
590</table>
591<table cellspacing=5 cellpadding=0 border=0>
592  <tr>
593    <td>
594      &nbsp;
595    </td>
596    <td>
597
598<p>
599<a class="el" href="classOgre_1_1Archive.html">Archive</a> name.
600<p>
601
602<p>
603Definition 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>
604  </tr>
605</table>
606<a class="anchor" name="Ogre_1_1ZipArchivep3" doxytag="Ogre::Archive::mType" ></a><p>
607<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
608  <tr>
609    <td class="mdRow">
610      <table cellpadding="0" cellspacing="0" border="0">
611        <tr>
612          <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]</code>
613      </table>
614    </td>
615  </tr>
616</table>
617<table cellspacing=5 cellpadding=0 border=0>
618  <tr>
619    <td>
620      &nbsp;
621    </td>
622    <td>
623
624<p>
625<a class="el" href="classOgre_1_1Archive.html">Archive</a> type code.
626<p>
627
628<p>
629Definition 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>
630  </tr>
631</table>
632<hr>The documentation for this class was generated from the following file:<ul>
633<li><a class="el" href="OgreArchive_8h-source.html">OgreArchive.h</a></ul>
634<hr>
635<p>
636Copyright &copy; 2000-2005 by The OGRE Team<br />
637<!--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/>
638This 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/>
639                <!--/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#">
640                <Work rdf:about="">
641                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
642        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
643                </Work>
644                <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> -->
645
646Last modified Sun Feb 12 13:00:06 2006
647</p>
648</body>
649</html>
Note: See TracBrowser for help on using the repository browser.