aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_irr_x_m_l_reader.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_irr_x_m_l_reader.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_irr_x_m_l_reader.html603
1 files changed, 603 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_irr_x_m_l_reader.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_irr_x_m_l_reader.html
new file mode 100644
index 0000000..b4e92f8
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_irr_x_m_l_reader.html
@@ -0,0 +1,603 @@
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::IIrrXMLReader&lt; char_type, super_class &gt; Class Template 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_irr_x_m_l_reader.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::IIrrXMLReader&lt; char_type, super_class &gt; Class Template Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::io::IIrrXMLReader" -->
94<p>Interface providing easy read access to a XML file.
95 <a href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="irr_x_m_l_8h_source.html">irrXML.h</a>&gt;</code></p>
98
99<p><a href="classirr_1_1io_1_1_i_irr_x_m_l_reader-members.html">List of all members.</a></p>
100<h2><a name="pub-methods"></a>
101Public Member Functions</h2>
102<ul>
103<li>virtual <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#ad1d9faeae926afc224d9dea0ad7a08ac">~IIrrXMLReader</a> ()
104<dl class="el"><dd class="mdescRight">Destructor. <a href="#ad1d9faeae926afc224d9dea0ad7a08ac"></a><br/></dl><li>virtual unsigned int <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a8f85253d2efb15061facdb9571b9c549">getAttributeCount</a> () const =0
105<dl class="el"><dd class="mdescRight">Returns attribute count of the current XML node. <a href="#a8f85253d2efb15061facdb9571b9c549"></a><br/></dl><li>virtual const char_type * <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#aa0807dc565c67fcf355e656df1a326ef">getAttributeName</a> (int idx) const =0
106<dl class="el"><dd class="mdescRight">Returns name of an attribute. <a href="#aa0807dc565c67fcf355e656df1a326ef"></a><br/></dl><li>virtual const char_type * <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a41bd71a1b9d4a80cd1d0257dedb35325">getAttributeValue</a> (int idx) const =0
107<dl class="el"><dd class="mdescRight">Returns the value of an attribute. <a href="#a41bd71a1b9d4a80cd1d0257dedb35325"></a><br/></dl><li>virtual const char_type * <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#adaac9a49b396e7fc2d335335f36391a9">getAttributeValue</a> (const char_type *name) const =0
108<dl class="el"><dd class="mdescRight">Returns the value of an attribute. <a href="#adaac9a49b396e7fc2d335335f36391a9"></a><br/></dl><li>virtual float <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a2b1032f213e9910827842f6057269235">getAttributeValueAsFloat</a> (const char_type *name) const =0
109<dl class="el"><dd class="mdescRight">Returns the value of an attribute as float. <a href="#a2b1032f213e9910827842f6057269235"></a><br/></dl><li>virtual float <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a3a01b3cec9db01d00928074846d39add">getAttributeValueAsFloat</a> (int idx) const =0
110<dl class="el"><dd class="mdescRight">Returns the value of an attribute as float. <a href="#a3a01b3cec9db01d00928074846d39add"></a><br/></dl><li>virtual int <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#ab37bef58865355a7dba0011a38e6c8e7">getAttributeValueAsInt</a> (const char_type *name) const =0
111<dl class="el"><dd class="mdescRight">Returns the value of an attribute as integer. <a href="#ab37bef58865355a7dba0011a38e6c8e7"></a><br/></dl><li>virtual int <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a8f2d57c9f358b9683fb177f440661426">getAttributeValueAsInt</a> (int idx) const =0
112<dl class="el"><dd class="mdescRight">Returns the value of an attribute as integer. <a href="#a8f2d57c9f358b9683fb177f440661426"></a><br/></dl><li>virtual const char_type * <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a7674852b2e24b2710b90aab10ef1fc22">getAttributeValueSafe</a> (const char_type *name) const =0
113<dl class="el"><dd class="mdescRight">Returns the value of an attribute in a safe way. <a href="#a7674852b2e24b2710b90aab10ef1fc22"></a><br/></dl><li>virtual const char_type * <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#aecbe0698e8f9acf88e27dd53da984210">getNodeData</a> () const =0
114<dl class="el"><dd class="mdescRight">Returns data of the current node. <a href="#aecbe0698e8f9acf88e27dd53da984210"></a><br/></dl><li>virtual const char_type * <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a7d745b130c895d0f910f191d04e20e87">getNodeName</a> () const =0
115<dl class="el"><dd class="mdescRight">Returns the name of the current node. <a href="#a7d745b130c895d0f910f191d04e20e87"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#a86a02676c9cbb822e04d60c81b4f33ed">EXML_NODE</a> <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a3482e8e6bdc15965fc6a0bcef6e9a8e0">getNodeType</a> () const =0
116<dl class="el"><dd class="mdescRight">Returns the type of the current XML node. <a href="#a3482e8e6bdc15965fc6a0bcef6e9a8e0"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#ac7e51e5a6bd00451dec248f497b16a9d">ETEXT_FORMAT</a> <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a9af7e323c292a4836bf4a7c093b4d85a">getParserFormat</a> () const =0
117<dl class="el"><dd class="mdescRight">Returns format of the strings returned by the parser. <a href="#a9af7e323c292a4836bf4a7c093b4d85a"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1io.html#ac7e51e5a6bd00451dec248f497b16a9d">ETEXT_FORMAT</a> <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a00998ef2d3a562d6b2b8302c3430322d">getSourceFormat</a> () const =0
118<dl class="el"><dd class="mdescRight">Returns format of the source xml file. <a href="#a00998ef2d3a562d6b2b8302c3430322d"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a3c85b144e0376c9ff90bce1bbbc338a9">isEmptyElement</a> () const =0
119<dl class="el"><dd class="mdescRight">Returns if an element is an empty element, like &lt;foo /&gt; <a href="#a3c85b144e0376c9ff90bce1bbbc338a9"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a157f458f7dabeeff173f72a0fb443a8e">read</a> ()=0
120<dl class="el"><dd class="mdescRight">Reads forward to the next xml node. <a href="#a157f458f7dabeeff173f72a0fb443a8e"></a><br/></dl></ul>
121<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
122<div class="textblock"><h3>template&lt;class char_type, class super_class&gt;<br/>
123class irr::io::IIrrXMLReader&lt; char_type, super_class &gt;</h3>
124
125<p>Interface providing easy read access to a XML file. </p>
126<p>You can create an instance of this reader using one of the factory functions <a class="el" href="namespaceirr_1_1io.html#a581f4d4648398759c61266d63d7106b1" title="Creates an instance of an UFT-8 or ASCII character xml parser.">createIrrXMLReader()</a>, <a class="el" href="namespaceirr_1_1io.html#a86473ef152c15b685af181a4c5461a5d" title="Creates an instance of an UFT-16 xml parser.">createIrrXMLReaderUTF16()</a> and <a class="el" href="namespaceirr_1_1io.html#ae05bf7ee342431ea8c98fb98e75b974a" title="Creates an instance of an UFT-32 xml parser.">createIrrXMLReaderUTF32()</a>. If using the parser from the Irrlicht Engine, please use <a class="el" href="classirr_1_1io_1_1_i_file_system.html#a167c9fa159d16ee5c56c074636b0865e" title="Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*)...">IFileSystem::createXMLReader()</a> instead. For a detailed intro how to use the parser, see irrxmlexample and features.</p>
127<p>The typical usage of this parser looks like this: </p>
128<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include &lt;<a class="code" href="irr_x_m_l_8h.html" title="Header file of the irrXML, the Irrlicht XML parser.">irrXML.h</a>&gt;</span>
129 <span class="keyword">using namespace </span>irr; <span class="comment">// irrXML is located in the namespace irr::io</span>
130 <span class="keyword">using namespace </span>io;
131
132 <span class="keywordtype">void</span> main()
133 {
134 <span class="comment">// create the reader using one of the factory functions</span>
135 <a class="code" href="namespaceirr_1_1io.html#a1628edbb9d5d53f18c82d2a92b0ad27e" title="A UTF-8 or ASCII character xml parser.">IrrXMLReader</a>* xml = <a class="code" href="namespaceirr_1_1io.html#a581f4d4648398759c61266d63d7106b1" title="Creates an instance of an UFT-8 or ASCII character xml parser.">createIrrXMLReader</a>(<span class="stringliteral">&quot;config.xml&quot;</span>);
136
137 <span class="keywordflow">if</span> (xml == 0)
138 <span class="keywordflow">return</span>; <span class="comment">// file could not be opened</span>
139
140 <span class="comment">// parse the file until end reached</span>
141 <span class="keywordflow">while</span>(xml-&gt;read())
142 {
143 <span class="comment">// based on xml-&gt;getNodeType(), do something.</span>
144 }
145
146 <span class="comment">// delete the xml parser after usage</span>
147 <span class="keyword">delete</span> xml;
148 }
149</pre></div><p> See irrxmlexample for a more detailed example. </p>
150
151<p>Definition at line <a class="el" href="irr_x_m_l_8h_source.html#l00275">275</a> of file <a class="el" href="irr_x_m_l_8h_source.html">irrXML.h</a>.</p>
152</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
153<a class="anchor" id="ad1d9faeae926afc224d9dea0ad7a08ac"></a><!-- doxytag: member="irr::io::IIrrXMLReader::~IIrrXMLReader" ref="ad1d9faeae926afc224d9dea0ad7a08ac" args="()" -->
154<div class="memitem">
155<div class="memproto">
156<div class="memtemplate">
157template&lt;class char_type , class super_class &gt; </div>
158 <table class="memname">
159 <tr>
160 <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::~<a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">IIrrXMLReader</a> </td>
161 <td>(</td>
162 <td class="paramname"></td><td>)</td>
163 <td><code> [inline, virtual]</code></td>
164 </tr>
165 </table>
166</div>
167<div class="memdoc">
168
169<p>Destructor. </p>
170
171<p>Definition at line <a class="el" href="irr_x_m_l_8h_source.html#l00280">280</a> of file <a class="el" href="irr_x_m_l_8h_source.html">irrXML.h</a>.</p>
172
173</div>
174</div>
175<hr/><h2>Member Function Documentation</h2>
176<a class="anchor" id="a8f85253d2efb15061facdb9571b9c549"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getAttributeCount" ref="a8f85253d2efb15061facdb9571b9c549" args="() const =0" -->
177<div class="memitem">
178<div class="memproto">
179<div class="memtemplate">
180template&lt;class char_type , class super_class &gt; </div>
181 <table class="memname">
182 <tr>
183 <td class="memname">virtual unsigned int <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getAttributeCount </td>
184 <td>(</td>
185 <td class="paramname"></td><td>)</td>
186 <td> const<code> [pure virtual]</code></td>
187 </tr>
188 </table>
189</div>
190<div class="memdoc">
191
192<p>Returns attribute count of the current XML node. </p>
193<p>This is usually non null if the current node is EXN_ELEMENT, and the element has attributes. </p>
194<dl class="return"><dt><b>Returns:</b></dt><dd>Returns amount of attributes of this xml node. </dd></dl>
195
196</div>
197</div>
198<a class="anchor" id="aa0807dc565c67fcf355e656df1a326ef"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getAttributeName" ref="aa0807dc565c67fcf355e656df1a326ef" args="(int idx) const =0" -->
199<div class="memitem">
200<div class="memproto">
201<div class="memtemplate">
202template&lt;class char_type , class super_class &gt; </div>
203 <table class="memname">
204 <tr>
205 <td class="memname">virtual const char_type* <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getAttributeName </td>
206 <td>(</td>
207 <td class="paramtype">int&#160;</td>
208 <td class="paramname"><em>idx</em></td><td>)</td>
209 <td> const<code> [pure virtual]</code></td>
210 </tr>
211 </table>
212</div>
213<div class="memdoc">
214
215<p>Returns name of an attribute. </p>
216<dl><dt><b>Parameters:</b></dt><dd>
217 <table class="params">
218 <tr><td class="paramname">idx,:</td><td>Zero based index, should be something between 0 and <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a8f85253d2efb15061facdb9571b9c549" title="Returns attribute count of the current XML node.">getAttributeCount()</a>-1. </td></tr>
219 </table>
220 </dd>
221</dl>
222<dl class="return"><dt><b>Returns:</b></dt><dd>Name of the attribute, 0 if an attribute with this index does not exist. </dd></dl>
223
224</div>
225</div>
226<a class="anchor" id="a41bd71a1b9d4a80cd1d0257dedb35325"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getAttributeValue" ref="a41bd71a1b9d4a80cd1d0257dedb35325" args="(int idx) const =0" -->
227<div class="memitem">
228<div class="memproto">
229<div class="memtemplate">
230template&lt;class char_type , class super_class &gt; </div>
231 <table class="memname">
232 <tr>
233 <td class="memname">virtual const char_type* <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getAttributeValue </td>
234 <td>(</td>
235 <td class="paramtype">int&#160;</td>
236 <td class="paramname"><em>idx</em></td><td>)</td>
237 <td> const<code> [pure virtual]</code></td>
238 </tr>
239 </table>
240</div>
241<div class="memdoc">
242
243<p>Returns the value of an attribute. </p>
244<dl><dt><b>Parameters:</b></dt><dd>
245 <table class="params">
246 <tr><td class="paramname">idx,:</td><td>Zero based index, should be something between 0 and <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a8f85253d2efb15061facdb9571b9c549" title="Returns attribute count of the current XML node.">getAttributeCount()</a>-1. </td></tr>
247 </table>
248 </dd>
249</dl>
250<dl class="return"><dt><b>Returns:</b></dt><dd>Value of the attribute, 0 if an attribute with this index does not exist. </dd></dl>
251
252</div>
253</div>
254<a class="anchor" id="adaac9a49b396e7fc2d335335f36391a9"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getAttributeValue" ref="adaac9a49b396e7fc2d335335f36391a9" args="(const char_type *name) const =0" -->
255<div class="memitem">
256<div class="memproto">
257<div class="memtemplate">
258template&lt;class char_type , class super_class &gt; </div>
259 <table class="memname">
260 <tr>
261 <td class="memname">virtual const char_type* <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getAttributeValue </td>
262 <td>(</td>
263 <td class="paramtype">const char_type *&#160;</td>
264 <td class="paramname"><em>name</em></td><td>)</td>
265 <td> const<code> [pure virtual]</code></td>
266 </tr>
267 </table>
268</div>
269<div class="memdoc">
270
271<p>Returns the value of an attribute. </p>
272<dl><dt><b>Parameters:</b></dt><dd>
273 <table class="params">
274 <tr><td class="paramname">name,:</td><td>Name of the attribute. </td></tr>
275 </table>
276 </dd>
277</dl>
278<dl class="return"><dt><b>Returns:</b></dt><dd>Value of the attribute, 0 if an attribute with this name does not exist. </dd></dl>
279
280</div>
281</div>
282<a class="anchor" id="a2b1032f213e9910827842f6057269235"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getAttributeValueAsFloat" ref="a2b1032f213e9910827842f6057269235" args="(const char_type *name) const =0" -->
283<div class="memitem">
284<div class="memproto">
285<div class="memtemplate">
286template&lt;class char_type , class super_class &gt; </div>
287 <table class="memname">
288 <tr>
289 <td class="memname">virtual float <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getAttributeValueAsFloat </td>
290 <td>(</td>
291 <td class="paramtype">const char_type *&#160;</td>
292 <td class="paramname"><em>name</em></td><td>)</td>
293 <td> const<code> [pure virtual]</code></td>
294 </tr>
295 </table>
296</div>
297<div class="memdoc">
298
299<p>Returns the value of an attribute as float. </p>
300<dl><dt><b>Parameters:</b></dt><dd>
301 <table class="params">
302 <tr><td class="paramname">name,:</td><td>Name of the attribute. </td></tr>
303 </table>
304 </dd>
305</dl>
306<dl class="return"><dt><b>Returns:</b></dt><dd>Value of the attribute as float, and 0 if an attribute with this name does not exist or the value could not be interpreted as float. </dd></dl>
307
308</div>
309</div>
310<a class="anchor" id="a3a01b3cec9db01d00928074846d39add"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getAttributeValueAsFloat" ref="a3a01b3cec9db01d00928074846d39add" args="(int idx) const =0" -->
311<div class="memitem">
312<div class="memproto">
313<div class="memtemplate">
314template&lt;class char_type , class super_class &gt; </div>
315 <table class="memname">
316 <tr>
317 <td class="memname">virtual float <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getAttributeValueAsFloat </td>
318 <td>(</td>
319 <td class="paramtype">int&#160;</td>
320 <td class="paramname"><em>idx</em></td><td>)</td>
321 <td> const<code> [pure virtual]</code></td>
322 </tr>
323 </table>
324</div>
325<div class="memdoc">
326
327<p>Returns the value of an attribute as float. </p>
328<dl><dt><b>Parameters:</b></dt><dd>
329 <table class="params">
330 <tr><td class="paramname">idx,:</td><td>Zero based index, should be something between 0 and <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a8f85253d2efb15061facdb9571b9c549" title="Returns attribute count of the current XML node.">getAttributeCount()</a>-1. </td></tr>
331 </table>
332 </dd>
333</dl>
334<dl class="return"><dt><b>Returns:</b></dt><dd>Value of the attribute as float, and 0 if an attribute with this index does not exist or the value could not be interpreted as float. </dd></dl>
335
336</div>
337</div>
338<a class="anchor" id="ab37bef58865355a7dba0011a38e6c8e7"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getAttributeValueAsInt" ref="ab37bef58865355a7dba0011a38e6c8e7" args="(const char_type *name) const =0" -->
339<div class="memitem">
340<div class="memproto">
341<div class="memtemplate">
342template&lt;class char_type , class super_class &gt; </div>
343 <table class="memname">
344 <tr>
345 <td class="memname">virtual int <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getAttributeValueAsInt </td>
346 <td>(</td>
347 <td class="paramtype">const char_type *&#160;</td>
348 <td class="paramname"><em>name</em></td><td>)</td>
349 <td> const<code> [pure virtual]</code></td>
350 </tr>
351 </table>
352</div>
353<div class="memdoc">
354
355<p>Returns the value of an attribute as integer. </p>
356<dl><dt><b>Parameters:</b></dt><dd>
357 <table class="params">
358 <tr><td class="paramname">name</td><td>Name of the attribute. </td></tr>
359 </table>
360 </dd>
361</dl>
362<dl class="return"><dt><b>Returns:</b></dt><dd>Value of the attribute as integer, and 0 if an attribute with this name does not exist or the value could not be interpreted as integer. </dd></dl>
363
364</div>
365</div>
366<a class="anchor" id="a8f2d57c9f358b9683fb177f440661426"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getAttributeValueAsInt" ref="a8f2d57c9f358b9683fb177f440661426" args="(int idx) const =0" -->
367<div class="memitem">
368<div class="memproto">
369<div class="memtemplate">
370template&lt;class char_type , class super_class &gt; </div>
371 <table class="memname">
372 <tr>
373 <td class="memname">virtual int <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getAttributeValueAsInt </td>
374 <td>(</td>
375 <td class="paramtype">int&#160;</td>
376 <td class="paramname"><em>idx</em></td><td>)</td>
377 <td> const<code> [pure virtual]</code></td>
378 </tr>
379 </table>
380</div>
381<div class="memdoc">
382
383<p>Returns the value of an attribute as integer. </p>
384<dl><dt><b>Parameters:</b></dt><dd>
385 <table class="params">
386 <tr><td class="paramname">idx,:</td><td>Zero based index, should be something between 0 and <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a8f85253d2efb15061facdb9571b9c549" title="Returns attribute count of the current XML node.">getAttributeCount()</a>-1. </td></tr>
387 </table>
388 </dd>
389</dl>
390<dl class="return"><dt><b>Returns:</b></dt><dd>Value of the attribute as integer, and 0 if an attribute with this index does not exist or the value could not be interpreted as integer. </dd></dl>
391
392</div>
393</div>
394<a class="anchor" id="a7674852b2e24b2710b90aab10ef1fc22"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getAttributeValueSafe" ref="a7674852b2e24b2710b90aab10ef1fc22" args="(const char_type *name) const =0" -->
395<div class="memitem">
396<div class="memproto">
397<div class="memtemplate">
398template&lt;class char_type , class super_class &gt; </div>
399 <table class="memname">
400 <tr>
401 <td class="memname">virtual const char_type* <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getAttributeValueSafe </td>
402 <td>(</td>
403 <td class="paramtype">const char_type *&#160;</td>
404 <td class="paramname"><em>name</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>Returns the value of an attribute in a safe way. </p>
412<p>Like <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html#a41bd71a1b9d4a80cd1d0257dedb35325" title="Returns the value of an attribute.">getAttributeValue()</a>, but does not return 0 if the attribute does not exist. An empty string ("") is returned then. </p>
413<dl><dt><b>Parameters:</b></dt><dd>
414 <table class="params">
415 <tr><td class="paramname">name,:</td><td>Name of the attribute. </td></tr>
416 </table>
417 </dd>
418</dl>
419<dl class="return"><dt><b>Returns:</b></dt><dd>Value of the attribute, and "" if an attribute with this name does not exist </dd></dl>
420
421</div>
422</div>
423<a class="anchor" id="aecbe0698e8f9acf88e27dd53da984210"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getNodeData" ref="aecbe0698e8f9acf88e27dd53da984210" args="() const =0" -->
424<div class="memitem">
425<div class="memproto">
426<div class="memtemplate">
427template&lt;class char_type , class super_class &gt; </div>
428 <table class="memname">
429 <tr>
430 <td class="memname">virtual const char_type* <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getNodeData </td>
431 <td>(</td>
432 <td class="paramname"></td><td>)</td>
433 <td> const<code> [pure virtual]</code></td>
434 </tr>
435 </table>
436</div>
437<div class="memdoc">
438
439<p>Returns data of the current node. </p>
440<p>Only valid if the node has some data and it is of type EXN_TEXT, EXN_COMMENT, EXN_CDATA or EXN_UNKNOWN. </p>
441
442</div>
443</div>
444<a class="anchor" id="a7d745b130c895d0f910f191d04e20e87"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getNodeName" ref="a7d745b130c895d0f910f191d04e20e87" args="() const =0" -->
445<div class="memitem">
446<div class="memproto">
447<div class="memtemplate">
448template&lt;class char_type , class super_class &gt; </div>
449 <table class="memname">
450 <tr>
451 <td class="memname">virtual const char_type* <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getNodeName </td>
452 <td>(</td>
453 <td class="paramname"></td><td>)</td>
454 <td> const<code> [pure virtual]</code></td>
455 </tr>
456 </table>
457</div>
458<div class="memdoc">
459
460<p>Returns the name of the current node. </p>
461<p>Only valid, if the node type is EXN_ELEMENT. </p>
462<dl class="return"><dt><b>Returns:</b></dt><dd>Name of the current node or 0 if the node has no name. </dd></dl>
463
464</div>
465</div>
466<a class="anchor" id="a3482e8e6bdc15965fc6a0bcef6e9a8e0"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getNodeType" ref="a3482e8e6bdc15965fc6a0bcef6e9a8e0" args="() const =0" -->
467<div class="memitem">
468<div class="memproto">
469<div class="memtemplate">
470template&lt;class char_type , class super_class &gt; </div>
471 <table class="memname">
472 <tr>
473 <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#a86a02676c9cbb822e04d60c81b4f33ed">EXML_NODE</a> <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getNodeType </td>
474 <td>(</td>
475 <td class="paramname"></td><td>)</td>
476 <td> const<code> [pure virtual]</code></td>
477 </tr>
478 </table>
479</div>
480<div class="memdoc">
481
482<p>Returns the type of the current XML node. </p>
483
484</div>
485</div>
486<a class="anchor" id="a9af7e323c292a4836bf4a7c093b4d85a"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getParserFormat" ref="a9af7e323c292a4836bf4a7c093b4d85a" args="() const =0" -->
487<div class="memitem">
488<div class="memproto">
489<div class="memtemplate">
490template&lt;class char_type , class super_class &gt; </div>
491 <table class="memname">
492 <tr>
493 <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#ac7e51e5a6bd00451dec248f497b16a9d">ETEXT_FORMAT</a> <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getParserFormat </td>
494 <td>(</td>
495 <td class="paramname"></td><td>)</td>
496 <td> const<code> [pure virtual]</code></td>
497 </tr>
498 </table>
499</div>
500<div class="memdoc">
501
502<p>Returns format of the strings returned by the parser. </p>
503<p>This will be UTF8 for example when you created a parser with IrrXMLReaderUTF8() and UTF32 when it has been created using IrrXMLReaderUTF32. It should not be necessary to call this method and only exists for informational purposes. </p>
504
505</div>
506</div>
507<a class="anchor" id="a00998ef2d3a562d6b2b8302c3430322d"></a><!-- doxytag: member="irr::io::IIrrXMLReader::getSourceFormat" ref="a00998ef2d3a562d6b2b8302c3430322d" args="() const =0" -->
508<div class="memitem">
509<div class="memproto">
510<div class="memtemplate">
511template&lt;class char_type , class super_class &gt; </div>
512 <table class="memname">
513 <tr>
514 <td class="memname">virtual <a class="el" href="namespaceirr_1_1io.html#ac7e51e5a6bd00451dec248f497b16a9d">ETEXT_FORMAT</a> <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::getSourceFormat </td>
515 <td>(</td>
516 <td class="paramname"></td><td>)</td>
517 <td> const<code> [pure virtual]</code></td>
518 </tr>
519 </table>
520</div>
521<div class="memdoc">
522
523<p>Returns format of the source xml file. </p>
524<p>It is not necessary to use this method because the parser will convert the input file format to the format wanted by the user when creating the parser. This method is useful to get/display additional informations. </p>
525
526</div>
527</div>
528<a class="anchor" id="a3c85b144e0376c9ff90bce1bbbc338a9"></a><!-- doxytag: member="irr::io::IIrrXMLReader::isEmptyElement" ref="a3c85b144e0376c9ff90bce1bbbc338a9" args="() const =0" -->
529<div class="memitem">
530<div class="memproto">
531<div class="memtemplate">
532template&lt;class char_type , class super_class &gt; </div>
533 <table class="memname">
534 <tr>
535 <td class="memname">virtual bool <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::isEmptyElement </td>
536 <td>(</td>
537 <td class="paramname"></td><td>)</td>
538 <td> const<code> [pure virtual]</code></td>
539 </tr>
540 </table>
541</div>
542<div class="memdoc">
543
544<p>Returns if an element is an empty element, like &lt;foo /&gt; </p>
545
546</div>
547</div>
548<a class="anchor" id="a157f458f7dabeeff173f72a0fb443a8e"></a><!-- doxytag: member="irr::io::IIrrXMLReader::read" ref="a157f458f7dabeeff173f72a0fb443a8e" args="()=0" -->
549<div class="memitem">
550<div class="memproto">
551<div class="memtemplate">
552template&lt;class char_type , class super_class &gt; </div>
553 <table class="memname">
554 <tr>
555 <td class="memname">virtual bool <a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">irr::io::IIrrXMLReader</a>&lt; char_type, super_class &gt;::read </td>
556 <td>(</td>
557 <td class="paramname"></td><td>)</td>
558 <td><code> [pure virtual]</code></td>
559 </tr>
560 </table>
561</div>
562<div class="memdoc">
563
564<p>Reads forward to the next xml node. </p>
565<dl class="return"><dt><b>Returns:</b></dt><dd>Returns false, if there was no further node. </dd></dl>
566
567</div>
568</div>
569<hr/>The documentation for this class was generated from the following file:<ul>
570<li><a class="el" href="irr_x_m_l_8h_source.html">irrXML.h</a></li>
571</ul>
572</div>
573</div>
574 <div id="nav-path" class="navpath">
575 <ul>
576 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
577 <li class="navelem"><a class="el" href="namespaceirr_1_1io.html">io</a> </li>
578 <li class="navelem"><a class="el" href="classirr_1_1io_1_1_i_irr_x_m_l_reader.html">IIrrXMLReader</a> </li>
579<!-- window showing the filter options -->
580<div id="MSearchSelectWindow"
581 onmouseover="return searchBox.OnSearchSelectShow()"
582 onmouseout="return searchBox.OnSearchSelectHide()"
583 onkeydown="return searchBox.OnSearchSelectKey(event)">
584<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>
585
586<!-- iframe showing the search results (closed by default) -->
587<div id="MSearchResultsWindow">
588<iframe src="javascript:void(0)" frameborder="0"
589 name="MSearchResults" id="MSearchResults">
590</iframe>
591</div>
592
593
594 <li class="footer">
595<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
596Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:46 for Irrlicht 3D Engine by
597<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
598 </ul>
599 </div>
600
601
602</body>
603</html>
generated by cgit v1.1 at 2024-05-16 07:10:09 +0000