File: xml_confg.dox

package info (click to toggle)
cegui-mk2 0.8.7%2Bgit20220615-6
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 57,824 kB
  • sloc: cpp: 306,263; python: 1,175; ansic: 812; sh: 616; xml: 191; java: 162; makefile: 21
file content (296 lines) | stat: -rw-r--r-- 9,972 bytes parent folder | download | duplicates (6)
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
/**
@page xml_config CEGUI Configuration XML files.
@author Paul D Turner

A config XML file defines settings and configuration information used by CEGUI
at system creation time.

@section xml_config_contents Config Element List:
@ref xml_config_autoload <br>
@ref xml_config_ceguiconfig <br>
@ref xml_config_font <br>
@ref xml_config_guisheet <br>
@ref xml_config_imagecodec <br>
@ref xml_config_mousecursor <br>
@ref xml_config_defaultresourcegroup <br>
@ref xml_config_xmlparser <br>
@ref xml_config_logging <br>
@ref xml_config_resourcedirectory <br>
@ref xml_config_scripting <br>
@ref xml_config_tooltip <br>

<br>
@section xml_config_overview Overview
The reference for each element is arranged into sections, as described below:
- Purpose:
    - This section describes what the elements general purpose is within the
      specifications.

- Attributes:
    - This section describes available attributes for the elements, and whether
      they are required or optional.

- Usage:
    - Describes where the element may appear, whether the element may have
      sub-elements, and other important usage information.

- Examples:
    - For many elements, this section will contain brief examples showing the
      element used in context.


<br>
@section xml_config_ceguiconfig \<CEGUIConfig\>
- Purpose:
    - The \<CEGUIConfig\> is the root element of a config file.

- Attributes:
    - None.

- Usage:
    - The \<CEGUIConfig\> is the root element for config file.
    - The \<CEGUIConfig\> may contain the following sub-elements:
        - \<Logging\> elements.
        - \<AutoLoad\> elements.
        - \<ResourceDirectory\> elements.
        - \<DefaultResourceGroup\> elements.
        - \<Scripting\> elements.
        - \<DefaultXMLParser\> elements.
        - \<DefaultImageCodec\> elements.
        - \<DefaultFont\> elements.
        - \<DefaultMouseCursor\> elements.
        - \<DefaultTooltip\> elements.
        - \<DefaultGUISheet\> elements.
    - No element may contain \<CEGUIConfig\> as a sub-element.

- Examples:

<br>
@section xml_config_logging \<Logging\>
- Purpose:
    - Specifies the log filename and logging level to be used.  If this element
      appears multiple times, the last occurence is the setting ultimately used.

- Attributes:
    - @c filename: Specifies the name to use for the log file.
      Optional attribute, default is "CEGUI.log"
    - @c level: Specifies the logging level.  Optional attribute, default is
      "Standard".  Must otherwise be set to one of the following:
        - Errors
        - Standard
        - Informative
        - Insane

- Usage:
    - The \<Logging\> element may only appear as a sub-element of the
      \<CEGUIConfig\> element.
    - The \<Logging\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_autoload \<AutoLoad\>
- Purpose:
    - Specifies a batch of resources to be automatically loaded.

- Attributes:
    - @c type: Specifies the type of resource to be loaded.  Required attribute,
      must be one of the following values:
        - @c Imageset
        - @c Font
        - @c Scheme
        - @c LookNFeel
        - @c Layout
    - @c group: 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.
    - @c pattern: Specifies a file name pattern that files in the resource group
      location will be matched against.  Optional attribute,  default is "*"
      (all files).

- Usage:
    - The \<AutoLoad\> element may only appear as a sub-element of the
      \<CEGUIConfig\> element.
    - The \<AutoLoad\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_resourcedirectory \<ResourceDirectory\>
- Purpose:
    - 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.

- Attributes:
    - @c group: Specifies the name of the resource group to create.  Required
      attribute.
    - @c directory: Specifies the directory location to set for the created
      resource group.  Required attribute.

- Usage:
    - The \<ResourceDirectory\> element may only appear as a sub-element of the
      \<CEGUIConfig\> element.
    - The \<ResourceDirectory\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_defaultresourcegroup \<DefaultResourceGroup\>
- Purpose:
    - Sets the default resource group for a specified resource type.

- Attributes:
    - @c type: 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:
        - @c Default
        - @c Imageset
        - @c Font
        - @c Scheme
        - @c LookNFeel
        - @c Layout
        - @c Script
        - @c XMLSchema
    - @c group: Specifies the resource group identifier to use as the default
      group for the specified resource type.  Required attribute.

- Usage:
    - The \<DefaultResourceGroup\> element may only appear as a sub-element of
      the \<CEGUIConfig\> element.
    - The \<DefaultResourceGroup\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_scripting \<Scripting\>
- Purpose:
    - 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.

- Attributes:
    - @c initScript: 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.
    - @c terminateScript: Specifies the name of the termination script.  The
      script indicated will be called just prior to system destruction.
      Optional attribute, default is none.

- Usage:
    - The \<Scripting\> element may only appear as a sub-element of
      the \<CEGUIConfig\> element.
    - The \<Scripting\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_xmlparser \<DefaultXMLParser\>
- Purpose:
    - 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.

- Attributes:
    - @c name: Specifies the name of the XMLParser module to use.  Required
      attribute.

- Usage:
    - The \<DefaultXMLParser\> element may only appear as a sub-element of
      the \<CEGUIConfig\> element.
    - The \<DefaultXMLParser\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_imagecodec \<DefaultImageCodec\>
- Purpose:
    - 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.

- Attributes:
    - @c name: Specifies the name of the ImageCodec module to use.  Required
      attribute.

- Usage:
    - The \<DefaultImageCodec\> element may only appear as a sub-element of
      the \<CEGUIConfig\> element.
    - The \<DefaultImageCodec\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_font \<DefaultFont\>
- Purpose:
    - Sets the name of the system default font.  If this element appears
      multiple times, only the last occurence is used.

- Attributes:
    - @c name: Specifies the name of the font to be used as the default.
      Required attribute.

- Usage:
    - The \<DefaultFont\> element may only appear as a sub-element of
      the \<CEGUIConfig\> element.
    - The \<DefaultFont\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_mousecursor \<DefaultMouseCursor\>
- Purpose:
    - Sets the system default mouse cursor image.  If this element appears
      multiple times, only the last occurence is used.

- Attributes:
    - @c imageset: Specifies the name of the Imageset containing the image to
      be used as the default mouse cursor.  Required attribute.
    - @c image: Specifies the name of the image in the imagset specified in
      the @c imageset attribute to be used as the default mouse cursor image.
      Required attribute.

- Usage:
    - The \<DefaultMouseCursor\> element may only appear as a sub-element of
      the \<CEGUIConfig\> element.
    - The \<DefaultMouseCursor\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_tooltip \<DefaultTooltip\>
- Purpose:
    - 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.

- Attributes:
    - @c name: Specifies the type name of the Tooltip based window type to be
      used as the system default tooltip.  Required attribute.

- Usage:
    - The \<DefaultTooltip\> element may only appear as a sub-element of
      the \<CEGUIConfig\> element.
    - The \<DefaultTooltip\> element may not contain any sub-elements.

- Examples:

<br>
@section xml_config_guisheet \<DefaultGUISheet\>
- Purpose:
    - 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.

- Attributes:
    - @c name: Specifies the name of the window to be set as the initial gui
      sheet.  Required attribute.

- Usage:
    - The \<DefaultGUISheet\> element may only appear as a sub-element of
      the \<CEGUIConfig\> element.
    - The \<DefaultGUISheet\> element may not contain any sub-elements.

- Examples:
*/