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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ZipArchiveFactory 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::ZipArchiveFactory Class Reference</h1>Specialisation of <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> for Zip files. 
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::ZipArchiveFactory:
16<p><center><img src="classOgre_1_1ZipArchiveFactory.png" usemap="#Ogre::ZipArchiveFactory_map" border="0" alt=""></center>
17<map name="Ogre::ZipArchiveFactory_map">
18<area href="classOgre_1_1ArchiveFactory.html" alt="Ogre::ArchiveFactory" shape="rect" coords="0,56,180,80">
19<area href="classOgre_1_1FactoryObj.html" alt="Ogre::FactoryObj< Archive >" shape="rect" coords="0,0,180,24">
20</map>
21<a href="classOgre_1_1ZipArchiveFactory-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>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchiveFactory.html#Ogre_1_1ZipArchiveFactorya0">~ZipArchiveFactory</a> ()</td></tr>
25
26<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_1ZipArchiveFactory.html#Ogre_1_1ZipArchiveFactorya1">getType</a> (void) const </td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Returns:</b></dt><dd>The factory type.</dd></dl>
29  <a href="#Ogre_1_1ZipArchiveFactorya1"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Archive.html">Archive</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchiveFactory.html#Ogre_1_1ZipArchiveFactorya2">createInstance</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name)</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd>
33  <table border="0" cellspacing="2" cellpadding="0">
34    <tr><td valign=top><em>name</em>&nbsp;</td><td>Name of the object to create </td></tr>
35  </table>
36</dl>
37<dl compact><dt><b>Returns:</b></dt><dd>An object created by the factory. The type of the object depends on the factory.</dd></dl>
38  <a href="#Ogre_1_1ZipArchiveFactorya2"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ZipArchiveFactory.html#Ogre_1_1ZipArchiveFactorya3">destroyInstance</a> (<a class="el" href="classOgre_1_1Archive.html">Archive</a> *arch)</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd>
42  <table border="0" cellspacing="2" cellpadding="0">
43    <tr><td valign=top><em>ptr</em>&nbsp;</td><td>Pointer to the object to destroy</td></tr>
44  </table>
45</dl>
46  <a href="#Ogre_1_1ZipArchiveFactorya3"></a><br><br></td></tr>
47</table>
48<hr><a name="_details"></a><h2>Detailed Description</h2>
49Specialisation of <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> for Zip files.
50<p>
51
52<p>
53Definition at line <a class="el" href="OgreZip_8h-source.html#l00085">85</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
54<a class="anchor" name="Ogre_1_1ZipArchiveFactorya0" doxytag="Ogre::ZipArchiveFactory::~ZipArchiveFactory" ></a><p>
55<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
56  <tr>
57    <td class="mdRow">
58      <table cellpadding="0" cellspacing="0" border="0">
59        <tr>
60          <td class="md" nowrap valign="top"> virtual Ogre::ZipArchiveFactory::~<a class="el" href="classOgre_1_1ZipArchiveFactory.html">ZipArchiveFactory</a> </td>
61          <td class="md" valign="top">(&nbsp;</td>
62          <td class="mdname1" valign="top" nowrap>          </td>
63          <td class="md" valign="top">&nbsp;)&nbsp;</td>
64          <td class="md" nowrap><code> [virtual]</code></td>
65        </tr>
66
67      </table>
68    </td>
69  </tr>
70</table>
71<table cellspacing=5 cellpadding=0 border=0>
72  <tr>
73    <td>
74      &nbsp;
75    </td>
76    <td>
77
78<p>
79
80<p>
81Definition at line <a class="el" href="OgreZip_8h-source.html#l00088">88</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.    </td>
82  </tr>
83</table>
84<hr><h2>Member Function Documentation</h2>
85<a class="anchor" name="Ogre_1_1ZipArchiveFactorya2" doxytag="Ogre::ZipArchiveFactory::createInstance" ></a><p>
86<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
87  <tr>
88    <td class="mdRow">
89      <table cellpadding="0" cellspacing="0" border="0">
90        <tr>
91          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Archive.html">Archive</a>* Ogre::ZipArchiveFactory::createInstance </td>
92          <td class="md" valign="top">(&nbsp;</td>
93          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
94          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
95          <td class="md" valign="top">&nbsp;)&nbsp;</td>
96          <td class="md" nowrap><code> [virtual]</code></td>
97        </tr>
98
99      </table>
100    </td>
101  </tr>
102</table>
103<table cellspacing=5 cellpadding=0 border=0>
104  <tr>
105    <td>
106      &nbsp;
107    </td>
108    <td>
109
110<p>
111<dl compact><dt><b>Parameters:</b></dt><dd>
112  <table border="0" cellspacing="2" cellpadding="0">
113    <tr><td valign=top><em>name</em>&nbsp;</td><td>Name of the object to create </td></tr>
114  </table>
115</dl>
116<dl compact><dt><b>Returns:</b></dt><dd>An object created by the factory. The type of the object depends on the factory.</dd></dl>
117 
118<p>
119
120<p>
121Implements <a class="el" href="classOgre_1_1FactoryObj.html#Ogre_1_1FactoryObja2">Ogre::FactoryObj&lt; Archive &gt;</a>.
122<p>
123Definition at line <a class="el" href="OgreZip_8h-source.html#l00092">92</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.
124<p>
125References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
126  </tr>
127</table>
128<a class="anchor" name="Ogre_1_1ZipArchiveFactorya3" doxytag="Ogre::ZipArchiveFactory::destroyInstance" ></a><p>
129<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
130  <tr>
131    <td class="mdRow">
132      <table cellpadding="0" cellspacing="0" border="0">
133        <tr>
134          <td class="md" nowrap valign="top"> void Ogre::ZipArchiveFactory::destroyInstance </td>
135          <td class="md" valign="top">(&nbsp;</td>
136          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Archive.html">Archive</a> *&nbsp;</td>
137          <td class="mdname1" valign="top" nowrap> <em>arch</em>          </td>
138          <td class="md" valign="top">&nbsp;)&nbsp;</td>
139          <td class="md" nowrap><code> [virtual]</code></td>
140        </tr>
141
142      </table>
143    </td>
144  </tr>
145</table>
146<table cellspacing=5 cellpadding=0 border=0>
147  <tr>
148    <td>
149      &nbsp;
150    </td>
151    <td>
152
153<p>
154<dl compact><dt><b>Parameters:</b></dt><dd>
155  <table border="0" cellspacing="2" cellpadding="0">
156    <tr><td valign=top><em>ptr</em>&nbsp;</td><td>Pointer to the object to destroy</td></tr>
157  </table>
158</dl>
159 
160<p>
161
162<p>
163Implements <a class="el" href="classOgre_1_1FactoryObj.html#Ogre_1_1FactoryObja3">Ogre::FactoryObj&lt; Archive &gt;</a>.
164<p>
165Definition at line <a class="el" href="OgreZip_8h-source.html#l00097">97</a> of file <a class="el" href="OgreZip_8h-source.html">OgreZip.h</a>.    </td>
166  </tr>
167</table>
168<a class="anchor" name="Ogre_1_1ZipArchiveFactorya1" doxytag="Ogre::ZipArchiveFactory::getType" ></a><p>
169<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
170  <tr>
171    <td class="mdRow">
172      <table cellpadding="0" cellspacing="0" border="0">
173        <tr>
174          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::ZipArchiveFactory::getType </td>
175          <td class="md" valign="top">(&nbsp;</td>
176          <td class="md" nowrap valign="top">void&nbsp;</td>
177          <td class="mdname1" valign="top" nowrap>          </td>
178          <td class="md" valign="top">&nbsp;)&nbsp;</td>
179          <td class="md" nowrap> const<code> [virtual]</code></td>
180        </tr>
181
182      </table>
183    </td>
184  </tr>
185</table>
186<table cellspacing=5 cellpadding=0 border=0>
187  <tr>
188    <td>
189      &nbsp;
190    </td>
191    <td>
192
193<p>
194<dl compact><dt><b>Returns:</b></dt><dd>The factory type.</dd></dl>
195 
196<p>
197
198<p>
199Implements <a class="el" href="classOgre_1_1FactoryObj.html#Ogre_1_1FactoryObja1">Ogre::FactoryObj&lt; Archive &gt;</a>.    </td>
200  </tr>
201</table>
202<hr>The documentation for this class was generated from the following file:<ul>
203<li><a class="el" href="OgreZip_8h-source.html">OgreZip.h</a></ul>
204<hr>
205<p>
206Copyright &copy; 2000-2005 by The OGRE Team<br />
207<!--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/>
208This 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/>
209                <!--/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#">
210                <Work rdf:about="">
211                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
212        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
213                </Work>
214                <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> -->
215
216Last modified Sun Feb 12 13:05:05 2006
217</p>
218</body>
219</html>
Note: See TracBrowser for help on using the repository browser.