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
|
<!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::PropertyInitialiser 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_1PropertyInitialiser.html">PropertyInitialiser</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::PropertyInitialiser Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::PropertyInitialiser" -->
<p>Class that holds information about a property and it's required initial value.
<a href="classCEGUI_1_1PropertyInitialiser.html#details">More...</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::PropertyInitialiser:</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_1PropertyInitialiser__coll__graph.gif" border="0" usemap="#CEGUI_1_1PropertyInitialiser_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1PropertyInitialiser_coll__map" id="CEGUI_1_1PropertyInitialiser_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="39,5,145,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1PropertyInitialiser-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_1PropertyInitialiser.html#ab4f99f969e65f330b91b22c86c14a49e">PropertyInitialiser</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &property, const <a class="el" href="classCEGUI_1_1String.html">String</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ab4f99f969e65f330b91b22c86c14a49e"></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_1PropertyInitialiser.html#a6878938d103d39b9d95fbc298eaca1ee">apply</a> (<a class="el" href="classCEGUI_1_1PropertySet.html">PropertySet</a> &target) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply this property initialiser to the specified target <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">CEGUI::PropertySet</a> object. <a href="#a6878938d103d39b9d95fbc298eaca1ee"></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_1PropertyInitialiser.html#add5961d04c9d09bf3415bfd8d08b7ae9">getTargetPropertyName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the property targetted by this <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a>. <a href="#add5961d04c9d09bf3415bfd8d08b7ae9"></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_1PropertyInitialiser.html#a834821fb8f20320013cdc22cb3cbed3b">getInitialiserValue</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value string to be set on the property targetted by this <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a>. <a href="#a834821fb8f20320013cdc22cb3cbed3b"></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_1PropertyInitialiser.html#a07f5bc79c9b3a07f42c7913e312f9d90">writeXMLToStream</a> (<a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> &xml_stream) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an xml representation of this <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a> to <em>out_stream</em>. <a href="#a07f5bc79c9b3a07f42c7913e312f9d90"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that holds information about a property and it's required initial value. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab4f99f969e65f330b91b22c86c14a49e"></a><!-- doxytag: member="CEGUI::PropertyInitialiser::PropertyInitialiser" ref="ab4f99f969e65f330b91b22c86c14a49e" args="(const String &property, const String &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::PropertyInitialiser::PropertyInitialiser </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>property</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>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">property</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 property targetted by this <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a>.</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> holding the value to be set by this <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6878938d103d39b9d95fbc298eaca1ee"></a><!-- doxytag: member="CEGUI::PropertyInitialiser::apply" ref="a6878938d103d39b9d95fbc298eaca1ee" args="(PropertySet &target) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PropertyInitialiser::apply </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1PropertySet.html">PropertySet</a> & </td>
<td class="paramname"><em>target</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Apply this property initialiser to the specified target <a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">CEGUI::PropertySet</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td><a class="el" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects.">CEGUI::PropertySet</a> object to be initialised by this <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a834821fb8f20320013cdc22cb3cbed3b"></a><!-- doxytag: member="CEGUI::PropertyInitialiser::getInitialiserValue" ref="a834821fb8f20320013cdc22cb3cbed3b" args="() 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::PropertyInitialiser::getInitialiserValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value string to be set on the property targetted by this <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a>. </p>
<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 value string. </dd></dl>
</div>
</div>
<a class="anchor" id="add5961d04c9d09bf3415bfd8d08b7ae9"></a><!-- doxytag: member="CEGUI::PropertyInitialiser::getTargetPropertyName" ref="add5961d04c9d09bf3415bfd8d08b7ae9" args="() 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::PropertyInitialiser::getTargetPropertyName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of the property targetted by this <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a>. </p>
<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 target property. </dd></dl>
</div>
</div>
<a class="anchor" id="a07f5bc79c9b3a07f42c7913e312f9d90"></a><!-- doxytag: member="CEGUI::PropertyInitialiser::writeXMLToStream" ref="a07f5bc79c9b3a07f42c7913e312f9d90" args="(XMLSerializer &xml_stream) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::PropertyInitialiser::writeXMLToStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLSerializer.html">XMLSerializer</a> & </td>
<td class="paramname"><em>xml_stream</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an xml representation of this <a class="el" href="classCEGUI_1_1PropertyInitialiser.html" title="Class that holds information about a property and it's required initial value.">PropertyInitialiser</a> to <em>out_stream</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">xml_stream</td><td>Stream where xml data should be output.</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:42 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>
|
