aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html474
1 files changed, 474 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html
new file mode 100644
index 0000000..377a89c
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_file_list.html
@@ -0,0 +1,474 @@
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::IFileList 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_list.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> </div>
89 <div class="headertitle">
90<div class="title">irr::io::IFileList Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::io::IFileList" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p>Provides a list of files and folders.
95 <a href="classirr_1_1io_1_1_i_file_list.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_file_list_8h_source.html">IFileList.h</a>&gt;</code></p>
98<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
99 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::io::IFileList:</div>
100<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
101</div>
102<div id="dynsection-0-content" class="dyncontent" style="display:none;">
103 <div class="center">
104 <img src="classirr_1_1io_1_1_i_file_list.png" usemap="#irr::io::IFileList_map" alt=""/>
105 <map id="irr::io::IFileList_map" name="irr::io::IFileList_map">
106<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"/>
107</map>
108 </div></div>
109
110<p><a href="classirr_1_1io_1_1_i_file_list-members.html">List of all members.</a></p>
111<h2><a name="pub-methods"></a>
112Public Member Functions</h2>
113<ul>
114<li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1io_1_1_i_file_list.html#ad0d90f1bb8a35910f4f877268e2f043e">addItem</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &amp;fullPath, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> offset, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> size, bool isDirectory, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> id=0)=0
115<dl class="el"><dd class="mdescRight">Add as a file or folder to the list. <a href="#ad0d90f1bb8a35910f4f877268e2f043e"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a2b0fce45cbea72f5c6dc13eb85183054">findFile</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &amp;filename, bool isFolder=false) const =0
116<dl class="el"><dd class="mdescRight">Searches for a file or folder in the list. <a href="#a2b0fce45cbea72f5c6dc13eb85183054"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a871861be76e18d58274c4580b1d103b9">getFileCount</a> () const =0
117<dl class="el"><dd class="mdescRight">Get the number of files in the filelist. <a href="#a871861be76e18d58274c4580b1d103b9"></a><br/></dl><li>virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &amp; <a class="el" href="classirr_1_1io_1_1_i_file_list.html#ab4e0330adf34afa3c21e06ff0b4e84d5">getFileName</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index) const =0
118<dl class="el"><dd class="mdescRight">Gets the name of a file in the list, based on an index. <a href="#ab4e0330adf34afa3c21e06ff0b4e84d5"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a97582a2cf5c05e7b8dcb702384ab76bd">getFileOffset</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index) const =0
119<dl class="el"><dd class="mdescRight">Returns the file offset of a file in the file list, based on an index. <a href="#a97582a2cf5c05e7b8dcb702384ab76bd"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a305561d0c5db74ac721da5d26c461b36">getFileSize</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index) const =0
120<dl class="el"><dd class="mdescRight">Returns the size of a file in the file list, based on an index. <a href="#a305561d0c5db74ac721da5d26c461b36"></a><br/></dl><li>virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &amp; <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a063c823f58019bda79efabefabe365da">getFullFileName</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index) const =0
121<dl class="el"><dd class="mdescRight">Gets the full name of a file in the list including the path, based on an index. <a href="#a063c823f58019bda79efabefabe365da"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a9f633344aa2bb36f619d1ca8472b46b6">getID</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index) const =0
122<dl class="el"><dd class="mdescRight">Returns the ID of a file in the file list, based on an index. <a href="#a9f633344aa2bb36f619d1ca8472b46b6"></a><br/></dl><li>virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &amp; <a class="el" href="classirr_1_1io_1_1_i_file_list.html#ac3473e66ba9c3cee2e06c1fb46493e88">getPath</a> () const =0
123<dl class="el"><dd class="mdescRight">Returns the base path of the file list. <a href="#ac3473e66ba9c3cee2e06c1fb46493e88"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a0f2cb8c99e9ecc4b56d08718c885a5af">isDirectory</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> index) const =0
124<dl class="el"><dd class="mdescRight">Check if the file is a directory. <a href="#a0f2cb8c99e9ecc4b56d08718c885a5af"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a2cf4f12d7ee6ab35257169ec23654da8">sort</a> ()=0
125<dl class="el"><dd class="mdescRight">Sorts the file list. You should call this after adding any items to the file list. <a href="#a2cf4f12d7ee6ab35257169ec23654da8"></a><br/></dl></ul>
126<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
127<div class="textblock"><p>Provides a list of files and folders. </p>
128<p>File lists usually contain a list of all files in a given folder, but can also contain a complete directory structure. </p>
129
130<p>Definition at line <a class="el" href="_i_file_list_8h_source.html#l00019">19</a> of file <a class="el" href="_i_file_list_8h_source.html">IFileList.h</a>.</p>
131</div><hr/><h2>Member Function Documentation</h2>
132<a class="anchor" id="ad0d90f1bb8a35910f4f877268e2f043e"></a><!-- doxytag: member="irr::io::IFileList::addItem" ref="ad0d90f1bb8a35910f4f877268e2f043e" args="(const io::path &amp;fullPath, u32 offset, u32 size, bool isDirectory, u32 id=0)=0" -->
133<div class="memitem">
134<div class="memproto">
135 <table class="memname">
136 <tr>
137 <td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::io::IFileList::addItem </td>
138 <td>(</td>
139 <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &amp;&#160;</td>
140 <td class="paramname"><em>fullPath</em>, </td>
141 </tr>
142 <tr>
143 <td class="paramkey"></td>
144 <td></td>
145 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
146 <td class="paramname"><em>offset</em>, </td>
147 </tr>
148 <tr>
149 <td class="paramkey"></td>
150 <td></td>
151 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
152 <td class="paramname"><em>size</em>, </td>
153 </tr>
154 <tr>
155 <td class="paramkey"></td>
156 <td></td>
157 <td class="paramtype">bool&#160;</td>
158 <td class="paramname"><em>isDirectory</em>, </td>
159 </tr>
160 <tr>
161 <td class="paramkey"></td>
162 <td></td>
163 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
164 <td class="paramname"><em>id</em> = <code>0</code>&#160;</td>
165 </tr>
166 <tr>
167 <td></td>
168 <td>)</td>
169 <td></td><td><code> [pure virtual]</code></td>
170 </tr>
171 </table>
172</div>
173<div class="memdoc">
174
175<p>Add as a file or folder to the list. </p>
176<dl><dt><b>Parameters:</b></dt><dd>
177 <table class="params">
178 <tr><td class="paramname">fullPath</td><td>The file name including path, from the root of the file list. </td></tr>
179 <tr><td class="paramname">isDirectory</td><td>True if this is a directory rather than a file. </td></tr>
180 <tr><td class="paramname">offset</td><td>The file offset inside an archive </td></tr>
181 <tr><td class="paramname">size</td><td>The size of the file in bytes. </td></tr>
182 <tr><td class="paramname">id</td><td>The ID of the file in the archive which owns it </td></tr>
183 </table>
184 </dd>
185</dl>
186
187</div>
188</div>
189<a class="anchor" id="a2b0fce45cbea72f5c6dc13eb85183054"></a><!-- doxytag: member="irr::io::IFileList::findFile" ref="a2b0fce45cbea72f5c6dc13eb85183054" args="(const io::path &amp;filename, bool isFolder=false) const =0" -->
190<div class="memitem">
191<div class="memproto">
192 <table class="memname">
193 <tr>
194 <td class="memname">virtual <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> irr::io::IFileList::findFile </td>
195 <td>(</td>
196 <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &amp;&#160;</td>
197 <td class="paramname"><em>filename</em>, </td>
198 </tr>
199 <tr>
200 <td class="paramkey"></td>
201 <td></td>
202 <td class="paramtype">bool&#160;</td>
203 <td class="paramname"><em>isFolder</em> = <code>false</code>&#160;</td>
204 </tr>
205 <tr>
206 <td></td>
207 <td>)</td>
208 <td></td><td> const<code> [pure virtual]</code></td>
209 </tr>
210 </table>
211</div>
212<div class="memdoc">
213
214<p>Searches for a file or folder in the list. </p>
215<p>Searches for a file by name </p>
216<dl><dt><b>Parameters:</b></dt><dd>
217 <table class="params">
218 <tr><td class="paramname">filename</td><td>The name of the file to search for. </td></tr>
219 <tr><td class="paramname">isFolder</td><td>True if you are searching for a directory path, false if you are searching for a file </td></tr>
220 </table>
221 </dd>
222</dl>
223<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the index of the file in the file list, or -1 if no matching name name was found. </dd></dl>
224
225</div>
226</div>
227<a class="anchor" id="a871861be76e18d58274c4580b1d103b9"></a><!-- doxytag: member="irr::io::IFileList::getFileCount" ref="a871861be76e18d58274c4580b1d103b9" args="() const =0" -->
228<div class="memitem">
229<div class="memproto">
230 <table class="memname">
231 <tr>
232 <td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::io::IFileList::getFileCount </td>
233 <td>(</td>
234 <td class="paramname"></td><td>)</td>
235 <td> const<code> [pure virtual]</code></td>
236 </tr>
237 </table>
238</div>
239<div class="memdoc">
240
241<p>Get the number of files in the filelist. </p>
242<dl class="return"><dt><b>Returns:</b></dt><dd>Amount of files and directories in the file list. </dd></dl>
243
244</div>
245</div>
246<a class="anchor" id="ab4e0330adf34afa3c21e06ff0b4e84d5"></a><!-- doxytag: member="irr::io::IFileList::getFileName" ref="ab4e0330adf34afa3c21e06ff0b4e84d5" args="(u32 index) const =0" -->
247<div class="memitem">
248<div class="memproto">
249 <table class="memname">
250 <tr>
251 <td class="memname">virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a>&amp; irr::io::IFileList::getFileName </td>
252 <td>(</td>
253 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
254 <td class="paramname"><em>index</em></td><td>)</td>
255 <td> const<code> [pure virtual]</code></td>
256 </tr>
257 </table>
258</div>
259<div class="memdoc">
260
261<p>Gets the name of a file in the list, based on an index. </p>
262<p>The path is not included in this name. Use getFullFileName for this. </p>
263<dl><dt><b>Parameters:</b></dt><dd>
264 <table class="params">
265 <tr><td class="paramname">index</td><td>is the zero based index of the file which name should be returned. The index must be less than the amount <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a871861be76e18d58274c4580b1d103b9" title="Get the number of files in the filelist.">getFileCount()</a> returns. </td></tr>
266 </table>
267 </dd>
268</dl>
269<dl class="return"><dt><b>Returns:</b></dt><dd>File name of the file. Returns 0, if an error occured. </dd></dl>
270
271</div>
272</div>
273<a class="anchor" id="a97582a2cf5c05e7b8dcb702384ab76bd"></a><!-- doxytag: member="irr::io::IFileList::getFileOffset" ref="a97582a2cf5c05e7b8dcb702384ab76bd" args="(u32 index) const =0" -->
274<div class="memitem">
275<div class="memproto">
276 <table class="memname">
277 <tr>
278 <td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::io::IFileList::getFileOffset </td>
279 <td>(</td>
280 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
281 <td class="paramname"><em>index</em></td><td>)</td>
282 <td> const<code> [pure virtual]</code></td>
283 </tr>
284 </table>
285</div>
286<div class="memdoc">
287
288<p>Returns the file offset of a file in the file list, based on an index. </p>
289<dl><dt><b>Parameters:</b></dt><dd>
290 <table class="params">
291 <tr><td class="paramname">index</td><td>is the zero based index of the file which should be returned. The index must be less than the amount <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a871861be76e18d58274c4580b1d103b9" title="Get the number of files in the filelist.">getFileCount()</a> returns. </td></tr>
292 </table>
293 </dd>
294</dl>
295<dl class="return"><dt><b>Returns:</b></dt><dd>The offset of the file in bytes. </dd></dl>
296
297</div>
298</div>
299<a class="anchor" id="a305561d0c5db74ac721da5d26c461b36"></a><!-- doxytag: member="irr::io::IFileList::getFileSize" ref="a305561d0c5db74ac721da5d26c461b36" args="(u32 index) const =0" -->
300<div class="memitem">
301<div class="memproto">
302 <table class="memname">
303 <tr>
304 <td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::io::IFileList::getFileSize </td>
305 <td>(</td>
306 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
307 <td class="paramname"><em>index</em></td><td>)</td>
308 <td> const<code> [pure virtual]</code></td>
309 </tr>
310 </table>
311</div>
312<div class="memdoc">
313
314<p>Returns the size of a file in the file list, based on an index. </p>
315<dl><dt><b>Parameters:</b></dt><dd>
316 <table class="params">
317 <tr><td class="paramname">index</td><td>is the zero based index of the file which should be returned. The index must be less than the amount <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a871861be76e18d58274c4580b1d103b9" title="Get the number of files in the filelist.">getFileCount()</a> returns. </td></tr>
318 </table>
319 </dd>
320</dl>
321<dl class="return"><dt><b>Returns:</b></dt><dd>The size of the file in bytes. </dd></dl>
322
323</div>
324</div>
325<a class="anchor" id="a063c823f58019bda79efabefabe365da"></a><!-- doxytag: member="irr::io::IFileList::getFullFileName" ref="a063c823f58019bda79efabefabe365da" args="(u32 index) const =0" -->
326<div class="memitem">
327<div class="memproto">
328 <table class="memname">
329 <tr>
330 <td class="memname">virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a>&amp; irr::io::IFileList::getFullFileName </td>
331 <td>(</td>
332 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
333 <td class="paramname"><em>index</em></td><td>)</td>
334 <td> const<code> [pure virtual]</code></td>
335 </tr>
336 </table>
337</div>
338<div class="memdoc">
339
340<p>Gets the full name of a file in the list including the path, based on an index. </p>
341<dl><dt><b>Parameters:</b></dt><dd>
342 <table class="params">
343 <tr><td class="paramname">index</td><td>is the zero based index of the file which name should be returned. The index must be less than the amount <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a871861be76e18d58274c4580b1d103b9" title="Get the number of files in the filelist.">getFileCount()</a> returns. </td></tr>
344 </table>
345 </dd>
346</dl>
347<dl class="return"><dt><b>Returns:</b></dt><dd>File name of the file. Returns 0 if an error occured. </dd></dl>
348
349</div>
350</div>
351<a class="anchor" id="a9f633344aa2bb36f619d1ca8472b46b6"></a><!-- doxytag: member="irr::io::IFileList::getID" ref="a9f633344aa2bb36f619d1ca8472b46b6" args="(u32 index) const =0" -->
352<div class="memitem">
353<div class="memproto">
354 <table class="memname">
355 <tr>
356 <td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::io::IFileList::getID </td>
357 <td>(</td>
358 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
359 <td class="paramname"><em>index</em></td><td>)</td>
360 <td> const<code> [pure virtual]</code></td>
361 </tr>
362 </table>
363</div>
364<div class="memdoc">
365
366<p>Returns the ID of a file in the file list, based on an index. </p>
367<p>This optional ID can be used to link the file list entry to information held elsewhere. For example this could be an index in an <a class="el" href="classirr_1_1io_1_1_i_file_archive.html" title="The FileArchive manages archives and provides access to files inside them.">IFileArchive</a>, linking the entry to its data offset, uncompressed size and CRC. </p>
368<dl><dt><b>Parameters:</b></dt><dd>
369 <table class="params">
370 <tr><td class="paramname">index</td><td>is the zero based index of the file which should be returned. The index must be less than the amount <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a871861be76e18d58274c4580b1d103b9" title="Get the number of files in the filelist.">getFileCount()</a> returns. </td></tr>
371 </table>
372 </dd>
373</dl>
374<dl class="return"><dt><b>Returns:</b></dt><dd>The ID of the file. </dd></dl>
375
376</div>
377</div>
378<a class="anchor" id="ac3473e66ba9c3cee2e06c1fb46493e88"></a><!-- doxytag: member="irr::io::IFileList::getPath" ref="ac3473e66ba9c3cee2e06c1fb46493e88" args="() const =0" -->
379<div class="memitem">
380<div class="memproto">
381 <table class="memname">
382 <tr>
383 <td class="memname">virtual const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a>&amp; irr::io::IFileList::getPath </td>
384 <td>(</td>
385 <td class="paramname"></td><td>)</td>
386 <td> const<code> [pure virtual]</code></td>
387 </tr>
388 </table>
389</div>
390<div class="memdoc">
391
392<p>Returns the base path of the file list. </p>
393
394</div>
395</div>
396<a class="anchor" id="a0f2cb8c99e9ecc4b56d08718c885a5af"></a><!-- doxytag: member="irr::io::IFileList::isDirectory" ref="a0f2cb8c99e9ecc4b56d08718c885a5af" args="(u32 index) const =0" -->
397<div class="memitem">
398<div class="memproto">
399 <table class="memname">
400 <tr>
401 <td class="memname">virtual bool irr::io::IFileList::isDirectory </td>
402 <td>(</td>
403 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
404 <td class="paramname"><em>index</em></td><td>)</td>
405 <td> const<code> [pure virtual]</code></td>
406 </tr>
407 </table>
408</div>
409<div class="memdoc">
410
411<p>Check if the file is a directory. </p>
412<dl><dt><b>Parameters:</b></dt><dd>
413 <table class="params">
414 <tr><td class="paramname">index</td><td>The zero based index which will be checked. The index must be less than the amount <a class="el" href="classirr_1_1io_1_1_i_file_list.html#a871861be76e18d58274c4580b1d103b9" title="Get the number of files in the filelist.">getFileCount()</a> returns. </td></tr>
415 </table>
416 </dd>
417</dl>
418<dl class="return"><dt><b>Returns:</b></dt><dd>True if the file is a directory, else false. </dd></dl>
419
420</div>
421</div>
422<a class="anchor" id="a2cf4f12d7ee6ab35257169ec23654da8"></a><!-- doxytag: member="irr::io::IFileList::sort" ref="a2cf4f12d7ee6ab35257169ec23654da8" args="()=0" -->
423<div class="memitem">
424<div class="memproto">
425 <table class="memname">
426 <tr>
427 <td class="memname">virtual void irr::io::IFileList::sort </td>
428 <td>(</td>
429 <td class="paramname"></td><td>)</td>
430 <td><code> [pure virtual]</code></td>
431 </tr>
432 </table>
433</div>
434<div class="memdoc">
435
436<p>Sorts the file list. You should call this after adding any items to the file list. </p>
437
438</div>
439</div>
440<hr/>The documentation for this class was generated from the following file:<ul>
441<li><a class="el" href="_i_file_list_8h_source.html">IFileList.h</a></li>
442</ul>
443</div>
444</div>
445 <div id="nav-path" class="navpath">
446 <ul>
447 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
448 <li class="navelem"><a class="el" href="namespaceirr_1_1io.html">io</a> </li>
449 <li class="navelem"><a class="el" href="classirr_1_1io_1_1_i_file_list.html">IFileList</a> </li>
450<!-- window showing the filter options -->
451<div id="MSearchSelectWindow"
452 onmouseover="return searchBox.OnSearchSelectShow()"
453 onmouseout="return searchBox.OnSearchSelectHide()"
454 onkeydown="return searchBox.OnSearchSelectKey(event)">
455<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>
456
457<!-- iframe showing the search results (closed by default) -->
458<div id="MSearchResultsWindow">
459<iframe src="javascript:void(0)" frameborder="0"
460 name="MSearchResults" id="MSearchResults">
461</iframe>
462</div>
463
464
465 <li class="footer">
466<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
467Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:45 for Irrlicht 3D Engine by
468<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
469 </ul>
470 </div>
471
472
473</body>
474</html>
generated by cgit v1.1 at 2024-06-27 09:28:41 +0000