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
|
<!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::PropertySet 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_1PropertySet.html">PropertySet</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::PropertySet Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::PropertySet" --><!-- doxytag: inherits="CEGUI::PropertyReceiver" -->
<p>Class that contains a collection of <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> objects.
<a href="classCEGUI_1_1PropertySet.html#details">More...</a></p>
<p>Inherits <a class="el" href="classCEGUI_1_1PropertyReceiver.html">CEGUI::PropertyReceiver</a>.</p>
<p>Inherited by <a class="el" href="classCEGUI_1_1Font.html">CEGUI::Font</a>, <a class="el" href="classCEGUI_1_1Window.html">CEGUI::Window</a>, and <a class="el" href="classCEGUI_1_1XMLParser.html">CEGUI::XMLParser</a>.</p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Collaboration diagram for CEGUI::PropertySet:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1PropertySet__coll__graph.gif" border="0" usemap="#CEGUI_1_1PropertySet_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1PropertySet_coll__map" id="CEGUI_1_1PropertySet_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1PropertyReceiver.html" title="Dummy base class to ensure correct casting of receivers." alt="" coords="5,5,179,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1PropertySet-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14d68b24815fd3016a12f6e57d246582"></a><!-- doxytag: member="CEGUI::PropertySet::Iterator" ref="a14d68b24815fd3016a12f6e57d246582" args="" -->
typedef <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a><br class="typebreak"/>
< PropertyRegistry > </td><td class="memItemRight" valign="bottom"><b>Iterator</b></td></tr>
<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="a076d4e37d9cf01add4f6b475eb7aee72"></a><!-- doxytag: member="CEGUI::PropertySet::PropertySet" ref="a076d4e37d9cf01add4f6b475eb7aee72" args="(void)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertySet.html#a076d4e37d9cf01add4f6b475eb7aee72">PropertySet</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a> object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a608f2f7f34246b3366926efe5f5d8e71"></a><!-- doxytag: member="CEGUI::PropertySet::~PropertySet" ref="a608f2f7f34246b3366926efe5f5d8e71" args="(void)" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertySet.html#a608f2f7f34246b3366926efe5f5d8e71">~PropertySet</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertySet.html#a4dbead1690562c6129dcca224bfc645b">addProperty</a> (<a class="el" href="classCEGUI_1_1Property.html">Property</a> *property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a new <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. <a href="#a4dbead1690562c6129dcca224bfc645b"></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_1PropertySet.html#a108134a6f75f404e8597e3f98bce91c6">removeProperty</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> from the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. <a href="#a108134a6f75f404e8597e3f98bce91c6"></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_1PropertySet.html#a6b32fe7d4c4d1436ea3509ddd5016957">clearProperties</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes all <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> objects from the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. <a href="#a6b32fe7d4c4d1436ea3509ddd5016957"></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_1PropertySet.html#a9e934325c0524576b12fa471eeecf115">isPropertyPresent</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks to see if a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> with the given name is in the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. <a href="#a9e934325c0524576b12fa471eeecf115"></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_1PropertySet.html#afa3dccfd0ad418c3a39f3caffc2e43a0">getPropertyHelp</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the help text for the specified <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>. <a href="#afa3dccfd0ad418c3a39f3caffc2e43a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertySet.html#af7cfc649d1dbe40b42e7d4dea87888aa">getProperty</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the current value of the specified <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>. <a href="#af7cfc649d1dbe40b42e7d4dea87888aa"></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_1PropertySet.html#af6709b76d1e35c963e5d5c9b9111cdf7">setProperty</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">Sets the current value of a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>. <a href="#af6709b76d1e35c963e5d5c9b9111cdf7"></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_1PropertySet.html#a5cc995eb7c48a86e3cf2172a1ecc64fe">isPropertyDefault</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> is at it's default value. <a href="#a5cc995eb7c48a86e3cf2172a1ecc64fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertySet.html#a8a784e5db8376ca0c6a7acc78b2379fe">getPropertyDefault</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the default value of a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> as a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>. <a href="#a8a784e5db8376ca0c6a7acc78b2379fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84c7416afff8bacab96e04cc4e4682aa"></a><!-- doxytag: member="CEGUI::PropertySet::getIterator" ref="a84c7416afff8bacab96e04cc4e4682aa" args="(void) const " -->
<a class="el" href="classCEGUI_1_1ConstBaseIterator.html">Iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1PropertySet.html#a84c7416afff8bacab96e04cc4e4682aa">getIterator</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a PropertySet::Iterator object to iterate over the available Properties. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that contains a collection of <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> objects. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4dbead1690562c6129dcca224bfc645b"></a><!-- doxytag: member="CEGUI::PropertySet::addProperty" ref="a4dbead1690562c6129dcca224bfc645b" args="(Property *property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PropertySet::addProperty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Property.html">Property</a> * </td>
<td class="paramname"><em>property</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a new <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">property</td><td>Pointer to the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> object to be added to the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1NullObjectException.html" title="Exception class used when some required object or parameter is null.">NullObjectException</a></td><td>Thrown if <em>property</em> is NULL. </td></tr>
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1AlreadyExistsException.html" title="Exception class used when an attempt is made create a named object of a particular type when an objec...">AlreadyExistsException</a></td><td>Thrown if a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> with the same name as <em>property</em> already exists in the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6b32fe7d4c4d1436ea3509ddd5016957"></a><!-- doxytag: member="CEGUI::PropertySet::clearProperties" ref="a6b32fe7d4c4d1436ea3509ddd5016957" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PropertySet::clearProperties </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes all <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> objects from the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="af7cfc649d1dbe40b42e7d4dea87888aa"></a><!-- doxytag: member="CEGUI::PropertySet::getProperty" ref="af7cfc649d1dbe40b42e7d4dea87888aa" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1String.html">String</a> CEGUI::PropertySet::getProperty </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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the current value of the specified <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> who's value 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 containing a textual representation of the requested <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>.</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 <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> named <em>name</em> is in the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8a784e5db8376ca0c6a7acc78b2379fe"></a><!-- doxytag: member="CEGUI::PropertySet::getPropertyDefault" ref="a8a784e5db8376ca0c6a7acc78b2379fe" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1String.html">String</a> CEGUI::PropertySet::getPropertyDefault </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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the default value of a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> as a <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> who's default 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 containing a textual representation of the default value for this property. </dd></dl>
</div>
</div>
<a class="anchor" id="afa3dccfd0ad418c3a39f3caffc2e43a0"></a><!-- doxytag: member="CEGUI::PropertySet::getPropertyHelp" ref="afa3dccfd0ad418c3a39f3caffc2e43a0" args="(const String &name) 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::PropertySet::getPropertyHelp </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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the help text for the specified <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> holding the name of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> who's help text 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 containing the help text for the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> <em>name</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 <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> named <em>name</em> is in the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5cc995eb7c48a86e3cf2172a1ecc64fe"></a><!-- doxytag: member="CEGUI::PropertySet::isPropertyDefault" ref="a5cc995eb7c48a86e3cf2172a1ecc64fe" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::PropertySet::isPropertyDefault </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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> is at it's default value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> who's default state is to be tested.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the property has it's default value.</li>
<li>false if the property has been modified from it's default value. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a9e934325c0524576b12fa471eeecf115"></a><!-- doxytag: member="CEGUI::PropertySet::isPropertyPresent" ref="a9e934325c0524576b12fa471eeecf115" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::PropertySet::isPropertyPresent </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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks to see if a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> with the given name is in the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to check for.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> named <em>name</em> is in the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. false if no <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> named <em>name</em> is in the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a108134a6f75f404e8597e3f98bce91c6"></a><!-- doxytag: member="CEGUI::PropertySet::removeProperty" ref="a108134a6f75f404e8597e3f98bce91c6" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PropertySet::removeProperty </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>Removes a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> from the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> to be removed. If <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> <em>name</em> is not in the set, nothing happens.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="af6709b76d1e35c963e5d5c9b9111cdf7"></a><!-- doxytag: member="CEGUI::PropertySet::setProperty" ref="af6709b76d1e35c963e5d5c9b9111cdf7" args="(const String &name, const String &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PropertySet::setProperty </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>Sets the current value of a <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing the name of the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> who's value is to be set.</td></tr>
<tr><td class="paramname">value</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing a textual representation of the new value for the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing</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 <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> named <em>name</em> is in the <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">PropertySet</a>. </td></tr>
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>Thrown when the <a class="el" href="classCEGUI_1_1Property.html" title="An abstract class that defines the interface to access object properties by name.">Property</a> was unable to interpret the content of <em>value</em>. </td></tr>
</table>
</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>
|
