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
|
<!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: CEGUIScheme.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CEGUIScheme.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> filename: CEGUIScheme.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: 21/2/2004</span>
<a name="l00004"></a>00004 <span class="comment"> author: Paul D Turner</span>
<a name="l00005"></a>00005 <span class="comment"> </span>
<a name="l00006"></a>00006 <span class="comment"> purpose: Defines abstract base class for the GUI Scheme object.</span>
<a name="l00007"></a>00007 <span class="comment">*************************************************************************/</span>
<a name="l00008"></a>00008 <span class="comment">/***************************************************************************</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00012"></a>00012 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00013"></a>00013 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00014"></a>00014 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00015"></a>00015 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00016"></a>00016 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00017"></a>00017 <span class="comment"> * the following conditions:</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00020"></a>00020 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00023"></a>00023 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00024"></a>00024 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00025"></a>00025 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00026"></a>00026 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00027"></a>00027 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00028"></a>00028 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00029"></a>00029 <span class="comment"> ***************************************************************************/</span>
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef _CEGUIScheme_h_</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIScheme_h_</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "CEGUIBase.h"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "CEGUIString.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "CEGUISchemeManager.h"</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="preprocessor">#include <vector></span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(push)</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(disable : 4251)</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00048"></a>00048 <span class="keyword">namespace </span>CEGUI
<a name="l00049"></a>00049 {
<a name="l00059"></a><a class="code" href="classCEGUI_1_1Scheme.html">00059</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" 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 name="l00060"></a>00060 {
<a name="l00061"></a>00061 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classCEGUI_1_1Scheme__xmlHandler.html" title="Handler class used to parse the Scheme XML files using SAX2.">Scheme_xmlHandler</a>;
<a name="l00062"></a>00062 <span class="keyword">public</span>:
<a name="l00070"></a>00070 <span class="keywordtype">void</span> loadResources(<span class="keywordtype">void</span>);
<a name="l00071"></a>00071
<a name="l00072"></a>00072
<a name="l00080"></a>00080 <span class="keywordtype">void</span> unloadResources(<span class="keywordtype">void</span>);
<a name="l00081"></a>00081
<a name="l00082"></a>00082
<a name="l00090"></a>00090 <span class="keywordtype">bool</span> resourcesLoaded(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00091"></a>00091
<a name="l00092"></a>00092
<a name="l00100"></a><a class="code" href="classCEGUI_1_1Scheme.html#af287b2fa06649656162226d25ebe2a04">00100</a> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& <a class="code" href="classCEGUI_1_1Scheme.html#af287b2fa06649656162226d25ebe2a04" title="Return the name of this Scheme.">getName</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{<span class="keywordflow">return</span> d_name;}
<a name="l00101"></a>00101
<a name="l00110"></a><a class="code" href="classCEGUI_1_1Scheme.html#aa58f15dff020c03efdaa8f209a10b391">00110</a> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& getDefaultResourceGroup()
<a name="l00111"></a>00111 { <span class="keywordflow">return</span> d_defaultResourceGroup; }
<a name="l00112"></a>00112
<a name="l00123"></a><a class="code" href="classCEGUI_1_1Scheme.html#a89422b2073ea60c1496efba52a660179">00123</a> <span class="keyword">static</span> <span class="keywordtype">void</span> setDefaultResourceGroup(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& resourceGroup)
<a name="l00124"></a>00124 { d_defaultResourceGroup = resourceGroup; }
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="keyword">private</span>:
<a name="l00127"></a>00127 <span class="comment">/*************************************************************************</span>
<a name="l00128"></a>00128 <span class="comment"> Construction and Destruction</span>
<a name="l00129"></a>00129 <span class="comment"> *************************************************************************/</span>
<a name="l00137"></a>00137 <a class="code" 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>(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name);
<a name="l00138"></a>00138
<a name="l00143"></a>00143 <span class="keywordtype">void</span> loadXMLImagesets();
<a name="l00144"></a>00144
<a name="l00149"></a>00149 <span class="keywordtype">void</span> loadImageFileImagesets();
<a name="l00150"></a>00150
<a name="l00155"></a>00155 <span class="keywordtype">void</span> loadFonts();
<a name="l00156"></a>00156
<a name="l00161"></a>00161 <span class="keywordtype">void</span> loadLookNFeels();
<a name="l00162"></a>00162
<a name="l00167"></a>00167 <span class="keywordtype">void</span> loadWindowFactories();
<a name="l00168"></a>00168
<a name="l00173"></a>00173 <span class="keywordtype">void</span> loadWindowRendererFactories();
<a name="l00174"></a>00174
<a name="l00179"></a>00179 <span class="keywordtype">void</span> loadFactoryAliases();
<a name="l00180"></a>00180
<a name="l00185"></a>00185 <span class="keywordtype">void</span> loadFalagardMappings();
<a name="l00186"></a>00186
<a name="l00191"></a>00191 <span class="keywordtype">void</span> unloadXMLImagesets();
<a name="l00192"></a>00192
<a name="l00197"></a>00197 <span class="keywordtype">void</span> unloadImageFileImagesets();
<a name="l00198"></a>00198
<a name="l00203"></a>00203 <span class="keywordtype">void</span> unloadFonts();
<a name="l00204"></a>00204
<a name="l00209"></a>00209 <span class="keywordtype">void</span> unloadLookNFeels();
<a name="l00210"></a>00210
<a name="l00215"></a>00215 <span class="keywordtype">void</span> unloadWindowFactories();
<a name="l00216"></a>00216
<a name="l00221"></a>00221 <span class="keywordtype">void</span> unloadWindowRendererFactories();
<a name="l00222"></a>00222
<a name="l00227"></a>00227 <span class="keywordtype">void</span> unloadFactoryAliases();
<a name="l00228"></a>00228
<a name="l00233"></a>00233 <span class="keywordtype">void</span> unloadFalagardMappings();
<a name="l00234"></a>00234
<a name="l00239"></a>00239 <span class="keywordtype">bool</span> areXMLImagesetsLoaded() <span class="keyword">const</span>;
<a name="l00240"></a>00240
<a name="l00245"></a>00245 <span class="keywordtype">bool</span> areImageFileImagesetsLoaded() <span class="keyword">const</span>;
<a name="l00246"></a>00246
<a name="l00251"></a>00251 <span class="keywordtype">bool</span> areFontsLoaded() <span class="keyword">const</span>;
<a name="l00252"></a>00252
<a name="l00257"></a>00257 <span class="keywordtype">bool</span> areLookNFeelsLoaded() <span class="keyword">const</span>;
<a name="l00258"></a>00258
<a name="l00263"></a>00263 <span class="keywordtype">bool</span> areWindowFactoriesLoaded() <span class="keyword">const</span>;
<a name="l00264"></a>00264
<a name="l00269"></a>00269 <span class="keywordtype">bool</span> areWindowRendererFactoriesLoaded() <span class="keyword">const</span>;
<a name="l00270"></a>00270
<a name="l00275"></a>00275 <span class="keywordtype">bool</span> areFactoryAliasesLoaded() <span class="keyword">const</span>;
<a name="l00276"></a>00276
<a name="l00281"></a>00281 <span class="keywordtype">bool</span> areFalagardMappingsLoaded() <span class="keyword">const</span>;
<a name="l00282"></a>00282
<a name="l00283"></a>00283 <span class="keyword">public</span>: <span class="comment">// for luabind compatibility</span>
<a name="l00291"></a>00291 <span class="comment"></span> ~<a class="code" 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>(<span class="keywordtype">void</span>);
<a name="l00292"></a>00292
<a name="l00293"></a>00293
<a name="l00294"></a>00294 <span class="keyword">private</span>:
<a name="l00295"></a>00295 <span class="comment">/*************************************************************************</span>
<a name="l00296"></a>00296 <span class="comment"> Structs used to hold scheme information</span>
<a name="l00297"></a>00297 <span class="comment"> *************************************************************************/</span>
<a name="l00298"></a>00298 <span class="keyword">struct </span>LoadableUIElement
<a name="l00299"></a>00299 {
<a name="l00300"></a>00300 <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> name;
<a name="l00301"></a>00301 <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> filename;
<a name="l00302"></a>00302 <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> resourceGroup;
<a name="l00303"></a>00303 };
<a name="l00304"></a>00304
<a name="l00305"></a>00305 <span class="keyword">struct </span>UIElementFactory
<a name="l00306"></a>00306 {
<a name="l00307"></a>00307 String name;
<a name="l00308"></a>00308 };
<a name="l00309"></a>00309
<a name="l00310"></a>00310 <span class="keyword">struct </span>UIModule
<a name="l00311"></a>00311 {
<a name="l00312"></a>00312 String name;
<a name="l00313"></a>00313 FactoryModule* module;
<a name="l00314"></a>00314 std::vector<UIElementFactory> factories;
<a name="l00315"></a>00315 };
<a name="l00316"></a>00316
<a name="l00317"></a>00317 <span class="keyword">struct </span>WRModule
<a name="l00318"></a>00318 {
<a name="l00319"></a>00319 String name;
<a name="l00320"></a>00320 DynamicModule* dynamicModule;
<a name="l00321"></a>00321 WindowRendererModule* wrModule;
<a name="l00322"></a>00322 std::vector<String> wrTypes;
<a name="l00323"></a>00323 };
<a name="l00324"></a>00324
<a name="l00325"></a>00325 <span class="keyword">struct </span>AliasMapping
<a name="l00326"></a>00326 {
<a name="l00327"></a>00327 String aliasName;
<a name="l00328"></a>00328 String targetName;
<a name="l00329"></a>00329 };
<a name="l00330"></a>00330
<a name="l00331"></a>00331 <span class="keyword">struct </span>FalagardMapping
<a name="l00332"></a>00332 {
<a name="l00333"></a>00333 String windowName;
<a name="l00334"></a>00334 String targetName;
<a name="l00335"></a>00335 String rendererName;
<a name="l00336"></a>00336 String lookName;
<a name="l00337"></a>00337 String effectName;
<a name="l00338"></a>00338 };
<a name="l00339"></a>00339
<a name="l00340"></a>00340 <span class="comment">/*************************************************************************</span>
<a name="l00341"></a>00341 <span class="comment"> Implementation Data</span>
<a name="l00342"></a>00342 <span class="comment"> *************************************************************************/</span>
<a name="l00343"></a>00343 String d_name;
<a name="l00344"></a>00344
<a name="l00345"></a>00345 std::vector<LoadableUIElement> d_imagesets;
<a name="l00346"></a>00346 std::vector<LoadableUIElement> d_imagesetsFromImages;
<a name="l00347"></a>00347 std::vector<LoadableUIElement> d_fonts;
<a name="l00348"></a>00348 std::vector<UIModule> d_widgetModules;
<a name="l00349"></a>00349 std::vector<WRModule> d_windowRendererModules;
<a name="l00350"></a>00350 std::vector<AliasMapping> d_aliasMappings;
<a name="l00351"></a>00351 std::vector<LoadableUIElement> d_looknfeels;
<a name="l00352"></a>00352 std::vector<FalagardMapping> d_falagardMappings;
<a name="l00353"></a>00353
<a name="l00354"></a>00354 <span class="keyword">static</span> String d_defaultResourceGroup;
<a name="l00355"></a>00355 };
<a name="l00356"></a>00356
<a name="l00357"></a>00357 } <span class="comment">// End of CEGUI namespace section</span>
<a name="l00358"></a>00358
<a name="l00359"></a>00359 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00360"></a>00360 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(pop)</span>
<a name="l00361"></a>00361 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00362"></a>00362 <span class="preprocessor"></span>
<a name="l00363"></a>00363 <span class="preprocessor">#endif // end of guard _CEGUIScheme_h_</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:39 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>
|
