1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::XMLSerializer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::XMLSerializer Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::XMLSerializer" -->
<p>Class used to create XML Document.
<a href="classCEGUI_1_1XMLSerializer.html#details">More...</a></p>
<p><a href="classCEGUI_1_1XMLSerializer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLSerializer.html#a7decf88bd98d69f7da81c6895fc3647b">XMLSerializer</a> (<a class="el" href="namespaceCEGUI.html#ac2f7aaf6a0965b83cb35e0b1298c70b9">OutStream</a> &out, size_t indentSpace=4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1XMLSerializer.html" title="Class used to create XML Document.">XMLSerializer</a> constructor. <a href="#a7decf88bd98d69f7da81c6895fc3647b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e4091d99dd8be15e8c46fe34063fd87"></a><!-- doxytag: member="CEGUI::XMLSerializer::~XMLSerializer" ref="a8e4091d99dd8be15e8c46fe34063fd87" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLSerializer.html#a8e4091d99dd8be15e8c46fe34063fd87">~XMLSerializer</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1XMLSerializer.html" title="Class used to create XML Document.">XMLSerializer</a> destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLSerializer.html#ab3a3a1725e5daa16ba0c4c928fad7a35">openTag</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a new tag in the xml document. <a href="#ab3a3a1725e5daa16ba0c4c928fad7a35"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLSerializer.html#a96711d6357b078bd8a192fc9eae73992">closeTag</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the current tag. <a href="#a96711d6357b078bd8a192fc9eae73992"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLSerializer.html#adcfd8f52eaa4e8714dcf62da590b0b55">attribute</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name, const <a class="el" href="classCEGUI_1_1String.html">String</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">After an opening tag you can populate attribute list with this function. <a href="#adcfd8f52eaa4e8714dcf62da590b0b55"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLSerializer.html#a63e351d6f05922891e292c1fbf9165fb">text</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a text node. <a href="#a63e351d6f05922891e292c1fbf9165fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLSerializer.html#a0a3784f737c074f1a594bea01de6f9f3">getTagCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">report the nimber of tags created in the document <a href="#a0a3784f737c074f1a594bea01de6f9f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLSerializer.html#a9b25463fd8d6c4dbaf4a2b8b99a8cc30">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check wether the XML Serializer status is valid. <a href="#a9b25463fd8d6c4dbaf4a2b8b99a8cc30"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLSerializer.html#a769872deb6d8bb8b5c7fa840bd344124">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check wether the XML Serializer status is invalid. <a href="#a769872deb6d8bb8b5c7fa840bd344124"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class used to create XML Document. </p>
<p>This class hides the complexity of formatting valid XML files. The class provides automatic substitution of entities, XML indenting in respect of the spaces. It does not contains any codes specific to <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> taking appart the <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">CEGUI::String</a> class. The following example show the code needed to exports parts of an XML document similar to what can be found in a layout.</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <iostream></span>
<span class="preprocessor"> #include <CEGUI/XMLSerializer.h></span>
<span class="keywordtype">int</span> main()
{
<span class="comment">// Create an encoder that outputs its result on standard output </span>
<a class="code" href="classCEGUI_1_1XMLSerializer.html#a7decf88bd98d69f7da81c6895fc3647b" title="XMLSerializer constructor.">XMLSerializer</a> xml(std::cout, 4);
xml.openTag(<span class="stringliteral">"Window"</span>)
.attribute(<span class="stringliteral">"Type"</span>, <span class="stringliteral">"TaharezLook/StaticText"</span>)
.attribute(<span class="stringliteral">"Name"</span>, <span class="stringliteral">"Test"</span>)
.openTag(<span class="stringliteral">"Property"</span>)
.attribute(<span class="stringliteral">"Name"</span>, <span class="stringliteral">"Text"</span>)
.text(<span class="stringliteral">"This is the static text to be displayed"</span>)
.closeTag()
.openTag(<span class="stringliteral">"Window"</span>)
.attribute(<span class="stringliteral">"Name"</span>, <span class="stringliteral">"Button"</span>)
.attribute(<span class="stringliteral">"Type"</span>, <span class="stringliteral">"Vanilla/Button"</span>)
.openTag(<span class="stringliteral">"Property"</span>)
.attribute(<span class="stringliteral">"Name"</span>, <span class="stringliteral">"Text"</span>)
.attribute(<span class="stringliteral">"Value"</span>, <span class="stringliteral">"Push me"</span>)
.closeTag()
.closeTag()
.closeTag();
<span class="keywordflow">if</span> (xml)
{
std::cout << <span class="stringliteral">"XML Exported successfully"</span> << std::endl;
}
<span class="keywordflow">return</span> 0;
}
</pre></div> </div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7decf88bd98d69f7da81c6895fc3647b"></a><!-- doxytag: member="CEGUI::XMLSerializer::XMLSerializer" ref="a7decf88bd98d69f7da81c6895fc3647b" args="(OutStream &out, size_t indentSpace=4)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::XMLSerializer::XMLSerializer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCEGUI.html#ac2f7aaf6a0965b83cb35e0b1298c70b9">OutStream</a> & </td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>indentSpace</em> = <code>4</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1XMLSerializer.html" title="Class used to create XML Document.">XMLSerializer</a> constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>The stream to use to export the result</td></tr>
<tr><td class="paramname">indentSpace</td><td>The indentation level (0 to disable indentation) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adcfd8f52eaa4e8714dcf62da590b0b55"></a><!-- doxytag: member="CEGUI::XMLSerializer::attribute" ref="adcfd8f52eaa4e8714dcf62da590b0b55" args="(const String &name, const String &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a>& CEGUI::XMLSerializer::attribute </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>After an opening tag you can populate attribute list with this function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the attribute</td></tr>
<tr><td class="paramname">value</td><td>The value of the attribute</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A reference to the current object for chaining operation </dd></dl>
</div>
</div>
<a class="anchor" id="a96711d6357b078bd8a192fc9eae73992"></a><!-- doxytag: member="CEGUI::XMLSerializer::closeTag" ref="a96711d6357b078bd8a192fc9eae73992" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a>& CEGUI::XMLSerializer::closeTag </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the current tag. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A reference to the current object for chaining operation </dd></dl>
</div>
</div>
<a class="anchor" id="a0a3784f737c074f1a594bea01de6f9f3"></a><!-- doxytag: member="CEGUI::XMLSerializer::getTagCount" ref="a0a3784f737c074f1a594bea01de6f9f3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int CEGUI::XMLSerializer::getTagCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>report the nimber of tags created in the document </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>return the number of tag created in the document </dd></dl>
</div>
</div>
<a class="anchor" id="ab3a3a1725e5daa16ba0c4c928fad7a35"></a><!-- doxytag: member="CEGUI::XMLSerializer::openTag" ref="ab3a3a1725e5daa16ba0c4c928fad7a35" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a>& CEGUI::XMLSerializer::openTag </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start a new tag in the xml document. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the tag</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A reference to the current object for chaining operation </dd></dl>
</div>
</div>
<a class="anchor" id="a9b25463fd8d6c4dbaf4a2b8b99a8cc30"></a><!-- doxytag: member="CEGUI::XMLSerializer::operator bool" ref="a9b25463fd8d6c4dbaf4a2b8b99a8cc30" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::XMLSerializer::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check wether the XML Serializer status is valid. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if all previous operations where successfull </dd></dl>
</div>
</div>
<a class="anchor" id="a769872deb6d8bb8b5c7fa840bd344124"></a><!-- doxytag: member="CEGUI::XMLSerializer::operator!" ref="a769872deb6d8bb8b5c7fa840bd344124" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::XMLSerializer::operator! </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check wether the XML Serializer status is invalid. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if one operations failed </dd></dl>
</div>
</div>
<a class="anchor" id="a63e351d6f05922891e292c1fbf9165fb"></a><!-- doxytag: member="CEGUI::XMLSerializer::text" ref="a63e351d6f05922891e292c1fbf9165fb" args="(const String &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a>& CEGUI::XMLSerializer::text </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a text node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>the content of the node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A reference to the current object for chaining operation </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
