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
|
<!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::Scheme 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_1Scheme.html">Scheme</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">CEGUI::Scheme Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::Scheme" -->
<p>A class that groups a set of GUI elements and initialises the system to access those elements.
<a href="classCEGUI_1_1Scheme.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::Scheme:</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_1Scheme__coll__graph.gif" border="0" usemap="#CEGUI_1_1Scheme_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1Scheme_coll__map" id="CEGUI_1_1Scheme_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="12,5,119,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1Scheme-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>AliasMapping</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>FalagardMapping</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>LoadableUIElement</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>UIElementFactory</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>UIModule</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>WRModule</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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scheme.html#a1611c25071fea887e3ea63a193d5be80">loadResources</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads all resources for this scheme. <a href="#a1611c25071fea887e3ea63a193d5be80"></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_1Scheme.html#a1272f040f99d4e5a3636493980a49522">unloadResources</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unloads all resources for this scheme. This should be used very carefully. <a href="#a1272f040f99d4e5a3636493980a49522"></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_1Scheme.html#aa26c8f2a9d026aa2fa04f80a17adc7ce">resourcesLoaded</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the resources for this <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a> are all loaded. <a href="#aa26c8f2a9d026aa2fa04f80a17adc7ce"></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_1Scheme.html#af287b2fa06649656162226d25ebe2a04">getName</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of this <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a>. <a href="#af287b2fa06649656162226d25ebe2a04"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scheme.html#af7c5639149fc9c16f42e796a126c52b7">~Scheme</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys a <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a> object. <a href="#af7c5639149fc9c16f42e796a126c52b7"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scheme.html#aa58f15dff020c03efdaa8f209a10b391">getDefaultResourceGroup</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the default resource group currently set for Schemes. <a href="#aa58f15dff020c03efdaa8f209a10b391"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1Scheme.html#a89422b2073ea60c1496efba52a660179">setDefaultResourceGroup</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the default resource group to be used when loading scheme xml data. <a href="#a89422b2073ea60c1496efba52a660179"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abbe5e79fe6e099a5731984c4bc13f25a"></a><!-- doxytag: member="CEGUI::Scheme::Scheme_xmlHandler" ref="abbe5e79fe6e099a5731984c4bc13f25a" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Scheme_xmlHandler</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class that groups a set of GUI elements and initialises the system to access those elements. </p>
<p>A GUI <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a> is a high-level construct that loads and initialises various lower-level objects and registers them within the system for usage. So, for example, a <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a> might create some <a class="el" href="classCEGUI_1_1Imageset.html" title="Offers functions to define, access, and draw, a set of image components on a single graphical surface...">Imageset</a> objects, some <a class="el" href="classCEGUI_1_1Font.html" title="Class that encapsulates a typeface.">Font</a> objects, and register a collection of <a class="el" href="classCEGUI_1_1WindowFactory.html" title="Abstract class that defines the required interface for all WindowFactory objects.">WindowFactory</a> objects within the system which would then be in a state to serve those elements to client code. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af7c5639149fc9c16f42e796a126c52b7"></a><!-- doxytag: member="CEGUI::Scheme::~Scheme" ref="af7c5639149fc9c16f42e796a126c52b7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::Scheme::~Scheme </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroys a <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa58f15dff020c03efdaa8f209a10b391"></a><!-- doxytag: member="CEGUI::Scheme::getDefaultResourceGroup" ref="aa58f15dff020c03efdaa8f209a10b391" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::Scheme::getDefaultResourceGroup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the default resource group currently set for Schemes. </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> describing the default resource group identifier that will be used when loading <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a> xml file data. </dd></dl>
</div>
</div>
<a class="anchor" id="af287b2fa06649656162226d25ebe2a04"></a><!-- doxytag: member="CEGUI::Scheme::getName" ref="af287b2fa06649656162226d25ebe2a04" args="(void) 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::Scheme::getName </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of this <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</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 containing the name of this <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a1611c25071fea887e3ea63a193d5be80"></a><!-- doxytag: member="CEGUI::Scheme::loadResources" ref="a1611c25071fea887e3ea63a193d5be80" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Scheme::loadResources </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads all resources for this scheme. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="aa26c8f2a9d026aa2fa04f80a17adc7ce"></a><!-- doxytag: member="CEGUI::Scheme::resourcesLoaded" ref="aa26c8f2a9d026aa2fa04f80a17adc7ce" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::Scheme::resourcesLoaded </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 whether the resources for this <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a> are all loaded. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if all resources for the <a class="el" href="classCEGUI_1_1Scheme.html" title="A class that groups a set of GUI elements and initialises the system to access those elements...">Scheme</a> are loaded and available, or false of one or more resource is not currently loaded. </dd></dl>
</div>
</div>
<a class="anchor" id="a89422b2073ea60c1496efba52a660179"></a><!-- doxytag: member="CEGUI::Scheme::setDefaultResourceGroup" ref="a89422b2073ea60c1496efba52a660179" args="(const String &resourceGroup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CEGUI::Scheme::setDefaultResourceGroup </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>resourceGroup</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the default resource group to be used when loading scheme xml data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">resourceGroup</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> describing the default resource group identifier to be used.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
</div>
</div>
<a class="anchor" id="a1272f040f99d4e5a3636493980a49522"></a><!-- doxytag: member="CEGUI::Scheme::unloadResources" ref="a1272f040f99d4e5a3636493980a49522" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::Scheme::unloadResources </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unloads all resources for this scheme. This should be used very carefully. </p>
<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>
|
