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
|
<!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: Scheme XML files.</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 class="current"><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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Scheme XML files. </div> </div>
</div>
<div class="contents">
<div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>Paul D Turner</dd></dl>
<p>A Scheme file is a largely means to group other data files and resources together, and to define some of their interactions, and form a single point to load what might be considered a 'skin' for CEGUI's windows and widgets.</p>
<h2><a class="anchor" id="xml_scheme_contents"></a>
Scheme Element List:</h2>
<p><a class="el" href="xml_scheme.html#xml_scheme_falagardmapping"><FalagardMapping> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_font"><Font> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_guischeme"><GUIScheme> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_imageset"><Imageset> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_imagesetfromimage"><ImagesetFromImage> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_looknfeel"><LookNFeel> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_windowalias"><WindowAlias> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_windowfactory"><WindowFactory> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_windowrendererfactory"><WindowRendererFactory> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_windowrendererset"><WindowRendererSet> Element</a> <br/>
<a class="el" href="xml_scheme.html#xml_scheme_windowset"><WindowSet> Element</a> <br/>
</p>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_overview"></a>
Overview</h2>
<p>The reference for each element is arranged into sections, as described below:</p>
<ul>
<li>Purpose:<ul>
<li>This section describes what the elements general purpose is within the specifications.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li>This section describes available attributes for the elements, and whether they are required or optional.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>Describes where the element may appear, whether the element may have sub-elements, and other important usage information.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:<ul>
<li>For many elements, this section will contain brief examples showing the element used in context.</li>
</ul>
</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_guischeme"></a>
<GUIScheme> Element</h2>
<ul>
<li>Purpose:<ul>
<li>The <GUIScheme> element is the root element of the scheme file.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name that the scheme will be known by within the system. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <GUIScheme> element is the root element for scheme files.</li>
<li>The <GUIScheme> element may contain the following sub-elements (in any sequence):<ul>
<li>Any number of <Imageset> elements.</li>
<li>Any number of <ImagesetFromImage> elements.</li>
<li>Any number of <Font> elements.</li>
<li>Any number of <LookNFeel> elements.</li>
<li>Any number of <WindowSet> elements.</li>
<li>Any number of <WindowRendererSet> elements.</li>
<li>Any number of <WindowAlias> elements.</li>
<li>Any number of <FalagardMapping> elements.</li>
</ul>
</li>
<li>No element may contain a <GUIScheme> element as a sub-element.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_falagardmapping"></a>
<FalagardMapping> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies a mapping that ties together a concrete <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">CEGUI::Window</a> based object, a concrete <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">CEGUI::WindowRenderer</a> based object, and a WidgetLook definition to create a specified window type that can then be instantiated via the <a class="el" href="classCEGUI_1_1WindowManager.html" title="The WindowManager class describes an object that manages creation and lifetime of Window objects...">CEGUI::WindowManager</a>.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>WindowType:</code> Specifies a name for the mapping / window type being created. Required attribute.</li>
<li><code>TargetType:</code> Specifies the name of the concrete <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">CEGUI::Window</a> based object that contains the logic for the window type being specified. Required attribute.</li>
<li><code>Renderer:</code> Specifies the name of the concrete <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">CEGUI::WindowRenderer</a> based object that contains the rendering specific code for the window type being specified. Required attribute.</li>
<li><code>LookNFeel:</code> Specifies the name of the Falagard WidgetLook definition that contains imagery and other definitions for the window type being specified. Required attribute.</li>
<li><code>RenderEffect:</code> Specifies the name of a registered RenderEffect of which an instance will be created to be associated with each created window of WindowType. As the use of a RenderEffect requires an underlying RenderingWindow, if this is not automaticaly created by the TargetType, Renderer or LookNFeel the AutoRenderingSurface will be enabled prior to creating and assigning the RenderEffect. If the specified RenderEffect is not registered with the system when instantiation of TargetType is attempted, creation will not fail solely for lack of the effect - rather the window will be created with no effect set (the missing RenderEffect will be logged). Optional attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <FalagardMapping> element may only appear as a sub-element of the <GUIScheme> element.</li>
<li>The <FalagardMapping> element may not contain any sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_font"></a>
<Font> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies a Font to be loaded as part of the scheme. If a font with the requested name already exists, the file specified is not loaded.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name of the font as specified in the font xml file. This is a validation check; if this name is specified it <em>must</em> match the name given in the font xml file or an exception will be thrown. If this name is not given, the name is extracted from the font xml the first time it is loaded. Optional attibute.</li>
<li><code>Filename:</code> Specifies the path to the font XML file. Required attribute.</li>
<li><code>ResourceGroup:</code> Specifies the resource group identifier to pass to the ResourceProvider when loading the file specified in the <code>Filename</code> attribute. Optional attribute, if this is not specified the default resource group for Font files is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <Font> element may only appear as a sub-element of the <GUIScheme> element.</li>
<li>The <Font> element may not contain any sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_imageset"></a>
<Imageset> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies an imageset to be loaded as part of this scheme. If an imageset with the requested name already exists, the file specified is not loaded.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name of the imageset as specified in the imagseset xml file. This is a validation check; if this name is specified it <em>must</em> match the name given in the imageset xml file or an exception will be thrown. If this name is not given, the name is extracted from the imageset the first time it is loaded. Optional attibute.</li>
<li><code>Filename:</code> Specifies the path to the imageset XML file. Required attribute.</li>
<li><code>ResourceGroup:</code> Specifies the resource group identifier to pass to the ResourceProvider when loading the file specified in the <code>Filename</code> attribute. Optional attribute, if this is not specified the default resource group for Imageset files is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <Imageset> element may only appear as a sub-element of the <GUIScheme> element.</li>
<li>The <Imageset> element may not contain any sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_imagesetfromimage"></a>
<ImagesetFromImage> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies an imageset to be created directly from an image file as part of this scheme. If an imageset with the requested name already exists, the file specified is not loaded.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name to be used for the imageset. If this attribute is not given, the imageset is given the name of it's file. Optional attibute.</li>
<li><code>Filename:</code> Specifies the path to the image file that will be loaded for this imageset (also used as the name of the Imageset if the <code>Name</code> attribute is not given). Required attribute.</li>
<li><code>ResourceGroup:</code> Specifies the resource group identifier to pass to the ResourceProvider when loading the file specified in the <code>Filename</code> attribute. Optional attribute, if this is not specified the default resource group for Imageset files is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <ImagesetFromImage> element may only appear as a sub-element of the <GUIScheme> element.</li>
<li>The <ImagesetFromImage> element may not contain any sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_looknfeel"></a>
<LookNFeel> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies a LookNFeel file - containing WidgetLook definitions - to be parsed as part of this scheme.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Filename:</code> Specifies the path to the looknfeel xml file that will be parsed. Required attribute.</li>
<li><code>ResourceGroup:</code> Specifies the resource group identifier to pass to the ResourceProvider when loading the file specified in the <code>Filename</code> attribute. Optional attribute, if this is not specified the default resource group for LookNFeel files is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <LookNFeel> element may only appear as a sub-element of the <GUIScheme> element.</li>
<li>The <LookNFeel> element may not contain any sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_windowalias"></a>
<WindowAlias> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies an alias for a given window type.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Alias:</code> Specifies the name of the alias; this is an alternative name by which the window type specified by the <code>Target</code> attribute will be known.</li>
<li><code>Target:</code> Specifies the window type that will be created when a window of the type specified by the attribute <code>Alias</code> is specified.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <WindowAlias> element may only appear as a sub-element of the <GUIScheme> element.</li>
<li>The <WindowAlias> element may not contain any sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_windowfactory"></a>
<WindowFactory> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies the name of a WindowFactory object from the loadable module represented by the containing <WindowSet> that is to be registered with the system.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name of the WindowFactory object to be registered with the system. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <WindowFactory> element may only appear as a sub-element of the <WindowSet> element.</li>
<li>The <WindowFactory> element may not contain any sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_windowrendererfactory"></a>
<WindowRendererFactory> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies the name of a WindowRendererFactory object from the loadable module represented by the containing <WindowRendererSet> that is to be registered with the system.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name of the WindowRendererFactory object to be registered with the system. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <WindowRendererFactory> element may only appear as a sub-element of the <WindowRendererSet> element.</li>
<li>The <WindowRendererFactory> element may not contain any sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_windowrendererset"></a>
<WindowRendererSet> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies the name of a loadable module containing concrete <a class="el" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object.">CEGUI::WindowRenderer</a> based entities and their factories. If one or more <WindowRendererFactory> elements are given, only the specified factories will be registered with the system; if no <WindowRendererFactory> elements are specified, all available factories from the module will be registered.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Filename:</code> Specifies the name of the loadable module (dll / .so / etc). Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <WindowRendererSet> element may only appear as a sub-element of the <GUIScheme> element.</li>
<li>The <WindowRendererSet> element may not any number of <WindowRendererFactory> sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_scheme_windowset"></a>
<WindowSet> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Specifies the name of a loadable module containing concrete <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">CEGUI::Window</a> based entities and their factories. If one or more <WindowFactory> elements are given, only the specified factories will be registered with the system; if no <WindowFactory> elements are specified, all available factories from the module will be registered.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Filename:</code> Specifies the name of the loadable module (dll / .so / etc). Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <WindowSet> element may only appear as a sub-element of the <GUIScheme> element.</li>
<li>The <WindowSet> element may not any number of <WindowFactory> sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples: </li>
</ul>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 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>
|
