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
|
<!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: Layout 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">Layout 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 layout XML file defines a hierachy of window based objects to be created, with property and event binding information for each window.</p>
<h2><a class="anchor" id="xml_layout_contents"></a>
Layout Element List:</h2>
<p><a class="el" href="xml_layout.html#xml_layout_autowindow"><AutoWindow> Element</a> <br/>
<a class="el" href="xml_layout.html#xml_layout_event"><Event> Element</a> <br/>
<a class="el" href="xml_layout.html#xml_layout_guilayout"><GUILayout> Element</a> <br/>
<a class="el" href="xml_layout.html#xml_layout_layoutimport"><LayoutImport> Element</a> <br/>
<a class="el" href="xml_layout.html#xml_layout_property"><Property> Element</a> <br/>
<a class="el" href="xml_layout.html#xml_layout_window"><Window> Element</a> <br/>
</p>
<p><br/>
</p>
<h2><a class="anchor" id="xml_layout_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_layout_guilayout"></a>
<GUILayout> Element</h2>
<ul>
<li>Purpose:<ul>
<li><GUILayout> is the root element in layout XML files.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Parent:</code> Specifies the name of an existing window that root window of this gui layout should be attached to after loading the layout. Optional attribute, if this is not specified the root window is not automatically attached to any existing window.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <GUILayout> element is the root element for layout files.</li>
<li>The <GUILayout> element must contain a single <Window> element.</li>
<li>No element may contain a <GUILayout> element as a sub-element.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_layout_window"></a>
<Window> Element</h2>
<ul>
<li>Purpose:<ul>
<li>The <Window> element is used to specify a new window object to be created.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Type:</code> Specifies the type of window to be created. This may refer to a concrete window type, an alias, or a falagard mapped type. Required attribute.</li>
<li><code>Name:</code> Specifies the name to give the window. Window names must be unique within the system. Optional attribute, if the attribute is not specified a name will be generated automatically.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <Window> may appear as a sub-element of the following:<ul>
<li><GUILayout> elements.</li>
<li><Window> elements.</li>
<li><AutoWindow> elements.</li>
</ul>
</li>
<li>The <Window> element may contain the following sub-elements:<ul>
<li>Any number of <LayoutImport> elements. Followed by,</li>
<li>Any number of <Property> elements. Followed by,</li>
<li>Any number of <Event> elements. Followed by,</li>
<li>Any number of <Window> elements.</li>
<li>Any number of <AutoWindow> elements.</li>
<li>Finally, any number of <Property> elements (again).</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_layout_property"></a>
<Property> Element</h2>
<ul>
<li>Purpose:<ul>
<li>The <Property> element is used to set properties on the Window created by the containing <Window> element.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name of the property to set. Required attribute.</li>
<li><code>Value:</code> Specifies the value to set on the property. Optional attribute, if the attribute is not specified the value to be set should be given via the element text content.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <Property> may appear as a sub-element of <Window> elements and <AutoWindow> elements.</li>
<li>The <Property> element may not contain any sub-elements.</li>
<li>The <Property> element may contain text content to be used as the value.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_layout_event"></a>
<Event> Element</h2>
<ul>
<li>Purpose:<ul>
<li>The Event element is used to create bindings between GUI elements and script functions.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name of the event to which the handler function specified by the <code>Function</code> attribute will be subscribed. Required attribute.</li>
<li><code>Function:</code> Specifis the name of a script function to be subscribed to the event specified by the <code>Name</code> attribute. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <Event> may appear as a sub-element of <Window> elements and <AutoWindow> elements.</li>
<li>The <Event> 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_layout_layoutimport"></a>
<LayoutImport> Element</h2>
<ul>
<li>Purpose:<ul>
<li>The <LayoutImport> element is used to reference (import) a layout file into another. The root window of the imported layout is attached to the Window where the import occurrs.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Filename:</code> Specifies the path to the xml layout file to be imported. Required attribute.</li>
<li><code>Prefix:</code> Specifies a prefix that will be prepended to the window name of each window created from the imported layout. Optional attribute.</li>
<li><code>ResourceGroup:</code> Specifies the resource group identifier to pass to the ResourceProvider when loading the file given in the <code>Filename</code> attribute. Optional attribute, default is the WindowManager default group.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <LayoutImport> may appear as a sub-element of <Window> elements and <AutoWindow> elements.</li>
<li>The <LayoutImport> 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_layout_autowindow"></a>
<AutoWindow> Element</h2>
<ul>
<li>Purpose:<ul>
<li>The <AutoWindow> element is used to target property settings, events and other content on to an automatically created child window of the current Window (or AutoWindow).</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>NameSuffix:</code> Specifies the name suffix of the target auto-window. Required attribute.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <AutoWindow> may appear as a sub-element of the following:<ul>
<li><Window> elements.</li>
<li><AutoWindow> elements.</li>
</ul>
</li>
<li>The <AutoWindow> element may contain the following sub-elements:<ul>
<li>Any number of <LayoutImport> elements. Followed by,</li>
<li>Any number of <Property> elements. Followed by,</li>
<li>Any number of <Event> elements. Followed by,</li>
<li>Any number of <Window> elements.</li>
<li>Any number of <AutoWindow> elements.</li>
<li>Finally, any number of <Property> elements (again).</li>
</ul>
</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>
|
