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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
|
<!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::XMLAttributes 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_1XMLAttributes.html">XMLAttributes</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::XMLAttributes Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::XMLAttributes" -->
<p>Class representing a block of attributes associated with an XML element.
<a href="classCEGUI_1_1XMLAttributes.html#details">More...</a></p>
<p><a href="classCEGUI_1_1XMLAttributes-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"><a class="anchor" id="a986763fd53bfe03b2ad03045d8b202de"></a><!-- doxytag: member="CEGUI::XMLAttributes::XMLAttributes" ref="a986763fd53bfe03b2ad03045d8b202de" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#a986763fd53bfe03b2ad03045d8b202de">XMLAttributes</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1XMLAttributes.html" title="Class representing a block of attributes associated with an XML element.">XMLAttributes</a> constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb650b0dc8c1eb3622c3318197263d3f"></a><!-- doxytag: member="CEGUI::XMLAttributes::~XMLAttributes" ref="abb650b0dc8c1eb3622c3318197263d3f" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#abb650b0dc8c1eb3622c3318197263d3f">~XMLAttributes</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1XMLAttributes.html" title="Class representing a block of attributes associated with an XML element.">XMLAttributes</a> Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#afb18cd2cbf289b411f8678c2706518da">add</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &attrName, const <a class="el" href="classCEGUI_1_1String.html">String</a> &attrValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an attribute to the attribute block. If the attribute value already exists, it is replaced with the new value. <a href="#afb18cd2cbf289b411f8678c2706518da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#a9a61a4969b96ea61eac198242c58d9e0">remove</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &attrName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes an attribute from the attribute block. <a href="#a9a61a4969b96ea61eac198242c58d9e0"></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_1XMLAttributes.html#ad5feca0e08272ab89181eb79207d0e3d">exists</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &attrName) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the named attribute exists within the attribute block. <a href="#ad5feca0e08272ab89181eb79207d0e3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#a06628a505fa3f1d90f1e43ad199c9222">getCount</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of attributes in the attribute block. <a href="#a06628a505fa3f1d90f1e43ad199c9222"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#a75e4a74ff1ea386ed0b7ee0f5bbfcaad">getName</a> (size_t index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of an attribute based upon its index within the attribute block. <a href="#a75e4a74ff1ea386ed0b7ee0f5bbfcaad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#a61c9c73f82c172ecb99536a1acfa6f9f">getValue</a> (size_t index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value string of an attribute based upon its index within the attribute block. <a href="#a61c9c73f82c172ecb99536a1acfa6f9f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#a1e51fb2eb6abcb095033a96c4c8f70b4">getValue</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &attrName) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value string for attribute <em>attrName</em>. <a href="#a1e51fb2eb6abcb095033a96c4c8f70b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#a162595352a76f44f37d8ccad45c06986">getValueAsString</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &attrName, const <a class="el" href="classCEGUI_1_1String.html">String</a> &def="") const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value of attribute <em>attrName</em> as a string. <a href="#a162595352a76f44f37d8ccad45c06986"></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_1XMLAttributes.html#ace2d89aa21f97fe3ff2653145372851e">getValueAsBool</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &attrName, bool def=false) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value of attribute <em>attrName</em> as a boolean value. <a href="#ace2d89aa21f97fe3ff2653145372851e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#aaa56691c48a2ac7a14beda359fd0bda2">getValueAsInteger</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &attrName, int def=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value of attribute <em>attrName</em> as a integer value. <a href="#aaa56691c48a2ac7a14beda359fd0bda2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1XMLAttributes.html#adb9355b9b0c4eac7387478f077fb8521">getValueAsFloat</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &attrName, float def=0.0f) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value of attribute <em>attrName</em> as a floating point value. <a href="#adb9355b9b0c4eac7387478f077fb8521"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a2cab719201aaadd3d941bc59ea4c83"></a><!-- doxytag: member="CEGUI::XMLAttributes::AttributeMap" ref="a8a2cab719201aaadd3d941bc59ea4c83" args="" -->
typedef std::map< <a class="el" href="classCEGUI_1_1String.html">String</a>, <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1String.html">String</a>, <br class="typebreak"/>
<a class="el" href="structCEGUI_1_1String_1_1FastLessCompare.html">String::FastLessCompare</a> > </td><td class="memItemRight" valign="bottom"><b>AttributeMap</b></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01a2b52c879f2b39748e0dcff9cc7ea1"></a><!-- doxytag: member="CEGUI::XMLAttributes::d_attrs" ref="a01a2b52c879f2b39748e0dcff9cc7ea1" args="" -->
AttributeMap </td><td class="memItemRight" valign="bottom"><b>d_attrs</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class representing a block of attributes associated with an XML element. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afb18cd2cbf289b411f8678c2706518da"></a><!-- doxytag: member="CEGUI::XMLAttributes::add" ref="afb18cd2cbf289b411f8678c2706518da" args="(const String &attrName, const String &attrValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::XMLAttributes::add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>attrName</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>attrValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an attribute to the attribute block. If the attribute value already exists, it is replaced with the new value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">attrName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the attribute to be added.</td></tr>
<tr><td class="paramname">attrValue</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding a string representation of the attribute value.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="ad5feca0e08272ab89181eb79207d0e3d"></a><!-- doxytag: member="CEGUI::XMLAttributes::exists" ref="ad5feca0e08272ab89181eb79207d0e3d" args="(const String &attrName) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::XMLAttributes::exists </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>attrName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether the named attribute exists within the attribute block. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">attrName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the attribute to be checked.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if an attribute with the name <em>attrName</em> is present in the attribute block.</li>
<li>false if no attribute named <em>attrName</em> is present in the attribute block. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a06628a505fa3f1d90f1e43ad199c9222"></a><!-- doxytag: member="CEGUI::XMLAttributes::getCount" ref="a06628a505fa3f1d90f1e43ad199c9222" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t CEGUI::XMLAttributes::getCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of attributes in the attribute block. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>value specifying the number of attributes in this attribute block. </dd></dl>
</div>
</div>
<a class="anchor" id="a75e4a74ff1ea386ed0b7ee0f5bbfcaad"></a><!-- doxytag: member="CEGUI::XMLAttributes::getName" ref="a75e4a74ff1ea386ed0b7ee0f5bbfcaad" args="(size_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::XMLAttributes::getName </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of an attribute based upon its index within the attribute block. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Nothing is specified about the order of elements within the attribute block. Elements may not, for example, appear in the order they were specified in the XML file.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>zero based index of the attribute whos name is to be returned.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the attribute at the requested index.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalRequestException</td><td>thrown if <em>index</em> is out of range for this attribute block. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a61c9c73f82c172ecb99536a1acfa6f9f"></a><!-- doxytag: member="CEGUI::XMLAttributes::getValue" ref="a61c9c73f82c172ecb99536a1acfa6f9f" args="(size_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::XMLAttributes::getValue </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value string of an attribute based upon its index within the attribute block. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Nothing is specified about the order of elements within the attribute block. Elements may not, for example, appear in the order they were specified in the XML file.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>zero based index of the attribute whos value string is to be returned.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the string value of the attribute at the requested index.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalRequestException</td><td>thrown if <em>index</em> is out of range for this attribute block. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1e51fb2eb6abcb095033a96c4c8f70b4"></a><!-- doxytag: member="CEGUI::XMLAttributes::getValue" ref="a1e51fb2eb6abcb095033a96c4c8f70b4" args="(const String &attrName) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::XMLAttributes::getValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>attrName</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value string for attribute <em>attrName</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">attrName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the attribute whos value string is to be returned</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object hilding the value string for attribute <em>attrName</em>.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>thrown if no attribute named <em>attrName</em> is present in the attribute block. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ace2d89aa21f97fe3ff2653145372851e"></a><!-- doxytag: member="CEGUI::XMLAttributes::getValueAsBool" ref="ace2d89aa21f97fe3ff2653145372851e" args="(const String &attrName, bool def=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::XMLAttributes::getValueAsBool </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>attrName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>def</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value of attribute <em>attrName</em> as a boolean value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">attrName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the attribute whos value is to be returned.</td></tr>
<tr><td class="paramname">def</td><td>bool value specifying the default value to be returned if <em>attrName</em> does not exist in the attribute block. For some parsers, defaults can be gotten from schemas and such like, though for others this may not be desired or possible, so this parameter is used to ensure a default is available in the abscence of other mechanisms.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>bool value equal to the value of attribute <em>attrName</em> if present, or <em>def</em> if not.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalRequestException</td><td>thrown if the attribute value string coul dnot be converted to the requested type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adb9355b9b0c4eac7387478f077fb8521"></a><!-- doxytag: member="CEGUI::XMLAttributes::getValueAsFloat" ref="adb9355b9b0c4eac7387478f077fb8521" args="(const String &attrName, float def=0.0f) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CEGUI::XMLAttributes::getValueAsFloat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>attrName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>def</em> = <code>0.0f</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value of attribute <em>attrName</em> as a floating point value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">attrName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the attribute whos value is to be returned.</td></tr>
<tr><td class="paramname">def</td><td>float value specifying the default value to be returned if <em>attrName</em> does not exist in the attribute block. For some parsers, defaults can be gotten from schemas and such like, though for others this may not be desired or possible, so this parameter is used to ensure a default is available in the abscence of other mechanisms.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>float value equal to the value of attribute <em>attrName</em> if present, or <em>def</em> if not.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalRequestException</td><td>thrown if the attribute value string coul dnot be converted to the requested type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaa56691c48a2ac7a14beda359fd0bda2"></a><!-- doxytag: member="CEGUI::XMLAttributes::getValueAsInteger" ref="aaa56691c48a2ac7a14beda359fd0bda2" args="(const String &attrName, int def=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CEGUI::XMLAttributes::getValueAsInteger </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>attrName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>def</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value of attribute <em>attrName</em> as a integer value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">attrName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the attribute whos value is to be returned.</td></tr>
<tr><td class="paramname">def</td><td>integer value specifying the default value to be returned if <em>attrName</em> does not exist in the attribute block. For some parsers, defaults can be gotten from schemas and such like, though for others this may not be desired or possible, so this parameter is used to ensure a default is available in the abscence of other mechanisms.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>integer value equal to the value of attribute <em>attrName</em> if present, or <em>def</em> if not.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalRequestException</td><td>thrown if the attribute value string coul dnot be converted to the requested type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a162595352a76f44f37d8ccad45c06986"></a><!-- doxytag: member="CEGUI::XMLAttributes::getValueAsString" ref="a162595352a76f44f37d8ccad45c06986" args="(const String &attrName, const String &def="") const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::XMLAttributes::getValueAsString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>attrName</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>def</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value of attribute <em>attrName</em> as a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">attrName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the attribute whos value is to be returned.</td></tr>
<tr><td class="paramname">def</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the default value to be returned if <em>attrName</em> does not exist in the attribute block. For some parsers, defaults can be gotten from schemas and such like, though for others this may not be desired or possible, so this parameter is used to ensure a default is available in the abscence of other mechanisms.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object containing the value of attribute <em>attrName</em> if present, or <em>def</em> if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a9a61a4969b96ea61eac198242c58d9e0"></a><!-- doxytag: member="CEGUI::XMLAttributes::remove" ref="a9a61a4969b96ea61eac198242c58d9e0" args="(const String &attrName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::XMLAttributes::remove </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>attrName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes an attribute from the attribute block. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">attrName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the attribute to be removed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </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>
|
