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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
|
<!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 Configuration 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"><a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> Configuration 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 config XML file defines settings and configuration information used by <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> at system creation time.</p>
<h2><a class="anchor" id="xml_config_contents"></a>
Config Element List:</h2>
<p><a class="el" href="xml_config.html#xml_config_autoload"><AutoLoad></a> <br/>
<a class="el" href="xml_config.html#xml_config_ceguiconfig"><CEGUIConfig></a> <br/>
<a class="el" href="xml_config.html#xml_config_font"><DefaultFont></a> <br/>
<a class="el" href="xml_config.html#xml_config_guisheet"><DefaultGUISheet></a> <br/>
<a class="el" href="xml_config.html#xml_config_imagecodec"><DefaultImageCodec></a> <br/>
<a class="el" href="xml_config.html#xml_config_mousecursor"><DefaultMouseCursor></a> <br/>
<a class="el" href="xml_config.html#xml_config_defaultresourcegroup"><DefaultResourceGroup></a> <br/>
<a class="el" href="xml_config.html#xml_config_xmlparser"><DefaultXMLParser></a> <br/>
<a class="el" href="xml_config.html#xml_config_logging"><Logging></a> <br/>
<a class="el" href="xml_config.html#xml_config_resourcedirectory"><ResourceDirectory></a> <br/>
<a class="el" href="xml_config.html#xml_config_scripting"><Scripting></a> <br/>
<a class="el" href="xml_config.html#xml_config_tooltip"><DefaultTooltip></a> <br/>
</p>
<p><br/>
</p>
<h2><a class="anchor" id="xml_config_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_config_ceguiconfig"></a>
<CEGUIConfig></h2>
<ul>
<li>Purpose:<ul>
<li>The <CEGUIConfig> is the root element of a config file.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li>None.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <CEGUIConfig> is the root element for config file.</li>
<li>The <CEGUIConfig> may contain the following sub-elements:<ul>
<li><Logging> elements.</li>
<li><AutoLoad> elements.</li>
<li><ResourceDirectory> elements.</li>
<li><DefaultResourceGroup> elements.</li>
<li><Scripting> elements.</li>
<li><DefaultXMLParser> elements.</li>
<li><DefaultImageCodec> elements.</li>
<li><DefaultFont> elements.</li>
<li><DefaultMouseCursor> elements.</li>
<li><DefaultTooltip> elements.</li>
<li><DefaultGUISheet> elements.</li>
</ul>
</li>
<li>No element may contain <CEGUIConfig> as a sub-element.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_config_logging"></a>
<Logging></h2>
<ul>
<li>Purpose:<ul>
<li>Specifies the log filename and logging level to be used. If this element appears multiple times, the last occurence is the setting ultimately used.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>filename:</code> Specifies the name to use for the log file. Optional attribute, default is "CEGUI.log"</li>
<li><code>level:</code> Specifies the logging level. Optional attribute, default is "Standard". Must otherwise be set to one of the following:<ul>
<li>Errors</li>
<li>Standard</li>
<li>Informative</li>
<li>Insane</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <Logging> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <Logging> 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_config_autoload"></a>
<AutoLoad></h2>
<ul>
<li>Purpose:<ul>
<li>Specifies a batch of resources to be automatically loaded.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>type:</code> Specifies the type of resource to be loaded. Required attribute, must be one of the following values:<ul>
<li><code>Imageset</code> </li>
<li><code>Font</code> </li>
<li><code>Scheme</code> </li>
<li><code>LookNFeel</code> </li>
<li><code>Layout</code> </li>
</ul>
</li>
<li><code>group:</code> Specifies the resource group identifier to pass to the ResourceProvider when loading the files. Optional attribute, default is the default group for the resource type being loaded.</li>
<li><code>pattern:</code> Specifies a file name pattern that files in the resource group location will be matched against. Optional attribute, default is "*" (all files).</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <AutoLoad> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <AutoLoad> 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_config_resourcedirectory"></a>
<ResourceDirectory></h2>
<ul>
<li>Purpose:<ul>
<li>Specifies a resource group directory location. This is currently only used with automatically created instances of the DefaultResourceProvider, using this element with any other configuration will have no effect.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>group:</code> Specifies the name of the resource group to create. Required attribute.</li>
<li><code>directory:</code> Specifies the directory location to set for the created resource group. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <ResourceDirectory> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <ResourceDirectory> 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_config_defaultresourcegroup"></a>
<DefaultResourceGroup></h2>
<ul>
<li>Purpose:<ul>
<li>Sets the default resource group for a specified resource type.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>type:</code> Specifies the type of resource to set the default resource group for. Optional attribute, default is "Default" (global default group). If specified, must be one of:<ul>
<li><code>Default</code> </li>
<li><code>Imageset</code> </li>
<li><code>Font</code> </li>
<li><code>Scheme</code> </li>
<li><code>LookNFeel</code> </li>
<li><code>Layout</code> </li>
<li><code>Script</code> </li>
<li><code>XMLSchema</code> </li>
</ul>
</li>
<li><code>group:</code> Specifies the resource group identifier to use as the default group for the specified resource type. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <DefaultResourceGroup> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <DefaultResourceGroup> 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_config_scripting"></a>
<Scripting></h2>
<ul>
<li>Purpose:<ul>
<li>Specifies start up and shutdown scripts that will be automatically executed. Only works when a script module is in use. Scripts must be valid for the language in use! If this element appears multiple times, only the last occurence is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>initScript:</code> Specifies the name of the initialisation script. The script indicated will be called directly after the system object is constructed. Optional attribute, default is none.</li>
<li><code>terminateScript:</code> Specifies the name of the termination script. The script indicated will be called just prior to system destruction. Optional attribute, default is none.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <Scripting> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <Scripting> 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_config_xmlparser"></a>
<DefaultXMLParser></h2>
<ul>
<li>Purpose:<ul>
<li>Specifies the name of the default XMLParser module to use. Due to the config file being XML, we actually already have a parser loaded, this is a means of replacing that parser with some other module. If this element appears multiple times, only the last occurence is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>name:</code> Specifies the name of the XMLParser module to use. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <DefaultXMLParser> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <DefaultXMLParser> 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_config_imagecodec"></a>
<DefaultImageCodec></h2>
<ul>
<li>Purpose:<ul>
<li>Specifies the name of the default ImageCodec to use for loading image files. If this element appears multiple times, only the last occurence is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>name:</code> Specifies the name of the ImageCodec module to use. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <DefaultImageCodec> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <DefaultImageCodec> 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_config_font"></a>
<DefaultFont></h2>
<ul>
<li>Purpose:<ul>
<li>Sets the name of the system default font. If this element appears multiple times, only the last occurence is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>name:</code> Specifies the name of the font to be used as the default. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <DefaultFont> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <DefaultFont> 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_config_mousecursor"></a>
<DefaultMouseCursor></h2>
<ul>
<li>Purpose:<ul>
<li>Sets the system default mouse cursor image. If this element appears multiple times, only the last occurence is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>imageset:</code> Specifies the name of the Imageset containing the image to be used as the default mouse cursor. Required attribute.</li>
<li><code>image:</code> Specifies the name of the image in the imagset specified in the <code>imageset</code> attribute to be used as the default mouse cursor image. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <DefaultMouseCursor> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <DefaultMouseCursor> 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_config_tooltip"></a>
<DefaultTooltip></h2>
<ul>
<li>Purpose:<ul>
<li>Sets the window type name to use for the system default tool-tip. If this element appears multiple times, only the last occurence is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>name:</code> Specifies the type name of the Tooltip based window type to be used as the system default tooltip. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <DefaultTooltip> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <DefaultTooltip> 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_config_guisheet"></a>
<DefaultGUISheet></h2>
<ul>
<li>Purpose:<ul>
<li>Sets the initial gui sheet to the named window (the window must exist, so should be loaded via the <AutoLoad> element). If this element appears multiple times, only the last occurence is used.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>name:</code> Specifies the name of the window to be set as the initial gui sheet. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <DefaultGUISheet> element may only appear as a sub-element of the <CEGUIConfig> element.</li>
<li>The <DefaultGUISheet> element may not contain any 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>
|
