aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_archive.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_archive.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_archive.html278
1 files changed, 278 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_archive.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_archive.html
new file mode 100644
index 0000000..34ef811
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_archive.html
@@ -0,0 +1,278 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>Irrlicht 3D Engine: irr::io::IFileArchive Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1io_1_1_i_file_archive.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> &#124;
89<a href="#pub-attribs">Public Attributes</a> </div>
90 <div class="headertitle">
91<div class="title">irr::io::IFileArchive Class Reference</div> </div>
92</div>
93<div class="contents">
94<!-- doxytag: class="irr::io::IFileArchive" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
95<p>The FileArchive manages archives and provides access to files inside them.
96 <a href="classirr_1_1io_1_1_i_file_archive.html#details">More...</a></p>
97
98<p><code>#include &lt;<a class="el" href="_i_file_archive_8h_source.html">IFileArchive.h</a>&gt;</code></p>
99<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
100 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::io::IFileArchive:</div>
101<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
102</div>
103<div id="dynsection-0-content" class="dyncontent" style="display:none;">
104 <div class="center">
105 <img src="classirr_1_1io_1_1_i_file_archive.png" usemap="#irr::io::IFileArchive_map" alt=""/>
106 <map id="irr::io::IFileArchive_map" name="irr::io::IFileArchive_map">
107<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,140,24"/>
108</map>
109 </div></div>
110
111<p><a href="classirr_1_1io_1_1_i_file_archive-members.html">List of all members.</a></p>
112<h2><a name="pub-methods"></a>
113Public Member Functions</h2>
114<ul>
115<li>virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * <a class="el" href="classirr_1_1io_1_1_i_file_archive.html#a5c3b4994ae63447d2634dd86b3069988">createAndOpenFile</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &amp;filename)=0
116<dl class="el"><dd class="mdescRight">Opens a file based on its name. <a href="#a5c3b4994ae63447d2634dd86b3069988"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a> * <a class="el" href="classirr_1_1io_1_1_i_file_archive.html#ab6bc8fbd660bbbe42b4d30a9d4f26c7d">createAndOpenFile</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index)=0
117<dl class="el"><dd class="mdescRight">Opens a file based on its position in the file list. <a href="#ab6bc8fbd660bbbe42b4d30a9d4f26c7d"></a><br/></dl><li>virtual const <a class="el" href="classirr_1_1io_1_1_i_file_list.html">IFileList</a> * <a class="el" href="classirr_1_1io_1_1_i_file_archive.html#a73c683318837b13d16843373da00ded3">getFileList</a> () const =0
118<dl class="el"><dd class="mdescRight">Returns the complete file tree. <a href="#a73c683318837b13d16843373da00ded3"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#adb3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a> <a class="el" href="classirr_1_1io_1_1_i_file_archive.html#acffb15450606924696fb8f9608819536">getType</a> () const
119<dl class="el"><dd class="mdescRight">get the archive type <a href="#acffb15450606924696fb8f9608819536"></a><br/></dl></ul>
120<h2><a name="pub-attribs"></a>
121Public Attributes</h2>
122<ul>
123<li><a class="el" href="namespaceirr_1_1core.html#ade1071a878633f2f6d8a75c5d11fec19">core::stringc</a> <a class="el" href="classirr_1_1io_1_1_i_file_archive.html#ae5b574864226b09c70518e163e59b6ba">Password</a>
124<dl class="el"><dd class="mdescRight">An optionally used password string. <a href="#ae5b574864226b09c70518e163e59b6ba"></a><br/></dl></ul>
125<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
126<div class="textblock"><p>The FileArchive manages archives and provides access to files inside them. </p>
127
128<p>Definition at line <a class="el" href="_i_file_archive_8h_source.html#l00053">53</a> of file <a class="el" href="_i_file_archive_8h_source.html">IFileArchive.h</a>.</p>
129</div><hr/><h2>Member Function Documentation</h2>
130<a class="anchor" id="a5c3b4994ae63447d2634dd86b3069988"></a><!-- doxytag: member="irr::io::IFileArchive::createAndOpenFile" ref="a5c3b4994ae63447d2634dd86b3069988" args="(const path &amp;filename)=0" -->
131<div class="memitem">
132<div class="memproto">
133 <table class="memname">
134 <tr>
135 <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a>* irr::io::IFileArchive::createAndOpenFile </td>
136 <td>(</td>
137 <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &amp;&#160;</td>
138 <td class="paramname"><em>filename</em></td><td>)</td>
139 <td><code> [pure virtual]</code></td>
140 </tr>
141 </table>
142</div>
143<div class="memdoc">
144
145<p>Opens a file based on its name. </p>
146<p>Creates and returns a new <a class="el" href="classirr_1_1io_1_1_i_read_file.html" title="Interface providing read acess to a file.">IReadFile</a> for a file in the archive. </p>
147<dl><dt><b>Parameters:</b></dt><dd>
148 <table class="params">
149 <tr><td class="paramname">filename</td><td>The file to open </td></tr>
150 </table>
151 </dd>
152</dl>
153<dl class="return"><dt><b>Returns:</b></dt><dd>Returns A pointer to the created file on success, or 0 on failure. </dd></dl>
154
155</div>
156</div>
157<a class="anchor" id="ab6bc8fbd660bbbe42b4d30a9d4f26c7d"></a><!-- doxytag: member="irr::io::IFileArchive::createAndOpenFile" ref="ab6bc8fbd660bbbe42b4d30a9d4f26c7d" args="(u32 index)=0" -->
158<div class="memitem">
159<div class="memproto">
160 <table class="memname">
161 <tr>
162 <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_read_file.html">IReadFile</a>* irr::io::IFileArchive::createAndOpenFile </td>
163 <td>(</td>
164 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
165 <td class="paramname"><em>index</em></td><td>)</td>
166 <td><code> [pure virtual]</code></td>
167 </tr>
168 </table>
169</div>
170<div class="memdoc">
171
172<p>Opens a file based on its position in the file list. </p>
173<p>Creates and returns </p>
174<dl><dt><b>Parameters:</b></dt><dd>
175 <table class="params">
176 <tr><td class="paramname">index</td><td>The zero based index of the file. </td></tr>
177 </table>
178 </dd>
179</dl>
180<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a pointer to the created file on success, or 0 on failure. </dd></dl>
181
182</div>
183</div>
184<a class="anchor" id="a73c683318837b13d16843373da00ded3"></a><!-- doxytag: member="irr::io::IFileArchive::getFileList" ref="a73c683318837b13d16843373da00ded3" args="() const =0" -->
185<div class="memitem">
186<div class="memproto">
187 <table class="memname">
188 <tr>
189 <td class="memname">virtual const <a class="el" href="classirr_1_1io_1_1_i_file_list.html">IFileList</a>* irr::io::IFileArchive::getFileList </td>
190 <td>(</td>
191 <td class="paramname"></td><td>)</td>
192 <td> const<code> [pure virtual]</code></td>
193 </tr>
194 </table>
195</div>
196<div class="memdoc">
197
198<p>Returns the complete file tree. </p>
199<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the complete directory tree for the archive, including all files and folders </dd></dl>
200
201</div>
202</div>
203<a class="anchor" id="acffb15450606924696fb8f9608819536"></a><!-- doxytag: member="irr::io::IFileArchive::getType" ref="acffb15450606924696fb8f9608819536" args="() const " -->
204<div class="memitem">
205<div class="memproto">
206 <table class="memname">
207 <tr>
208 <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#adb3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a> irr::io::IFileArchive::getType </td>
209 <td>(</td>
210 <td class="paramname"></td><td>)</td>
211 <td> const<code> [inline, virtual]</code></td>
212 </tr>
213 </table>
214</div>
215<div class="memdoc">
216
217<p>get the archive type </p>
218
219<p>Definition at line <a class="el" href="_i_file_archive_8h_source.html#l00076">76</a> of file <a class="el" href="_i_file_archive_8h_source.html">IFileArchive.h</a>.</p>
220
221<p>References <a class="el" href="_i_file_archive_8h_source.html#l00049">irr::io::EFAT_UNKNOWN</a>.</p>
222
223</div>
224</div>
225<hr/><h2>Member Data Documentation</h2>
226<a class="anchor" id="ae5b574864226b09c70518e163e59b6ba"></a><!-- doxytag: member="irr::io::IFileArchive::Password" ref="ae5b574864226b09c70518e163e59b6ba" args="" -->
227<div class="memitem">
228<div class="memproto">
229 <table class="memname">
230 <tr>
231 <td class="memname"><a class="el" href="namespaceirr_1_1core.html#ade1071a878633f2f6d8a75c5d11fec19">core::stringc</a> <a class="el" href="classirr_1_1io_1_1_i_file_archive.html#ae5b574864226b09c70518e163e59b6ba">irr::io::IFileArchive::Password</a></td>
232 </tr>
233 </table>
234</div>
235<div class="memdoc">
236
237<p>An optionally used password string. </p>
238<p>This variable is publicly accessible from the interface in order to avoid single access patterns to this place, and hence allow some more obscurity. </p>
239
240<p>Definition at line <a class="el" href="_i_file_archive_8h_source.html#l00083">83</a> of file <a class="el" href="_i_file_archive_8h_source.html">IFileArchive.h</a>.</p>
241
242</div>
243</div>
244<hr/>The documentation for this class was generated from the following file:<ul>
245<li><a class="el" href="_i_file_archive_8h_source.html">IFileArchive.h</a></li>
246</ul>
247</div>
248</div>
249 <div id="nav-path" class="navpath">
250 <ul>
251 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
252 <li class="navelem"><a class="el" href="namespaceirr_1_1io.html">io</a> </li>
253 <li class="navelem"><a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> </li>
254<!-- window showing the filter options -->
255<div id="MSearchSelectWindow"
256 onmouseover="return searchBox.OnSearchSelectShow()"
257 onmouseout="return searchBox.OnSearchSelectHide()"
258 onkeydown="return searchBox.OnSearchSelectKey(event)">
259<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
260
261<!-- iframe showing the search results (closed by default) -->
262<div id="MSearchResultsWindow">
263<iframe src="javascript:void(0)" frameborder="0"
264 name="MSearchResults" id="MSearchResults">
265</iframe>
266</div>
267
268
269 <li class="footer">
270<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
271Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:45 for Irrlicht 3D Engine by
272<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
273 </ul>
274 </div>
275
276
277</body>
278</html>
generated by cgit v1.1 at 2024-06-27 09:45:01 +0000