aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_x_m_l_writer.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_x_m_l_writer.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_x_m_l_writer.html403
1 files changed, 403 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_x_m_l_writer.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_x_m_l_writer.html
new file mode 100644
index 0000000..70e5123
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_x_m_l_writer.html
@@ -0,0 +1,403 @@
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::IXMLWriter 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_x_m_l_writer.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::IXMLWriter Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::io::IXMLWriter" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p>Interface providing methods for making it easier to write XML files.
95 <a href="classirr_1_1io_1_1_i_x_m_l_writer.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_x_m_l_writer_8h_source.html">IXMLWriter.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::IXMLWriter:</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_x_m_l_writer.png" usemap="#irr::io::IXMLWriter_map" alt=""/>
105 <map id="irr::io::IXMLWriter_map" name="irr::io::IXMLWriter_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_x_m_l_writer-members.html">List of all members.</a></p>
111<h2><a name="pub-methods"></a>
112Public Member Functions</h2>
113<ul>
114<li>virtual void <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html#a904c931fe03455eee04fcf41ef519715">writeClosingTag</a> (const wchar_t *name)=0
115<dl class="el"><dd class="mdescRight">Writes the closing tag for an element. Like "&lt;/foo&gt;". <a href="#a904c931fe03455eee04fcf41ef519715"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html#af6de322540d69764bd33a384763babd1">writeComment</a> (const wchar_t *comment)=0
116<dl class="el"><dd class="mdescRight">Writes a comment into the xml file. <a href="#af6de322540d69764bd33a384763babd1"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html#a09ffde58db20f23b7eba1bf08e1daf42">writeElement</a> (const wchar_t *name, bool empty=false, const wchar_t *attr1Name=0, const wchar_t *attr1Value=0, const wchar_t *attr2Name=0, const wchar_t *attr2Value=0, const wchar_t *attr3Name=0, const wchar_t *attr3Value=0, const wchar_t *attr4Name=0, const wchar_t *attr4Value=0, const wchar_t *attr5Name=0, const wchar_t *attr5Value=0)=0
117<li>virtual void <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html#a78bbf9835512bb404c34339c1a34ea31">writeElement</a> (const wchar_t *name, bool empty, <a class="el" href="classirr_1_1core_1_1array.html">core::array</a>&lt; <a class="el" href="namespaceirr_1_1core.html#aef83fafbb1b36fcce44c07c9be23a7f2">core::stringw</a> &gt; &amp;names, <a class="el" href="classirr_1_1core_1_1array.html">core::array</a>&lt; <a class="el" href="namespaceirr_1_1core.html#aef83fafbb1b36fcce44c07c9be23a7f2">core::stringw</a> &gt; &amp;values)=0
118<dl class="el"><dd class="mdescRight">Writes an xml element with any number of attributes. <a href="#a78bbf9835512bb404c34339c1a34ea31"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html#a98d9b558d991211f77f6d3f2f68d30d2">writeLineBreak</a> ()=0
119<dl class="el"><dd class="mdescRight">Writes a line break. <a href="#a98d9b558d991211f77f6d3f2f68d30d2"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html#a321adae57bcf06aadd2dda57eba1e4a6">writeText</a> (const wchar_t *text)=0
120<dl class="el"><dd class="mdescRight">Writes a text into the file. <a href="#a321adae57bcf06aadd2dda57eba1e4a6"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html#a66fd00f6528fc967e53ea2a83f4fbf09">writeXMLHeader</a> ()=0
121<dl class="el"><dd class="mdescRight">Writes an xml 1.0 header. <a href="#a66fd00f6528fc967e53ea2a83f4fbf09"></a><br/></dl></ul>
122<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
123<div class="textblock"><p>Interface providing methods for making it easier to write XML files. </p>
124<p>This XML Writer writes xml files using in the platform dependent wchar_t format and sets the xml-encoding correspondingly. </p>
125
126<p>Definition at line <a class="el" href="_i_x_m_l_writer_8h_source.html#l00020">20</a> of file <a class="el" href="_i_x_m_l_writer_8h_source.html">IXMLWriter.h</a>.</p>
127</div><hr/><h2>Member Function Documentation</h2>
128<a class="anchor" id="a904c931fe03455eee04fcf41ef519715"></a><!-- doxytag: member="irr::io::IXMLWriter::writeClosingTag" ref="a904c931fe03455eee04fcf41ef519715" args="(const wchar_t *name)=0" -->
129<div class="memitem">
130<div class="memproto">
131 <table class="memname">
132 <tr>
133 <td class="memname">virtual void irr::io::IXMLWriter::writeClosingTag </td>
134 <td>(</td>
135 <td class="paramtype">const wchar_t *&#160;</td>
136 <td class="paramname"><em>name</em></td><td>)</td>
137 <td><code> [pure virtual]</code></td>
138 </tr>
139 </table>
140</div>
141<div class="memdoc">
142
143<p>Writes the closing tag for an element. Like "&lt;/foo&gt;". </p>
144
145</div>
146</div>
147<a class="anchor" id="af6de322540d69764bd33a384763babd1"></a><!-- doxytag: member="irr::io::IXMLWriter::writeComment" ref="af6de322540d69764bd33a384763babd1" args="(const wchar_t *comment)=0" -->
148<div class="memitem">
149<div class="memproto">
150 <table class="memname">
151 <tr>
152 <td class="memname">virtual void irr::io::IXMLWriter::writeComment </td>
153 <td>(</td>
154 <td class="paramtype">const wchar_t *&#160;</td>
155 <td class="paramname"><em>comment</em></td><td>)</td>
156 <td><code> [pure virtual]</code></td>
157 </tr>
158 </table>
159</div>
160<div class="memdoc">
161
162<p>Writes a comment into the xml file. </p>
163
164</div>
165</div>
166<a class="anchor" id="a09ffde58db20f23b7eba1bf08e1daf42"></a><!-- doxytag: member="irr::io::IXMLWriter::writeElement" ref="a09ffde58db20f23b7eba1bf08e1daf42" args="(const wchar_t *name, bool empty=false, const wchar_t *attr1Name=0, const wchar_t *attr1Value=0, const wchar_t *attr2Name=0, const wchar_t *attr2Value=0, const wchar_t *attr3Name=0, const wchar_t *attr3Value=0, const wchar_t *attr4Name=0, const wchar_t *attr4Value=0, const wchar_t *attr5Name=0, const wchar_t *attr5Value=0)=0" -->
167<div class="memitem">
168<div class="memproto">
169 <table class="memname">
170 <tr>
171 <td class="memname">virtual void irr::io::IXMLWriter::writeElement </td>
172 <td>(</td>
173 <td class="paramtype">const wchar_t *&#160;</td>
174 <td class="paramname"><em>name</em>, </td>
175 </tr>
176 <tr>
177 <td class="paramkey"></td>
178 <td></td>
179 <td class="paramtype">bool&#160;</td>
180 <td class="paramname"><em>empty</em> = <code>false</code>, </td>
181 </tr>
182 <tr>
183 <td class="paramkey"></td>
184 <td></td>
185 <td class="paramtype">const wchar_t *&#160;</td>
186 <td class="paramname"><em>attr1Name</em> = <code>0</code>, </td>
187 </tr>
188 <tr>
189 <td class="paramkey"></td>
190 <td></td>
191 <td class="paramtype">const wchar_t *&#160;</td>
192 <td class="paramname"><em>attr1Value</em> = <code>0</code>, </td>
193 </tr>
194 <tr>
195 <td class="paramkey"></td>
196 <td></td>
197 <td class="paramtype">const wchar_t *&#160;</td>
198 <td class="paramname"><em>attr2Name</em> = <code>0</code>, </td>
199 </tr>
200 <tr>
201 <td class="paramkey"></td>
202 <td></td>
203 <td class="paramtype">const wchar_t *&#160;</td>
204 <td class="paramname"><em>attr2Value</em> = <code>0</code>, </td>
205 </tr>
206 <tr>
207 <td class="paramkey"></td>
208 <td></td>
209 <td class="paramtype">const wchar_t *&#160;</td>
210 <td class="paramname"><em>attr3Name</em> = <code>0</code>, </td>
211 </tr>
212 <tr>
213 <td class="paramkey"></td>
214 <td></td>
215 <td class="paramtype">const wchar_t *&#160;</td>
216 <td class="paramname"><em>attr3Value</em> = <code>0</code>, </td>
217 </tr>
218 <tr>
219 <td class="paramkey"></td>
220 <td></td>
221 <td class="paramtype">const wchar_t *&#160;</td>
222 <td class="paramname"><em>attr4Name</em> = <code>0</code>, </td>
223 </tr>
224 <tr>
225 <td class="paramkey"></td>
226 <td></td>
227 <td class="paramtype">const wchar_t *&#160;</td>
228 <td class="paramname"><em>attr4Value</em> = <code>0</code>, </td>
229 </tr>
230 <tr>
231 <td class="paramkey"></td>
232 <td></td>
233 <td class="paramtype">const wchar_t *&#160;</td>
234 <td class="paramname"><em>attr5Name</em> = <code>0</code>, </td>
235 </tr>
236 <tr>
237 <td class="paramkey"></td>
238 <td></td>
239 <td class="paramtype">const wchar_t *&#160;</td>
240 <td class="paramname"><em>attr5Value</em> = <code>0</code>&#160;</td>
241 </tr>
242 <tr>
243 <td></td>
244 <td>)</td>
245 <td></td><td><code> [pure virtual]</code></td>
246 </tr>
247 </table>
248</div>
249<div class="memdoc">
250<p>Writes an xml element with maximal 5 attributes like "&lt;foo /&gt;" or &lt;foo optAttr="value" /&gt;. The element can be empty or not. </p>
251<dl><dt><b>Parameters:</b></dt><dd>
252 <table class="params">
253 <tr><td class="paramname">name,:</td><td>Name of the element </td></tr>
254 <tr><td class="paramname">empty,:</td><td>Specifies if the element should be empty. Like "&lt;foo /&gt;". If You set this to false, something like this is written instead: "&lt;foo&gt;". </td></tr>
255 <tr><td class="paramname">attr1Name,:</td><td>1st attributes name </td></tr>
256 <tr><td class="paramname">attr1Value,:</td><td>1st attributes value </td></tr>
257 <tr><td class="paramname">attr2Name,:</td><td>2nd attributes name </td></tr>
258 <tr><td class="paramname">attr2Value,:</td><td>2nd attributes value </td></tr>
259 <tr><td class="paramname">attr3Name,:</td><td>3rd attributes name </td></tr>
260 <tr><td class="paramname">attr3Value,:</td><td>3rd attributes value </td></tr>
261 <tr><td class="paramname">attr4Name,:</td><td>4th attributes name </td></tr>
262 <tr><td class="paramname">attr4Value,:</td><td>4th attributes value </td></tr>
263 <tr><td class="paramname">attr5Name,:</td><td>5th attributes name </td></tr>
264 <tr><td class="paramname">attr5Value,:</td><td>5th attributes value </td></tr>
265 </table>
266 </dd>
267</dl>
268
269</div>
270</div>
271<a class="anchor" id="a78bbf9835512bb404c34339c1a34ea31"></a><!-- doxytag: member="irr::io::IXMLWriter::writeElement" ref="a78bbf9835512bb404c34339c1a34ea31" args="(const wchar_t *name, bool empty, core::array&lt; core::stringw &gt; &amp;names, core::array&lt; core::stringw &gt; &amp;values)=0" -->
272<div class="memitem">
273<div class="memproto">
274 <table class="memname">
275 <tr>
276 <td class="memname">virtual void irr::io::IXMLWriter::writeElement </td>
277 <td>(</td>
278 <td class="paramtype">const wchar_t *&#160;</td>
279 <td class="paramname"><em>name</em>, </td>
280 </tr>
281 <tr>
282 <td class="paramkey"></td>
283 <td></td>
284 <td class="paramtype">bool&#160;</td>
285 <td class="paramname"><em>empty</em>, </td>
286 </tr>
287 <tr>
288 <td class="paramkey"></td>
289 <td></td>
290 <td class="paramtype"><a class="el" href="classirr_1_1core_1_1array.html">core::array</a>&lt; <a class="el" href="namespaceirr_1_1core.html#aef83fafbb1b36fcce44c07c9be23a7f2">core::stringw</a> &gt; &amp;&#160;</td>
291 <td class="paramname"><em>names</em>, </td>
292 </tr>
293 <tr>
294 <td class="paramkey"></td>
295 <td></td>
296 <td class="paramtype"><a class="el" href="classirr_1_1core_1_1array.html">core::array</a>&lt; <a class="el" href="namespaceirr_1_1core.html#aef83fafbb1b36fcce44c07c9be23a7f2">core::stringw</a> &gt; &amp;&#160;</td>
297 <td class="paramname"><em>values</em>&#160;</td>
298 </tr>
299 <tr>
300 <td></td>
301 <td>)</td>
302 <td></td><td><code> [pure virtual]</code></td>
303 </tr>
304 </table>
305</div>
306<div class="memdoc">
307
308<p>Writes an xml element with any number of attributes. </p>
309
310</div>
311</div>
312<a class="anchor" id="a98d9b558d991211f77f6d3f2f68d30d2"></a><!-- doxytag: member="irr::io::IXMLWriter::writeLineBreak" ref="a98d9b558d991211f77f6d3f2f68d30d2" args="()=0" -->
313<div class="memitem">
314<div class="memproto">
315 <table class="memname">
316 <tr>
317 <td class="memname">virtual void irr::io::IXMLWriter::writeLineBreak </td>
318 <td>(</td>
319 <td class="paramname"></td><td>)</td>
320 <td><code> [pure virtual]</code></td>
321 </tr>
322 </table>
323</div>
324<div class="memdoc">
325
326<p>Writes a line break. </p>
327
328</div>
329</div>
330<a class="anchor" id="a321adae57bcf06aadd2dda57eba1e4a6"></a><!-- doxytag: member="irr::io::IXMLWriter::writeText" ref="a321adae57bcf06aadd2dda57eba1e4a6" args="(const wchar_t *text)=0" -->
331<div class="memitem">
332<div class="memproto">
333 <table class="memname">
334 <tr>
335 <td class="memname">virtual void irr::io::IXMLWriter::writeText </td>
336 <td>(</td>
337 <td class="paramtype">const wchar_t *&#160;</td>
338 <td class="paramname"><em>text</em></td><td>)</td>
339 <td><code> [pure virtual]</code></td>
340 </tr>
341 </table>
342</div>
343<div class="memdoc">
344
345<p>Writes a text into the file. </p>
346<p>All occurrences of special characters such as &amp; (&amp;), &lt; (&lt;), &gt; (&gt;), and " (") are automaticly replaced. </p>
347
348</div>
349</div>
350<a class="anchor" id="a66fd00f6528fc967e53ea2a83f4fbf09"></a><!-- doxytag: member="irr::io::IXMLWriter::writeXMLHeader" ref="a66fd00f6528fc967e53ea2a83f4fbf09" args="()=0" -->
351<div class="memitem">
352<div class="memproto">
353 <table class="memname">
354 <tr>
355 <td class="memname">virtual void irr::io::IXMLWriter::writeXMLHeader </td>
356 <td>(</td>
357 <td class="paramname"></td><td>)</td>
358 <td><code> [pure virtual]</code></td>
359 </tr>
360 </table>
361</div>
362<div class="memdoc">
363
364<p>Writes an xml 1.0 header. </p>
365<p>Looks like &lt;?xml version="1.0"?&gt;. This should always be called before writing anything other, because also the text file header for unicode texts is written out with this method. </p>
366
367</div>
368</div>
369<hr/>The documentation for this class was generated from the following file:<ul>
370<li><a class="el" href="_i_x_m_l_writer_8h_source.html">IXMLWriter.h</a></li>
371</ul>
372</div>
373</div>
374 <div id="nav-path" class="navpath">
375 <ul>
376 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
377 <li class="navelem"><a class="el" href="namespaceirr_1_1io.html">io</a> </li>
378 <li class="navelem"><a class="el" href="classirr_1_1io_1_1_i_x_m_l_writer.html">IXMLWriter</a> </li>
379<!-- window showing the filter options -->
380<div id="MSearchSelectWindow"
381 onmouseover="return searchBox.OnSearchSelectShow()"
382 onmouseout="return searchBox.OnSearchSelectHide()"
383 onkeydown="return searchBox.OnSearchSelectKey(event)">
384<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>
385
386<!-- iframe showing the search results (closed by default) -->
387<div id="MSearchResultsWindow">
388<iframe src="javascript:void(0)" frameborder="0"
389 name="MSearchResults" id="MSearchResults">
390</iframe>
391</div>
392
393
394 <li class="footer">
395<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
396Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:46 for Irrlicht 3D Engine by
397<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
398 </ul>
399 </div>
400
401
402</body>
403</html>