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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
|
<!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: Falagard XML Element Reference</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="fal_man.html">Falagard skinning system for CEGUI</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Falagard XML Element Reference </div> </div>
</div>
<div class="contents">
<div class="textblock"><p>The following pages contain reference material for the XML elements defined for the Falagard skin definition files.</p>
<h2><a class="anchor" id="fal_elem_ref_sec_0"></a>
Section Contents</h2>
<p><a class="el" href="fal_element_ref.html#fal_elem_ref_sec_1">Overview</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_2"><AbsoluteDim> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_3"><Area> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_4"><AreaProperty> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_5"><Child> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_6"><ColourProperty> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_7"><ColourRectProperty> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_8"><Colours> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_9"><Dim> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_10"><DimOperator> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_11"><Falagard> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_12"><FontDim> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_13"><FontProperty> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_14"><FrameComponent> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_15"><HorzAlignment> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_16"><HorzFormat> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_17"><HorzFormatProperty> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_18"><Image> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_19"><ImageDim> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_20"><ImageryComponent> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_21"><ImageProperty> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_22"><ImagerySection> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_23"><Layer> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_24"><NamedArea> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_25"><Property> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_26"><PropertyDefinition> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_27"><PropertyLinkDefinition> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_propertylinktarget"><PropertyLinkTarget> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_28"><PropertyDim> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_29"><Section> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_30"><StateImagery> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_31"><Text> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_32"><TextComponent> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_33"><TextProperty> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_34"><UnifiedDim> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_35"><VertAlignment> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_36"><VertFormat> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_37"><VertFormatProperty> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_38"><WidgetDim> Element</a> <br/>
<a class="el" href="fal_element_ref.html#fal_elem_ref_sec_39"><WidgetLook> Element</a> <br/>
</p>
<h2><a class="anchor" id="fal_elem_ref_sec_1"></a>
Overview</h2>
<p>The reference for each element is arranged into sections, as described below:</p>
<h3><a class="anchor" id="fal_elem_ref_sec_1_1"></a>
Purpose:</h3>
<p>This section describes what the elements general purpose is within the specifications.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_1_2"></a>
Attributes:</h3>
<p>This section describes available attributes for the elements, and whether they are required or optional.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_1_3"></a>
Usage:</h3>
<p>Describes where the element may appear, whether the element may have sub-elements, and other important usage information.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_1_4"></a>
Examples:</h3>
<p>For many elements, this section will contain brief examples showing the element used in context.</p>
<h2><a class="anchor" id="fal_elem_ref_sec_2"></a>
<AbsoluteDim> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_2_1"></a>
Purpose:</h3>
<p>The <code><AbsoluteDim></code> element is used to define a component dimension for an area rectangle. <code><AbsoluteDim></code> is used to specify absolute pixel values for a dimension.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_2_2"></a>
Attributes:</h3>
<ul>
<li><code>value</code> specifies the a number of pixels. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_2_3"></a>
Usage:</h3>
<ul>
<li>The <code><AbsoluteDim></code> element may contain a single <code><DimOperator></code> element in order to form a dimension calculation. </li>
<li>The <code><AbsoluteDim></code> element can appear as a sub-element in <code><Dim></code> to form a dimension specification for an area. </li>
<li>The <code><AbsoluteDim></code> element can appear as a sub-element of <code><DimOperator></code> to specify the second operand for a dimension calculation.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_2_4"></a>
Examples:</h3>
<p>The following shows <code><AbsoluteDim></code> used to define an area rectangle. In the example, all four component dimensions of the area rectangle are specified using <code><AbsoluteDim></code>: </p>
<div class="fragment"><pre class="fragment"><Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> >
<AbsoluteDim value=<span class="stringliteral">"10"</span> />
</Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> >
<AbsoluteDim value=<span class="stringliteral">"50"</span> />
</Dim>
<Dim type=<span class="stringliteral">"Width"</span> >
<AbsoluteDim value=<span class="stringliteral">"290"</span> />
</Dim>
<Dim type=<span class="stringliteral">"Height"</span> >
<AbsoluteDim value=<span class="stringliteral">"250"</span> />
</Dim>
</Area>
</pre></div><p>The following shows <code><AbsoluteDim></code> in use as part of a dimension calculation sequence. In the example the left edge is being set to the width of the child widget 'myWidget' minus two pixels: </p>
<div class="fragment"><pre class="fragment"><Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> >
<WidgetDim widget=<span class="stringliteral">"myWidget"</span> dimension=<span class="stringliteral">"Width"</span> >
<DimOperator op=<span class="stringliteral">"Subtract"</span> >
<AbsoluteDim value=<span class="stringliteral">"2"</span> />
</DimOperator>
</WidgetDim>
</Dim>
...
</Area>
</pre></div><p>Finally, we see <code><AbsoluteDim></code> as the starting dimension for a dimension calculation sequence. In the example, we are adding the value of some window property to the starting absolute value of six: </p>
<div class="fragment"><pre class="fragment"><Area>
...
<Dim type=<span class="stringliteral">"Height"</span> >
<AbsoluteDim value=<span class="stringliteral">"6"</span>>
<DimOperator op=<span class="stringliteral">"Add"</span> >
<PropertyDim name=<span class="stringliteral">"someHeightProperty"</span> />
</DimOperator>
</AbsoluteDim>
</Dim>
</Area>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_3"></a>
<Area> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_3_1"></a>
Purpose:</h3>
<p>The <code><Area></code> element is a simple container element for the <code><Dim></code> dimension elements, or a single <code><AreaProperty></code> element, in order to form a rectangular area. <code><Area></code> is generally used to define target regions which are to be used for rendering imagery, text, to place a component child widget, or to form 'named' areas required by the base widget.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_3_2"></a>
Attributes:</h3>
<p><code><Area></code> has no attributes.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_3_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><Area></code> element must contain either: </p>
<ul>
<li>
<p class="startli">A single <code><AreaProperty></code> element that describes a URect type property where the final area can be obtained.</p>
<p class="endli"></p>
</li>
<li>
Four <code><Dim></code> elements: <ul>
<li>
One <code><Dim></code> element must define the left edge or x position. </li>
<li>
One <code><Dim></code> element must define the top edge or y position. </li>
<li>
One <code><Dim></code> element must define either the right edge or width. </li>
<li>
One <code><Dim></code> element must define either the bottom edge or height. </li>
</ul>
</li>
</ul>
<p class="endli"></p>
</li>
<li>
The <code><Area></code> element may appear in any of the following elements: <ul>
<li>
<code><Child></code> to define the target area to be occupied by a child widget. </li>
<li>
<code><ImageryComponent></code> to define the target rendering area of an image. </li>
<li>
<code><NamedArea></code> to define an area which can be retrieved by name. </li>
<li>
<code><TextComponent></code> to define the target rendering area of some text. </li>
<li>
<code><FrameComponent></code> to define the target rendering area for a frame. </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_3_4"></a>
Examples:</h3>
<p>In this example we can see a named area being defined: </p>
<div class="fragment"><pre class="fragment"><NamedArea name=<span class="stringliteral">"exampleArea"</span> >
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span>><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span>><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span>><UnifiedDim scale=<span class="stringliteral">"1.0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span>><UnifiedDim scale=<span class="stringliteral">"1.0"</span> /></Dim>
</Area>
</NamedArea>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_4"></a>
<AreaProperty> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_4_1"></a>
Purpose:</h3>
<p>The <code><AreaProperty></code> element is intended to allow the system to access a property on the target window to obtain the final target area of a component being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_4_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the property to access. The named property must access a URect value. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_4_3"></a>
Usage:</h3>
<ul>
<li>The <code><AreaProperty></code> element may not contain sub-elements. </li>
<li>The <code><AreaProperty></code> element may appear as a sub-element only within the main <code><Area></code> element.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_4_4"></a>
Examples:</h3>
<h2><a class="anchor" id="fal_elem_ref_sec_5"></a>
<Child> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_5_1"></a>
Purpose:</h3>
<p>The <code><Child></code> element defines a component widget that will be created and added to each instance of any window using the <code><WidgetLook></code> being defined. Some base widgets have requirements for <code><Child></code> element definition that must be provided.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_5_2"></a>
Attributes:</h3>
<ul>
<li><code>type</code> specifies the widget type to create. Required attribute. </li>
<li><code>nameSuffix</code> specifies a suffix which will be used when naming the widget. The final name of the child widget will be that of the parent with this suffix appended. Required attribute. </li>
<li><code>look</code> specifies the name of a widget look to apply to the child widget. You should only use this if 'type' specifies a Falagard base widget type. Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_5_3"></a>
Usage:</h3>
<p>Note: the sub-elements should appear in the order that they are defined here.</p>
<ul>
<li>
The <code><Child></code> element must contain an <code><Area></code> element that defines the location of the child widget in relation to the component being defined. </li>
<li>
You may optionally specify a single <code><VertAlignment></code> element to set the vertical alignment for the child. </li>
<li>
You may optionally specify a single <code><HorzAlignment></code> element to set the horizontal alignment for the child. </li>
<li>
You may specify any number of <code><Property></code> elements to set default values for any property supported by the widget type being used for the child. </li>
<li>
The <code><Child></code> element may only appear within the <code><WidgetLook></code> element. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_5_4"></a>
Examples:</h3>
<p>In this example, taken from TaharezLook.looknfeel, we see how the title bar child widget required by the frame window type is defined: </p>
<div class="fragment"><pre class="fragment"><WidgetLook name=<span class="stringliteral">"TaharezLook/FrameWindow"</span>>
...
<Child type=<span class="stringliteral">"TaharezLook/Titlebar"</span> nameSuffix=<span class="stringliteral">"__auto_titlebar__"</span>>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> >
<FontDim type=<span class="stringliteral">"LineSpacing"</span>>
<DimOperator op=<span class="stringliteral">"Multiply"</span>>
<AbsoluteDim value=<span class="stringliteral">"1.5"</span> />
</DimOperator>
</FontDim>
</Dim>
</Area>
<Property name=<span class="stringliteral">"AlwaysOnTop"</span> value=<span class="stringliteral">"False"</span> />
</Child>
...
</WidgetLook>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_6"></a>
<ColourProperty> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_6_1"></a>
Purpose:</h3>
<p>The <code><ColourProperty></code> element is intended to allow the system to access a property on the target window to obtain colour information to be used when drawing some part of the component being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_6_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the property to access. The named property must access a single colour value. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_6_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><ColourProperty></code> element may not contain sub-elements.</p>
<p class="endli"></p>
</li>
<li>
The <code><ColourProperty></code> element may appear as a sub-element within any of the following elements: <ul>
<li>
<code><ImageryComponent></code> to specify a modulating colour to be applied when rendering the image. </li>
<li>
<code><ImagerySection></code> to specify a modulating colour to be applied to all imagery components within the imagery section as it is rendered. </li>
<li>
<code><Section></code> to specify a modulating colour to be applied to all imagery in the named section as it is rendered. </li>
<li>
<code><TextComponent></code> to specify a colour to use when rendering the text component. </li>
<li>
<code><FrameComponent></code> to specify a colour to use when rendering the text frame. </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_6_4"></a>
Examples:</h3>
<p>The following example, listing imagery for a button in the "Normal" state, shows the <code><ColourProperty></code> element in use to specify a property where colours to be used when rendering the ImagerySection named 'label' can be found: </p>
<div class="fragment"><pre class="fragment"><StateImagery name=<span class="stringliteral">"Normal"</span>>
<Layer>
<Section section=<span class="stringliteral">"normal"</span> />
<Section section=<span class="stringliteral">"label"</span>>
<ColourProperty name=<span class="stringliteral">"NormalTextColour"</span> />
</Section>
</Layer>
</StateImagery>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_7"></a>
<ColourRectProperty> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_7_1"></a>
Purpose:</h3>
<p>The <code><ColourRectProperty</code> > element is intended to allow the system to access a property on the target window to obtain colour information to be used when drawing some part of the component being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_7_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the property to access. The named property must access a ColourRect value. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_7_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><ColourRectProperty></code> element may not contain sub-elements.</p>
<p class="endli"></p>
</li>
<li>
The <code><ColourRectProperty></code> element may appear as a sub-element within any of the following elements: <ul>
<li>
<code><ImageryComponent></code> to specify a modulating ColourRect to be applied when rendering the image. </li>
<li>
<code><ImagerySection></code> to specify a modulating ColourRect to be applied to all imagery components within the imagery section as it is rendered. </li>
<li>
<code><Section></code> to specify a modulating ColourRect to be applied to all imagery in the named section as it is rendered. </li>
<li>
<code><TextComponent></code> to specify a ColourRect to use when rendering the text component. </li>
<li>
<code><FrameComponent></code> to specify a colour to use when rendering the text frame. </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_7_4"></a>
Examples:</h3>
<div class="fragment"><pre class="fragment">...
<StateImagery name=<span class="stringliteral">"SpecialState"</span>>
<Layer>
<Section section=<span class="stringliteral">"special_main"</span>>
<ColourRectProperty name=<span class="stringliteral">"SpecialColours"</span> />
</Section>
</Layer>
</StateImagery>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_8"></a>
<Colours> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_8_1"></a>
Purpose:</h3>
<p>The <code><Colours></code> element is used to explicitly specify values for a ColourRect that should be used when rendering some part of the component being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_8_2"></a>
Attributes:</h3>
<ul>
<li><code>topLeft</code> specifies a hex colour value, of the form "AARRGGBB", to be used for the top-left corner of the ColourRect. Required attribute. </li>
<li><code>topRight</code> specifies a hex colour value, of the form "AARRGGBB", to be used for the top-right corner of the ColourRect. Required attribute. </li>
<li><code>bottomLeft</code> specifies a hex colour value, of the form "AARRGGBB", to be used for the bottom-left corner of the ColourRect. Required attribute. </li>
<li><code>bottomRight</code> specifies a hex colour value of the form "AARRGGBB", to be used for the bottom-right corner of the ColourRect. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_8_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><Colours></code> element may not contain sub-elements.</p>
<p class="endli"></p>
</li>
<li>
The <code><Colours></code> element may appear as a sub-element within any of the following elements: <ul>
<li>
<code><ImageryComponent></code> to specify a modulating ColourRect to be applied when rendering the image. </li>
<li>
<code><ImagerySection></code> to specify a modulating ColourRect to be applied to all imagery components within the imagery section as it is rendered. </li>
<li>
<code><Section></code> to specify a modulating ColourRect to be applied to all imagery in the named section as it is rendered. </li>
<li>
<code><TextComponent></code> to specify a ColourRect to use when rendering the text component. </li>
<li>
<code><FrameComponent></code> to specify a colour to use when rendering the text frame. </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_8_4"></a>
Examples:</h3>
<p>In this example, we see the <code><Colours></code> element used to specify the value 'FFFFFF00' as the colour for all four corners of the colour rect to be used when rendering the image being defined: </p>
<div class="fragment"><pre class="fragment">...
<ImageryComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><AbsoluteDim value=<span class="stringliteral">"12"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><AbsoluteDim value=<span class="stringliteral">"24"</span> /></Dim>
</Area>
<Image imageset=<span class="stringliteral">"newImageset"</span> image=<span class="stringliteral">"FunkyComponent"</span> />
<Colours
topLeft=<span class="stringliteral">"FFFFFF00"</span>
topRight=<span class="stringliteral">"FFFFFF00"</span>
bottomLeft=<span class="stringliteral">"FFFFFF00"</span>
bottomRight=<span class="stringliteral">"FFFFFF00"</span>
/>
<VertFormat type=<span class="stringliteral">"Stretched"</span> />
<HorzFormat type=<span class="stringliteral">"Stretched"</span> />
</ImageryComponent>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_9"></a>
<Dim> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_9_1"></a>
Purpose:</h3>
<p>The <code><Dim></code> element is intended as a container element for a single dimension of an area rectangle.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_9_2"></a>
Attributes:</h3>
<ul>
<li><code>type</code> specifies what the dimension being defined represents. This attribute should be set to one of the values defined for the DimensionType enumeration (see below). Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_9_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><Dim></code> element may only appear within the <code><Area></code> element.</p>
<p class="endli"></p>
</li>
<li>
The <code><Dim></code> element may contain any of the following specialised dimension elements: <ul>
<li>
<code><AbsoluteDim></code> </li>
<li>
<code><FontDim></code> </li>
<li>
<code><ImageDim></code> </li>
<li>
<code><PropertyDim></code> </li>
<li>
<code><UnifiedDim></code> </li>
<li>
<code><WidgetDim></code> </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_9_4"></a>
Examples:</h3>
<h2><a class="anchor" id="fal_elem_ref_sec_10"></a>
<DimOperator> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_10_1"></a>
Purpose:</h3>
<p>The <code><DimOperator></code> element allows you to combine two of the specialised dimension specifier elements via a simple mathematical operator. Since the dimension used as the second operand may also contain a <code><DimOperator></code> it is possible to create quite complex operations.</p>
<p>Of important note is the fact that in a large chain of operations, the calculations are done in reverse order. Also, there is no operator precedence as such, all operations are applied linearly.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_10_2"></a>
Attributes:</h3>
<ul>
<li><code>op</code> specifies one of the vales from the DimensionOperator enumeration indicating the mathematical operation to be performed. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_10_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">A single <code><DimOperator></code> element may appear as a sub-element within any of the following specialised dimension elements: </p>
<ul>
<li>
<code><AbsoluteDim></code> </li>
<li>
<code><FontDim></code> </li>
<li>
<code><ImageDim></code> </li>
<li>
<code><PropertyDim></code> </li>
<li>
<code><UnifiedDim></code> </li>
<li>
<code><WidgetDim></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
The <code><DimOperator></code> element may contain any of the following specialised dimension elements: <ul>
<li>
<code><AbsoluteDim></code> </li>
<li>
<code><FontDim></code> </li>
<li>
<code><ImageDim></code> </li>
<li>
<code><PropertyDim></code> </li>
<li>
<code><UnifiedDim></code> </li>
<li>
<code><WidgetDim></code> </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_10_4"></a>
Examples:</h3>
<p>The following multiplies two simple AbsoluteDim dimensions: </p>
<div class="fragment"><pre class="fragment">...
<AbsoluteDim value=<span class="stringliteral">"10"</span>>
<DimOperator op=<span class="stringliteral">"Multiply"</span>>
<AbsoluteDim value=<span class="stringliteral">"4"</span> />
</DimOperator>
</AbsoluteDim>
...
</pre></div><p>The next example takes the height of the font used for the target window, adds four pixels and multiplies the result by two.</p>
<p>Note the effectively reversed order and lack of 'normal' operator precedence, the operation performed will be:</p>
<p><img class="formulaInl" alt="$ (2 {*} (4 + LineSpacing)) $" src="form_0.png"/></p>
<p>and not:</p>
<p><img class="formulaInl" alt="$ ((2 {*} 4) + LineSpacing) $" src="form_1.png"/></p>
<div class="fragment"><pre class="fragment">...
<AbsoluteDim value=<span class="stringliteral">"2"</span>>
<DimOperator op=<span class="stringliteral">"Multiply"</span>>
<AbsoluteDim value=<span class="stringliteral">"4"</span>>
<DimOperator op=<span class="stringliteral">"Add"</span>>
<FontDim type=<span class="stringliteral">"LineSpacing"</span> />
</DimOperator>
</AbsoluteDim>
</DimOperator>
</AbsoluteDim>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_11"></a>
<Falagard> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_11_1"></a>
Purpose:</h3>
<p>The <code><Falagard></code> element is the root element in Falagard XML skin definition files. The element serves mainly as a container for <code><WidgetLook></code> elements</p>
<h3><a class="anchor" id="fal_elem_ref_sec_11_2"></a>
Attributes:</h3>
<p>Element <code><Falagard></code> has no attributes.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_11_3"></a>
Usage:</h3>
<ul>
<li>
The <code><Falagard></code> element is the root element for Falagard skin files. </li>
<li>
The <code><Falagard></code> element may contain any number of <code><WidgetLook></code> elements. </li>
<li>
No element may contain <code><Falagard></code> elements as a sub-element. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_11_4"></a>
Examples:</h3>
<p>Here we just see the general structure of a Falagard XML file, notice that the <code><Falagard></code> element just serves as a container for multiple <code><WidgetLook></code> elements: </p>
<div class="fragment"><pre class="fragment"><?xml version=<span class="stringliteral">"1.0"</span> ?>
<Falagard>
<WidgetLook name=<span class="stringliteral">"TaharezLook/Button"</span>>
...
</WidgetLook>
<WidgetLook ... >
...
</WidgetLook>
...
</Falagard>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_12"></a>
<FontDim> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_12_1"></a>
Purpose:</h3>
<p>The <code><FontDim></code> element is used to take some measurement of a Font, and use it as a dimension component of an area rectangle.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_12_2"></a>
Attributes:</h3>
<ul>
<li><code>widget</code> specifies the name suffix of a child window to access when automatically obtaining the font or text string to be used when calculating the dimension's value. The final name used to access the widget will be that of the target window with this suffix appended. If this suffix is not specified, the target window itself is used. Optional attribute. </li>
<li><code>type</code> specifies the type of font metric / measurement to use for this dimension. This should be set to one of the values from the FontMetricType enumeration. Required attribute. </li>
<li><code>font</code> specifies the name of a font. If no font is given, the font will be taken from the target window at the time the dimension's value is taken. Optional attribute. </li>
<li><code>string</code> For horizontal extents measurement, specifies the string to be measured. If no explicit string is given, the window text for the target window at the time the dimension's value is taken will be used instead. Optional attribute. </li>
<li><code>padding</code> an absolute pixel 'padding' value to be added to the font metric value. Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_12_3"></a>
Usage:</h3>
<ul>
<li>
The <code><FontDim></code> element may contain a single <code><DimOperator></code> element in order to form a dimension calculation. </li>
<li>
The <code><FontDim></code> element can appear as a sub-element in <code><Dim></code> to form a dimension specification for an area. </li>
<li>
The <code><FontDim></code> element can appear as a sub-element of <code><DimOperator></code> to specify the second operand for a dimension calculation. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_12_4"></a>
Examples:</h3>
<p>This first example just gets the line spacing for the window's current font: </p>
<div class="fragment"><pre class="fragment"><Dim type=<span class="stringliteral">"Height"</span>>
<FontDim type=<span class="stringliteral">"LineSpacing"</span> />
</Dim>
</pre></div><p>Now we take an extents measurement of the windows current text, using a specified font, and pad the result by ten pixels: </p>
<div class="fragment"><pre class="fragment"><Dim type=<span class="stringliteral">"Width"</span>>
<FontDim type=<span class="stringliteral">"HorzExtent"</span> font=<span class="stringliteral">"Roman-14"</span> padding=<span class="stringliteral">"10"</span> />
</Dim>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_13"></a>
<FontProperty> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_13_1"></a>
Purpose:</h3>
<p>The <code><FontProperty></code> element is intended to allow the system to access a property on the target window to obtain the font to be used when rendering the TextComponent being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_13_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the property to access. Required attribute. The value of the named property is taken as being the name of a Font.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_13_3"></a>
Usage:</h3>
<ul>
<li>
The <code><FontProperty></code> element may not contain sub-elements. </li>
<li>
The <code><FontProperty></code> element may appear as a sub-element only within the <code><TextComponent></code> element. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_13_4"></a>
Examples:</h3>
<h2><a class="anchor" id="fal_elem_ref_sec_14"></a>
<FrameComponent> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_14_1"></a>
Purpose:</h3>
<p>The <code><FrameComponent></code> element is used to define an imagery frame using a maximum of eight images for the corners and edges, and a single, formatted, image for the background. Any of the images may be omitted if not required.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_14_2"></a>
Attributes:</h3>
<p>No attributes are currently defined for the <code><FrameComponent></code> element.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_14_3"></a>
Usage:</h3>
<p>Note: the sub-elements should appear in the order that they are defined here.</p>
<ul>
<li>
<code><Area></code> defining the target area for this frame. </li>
<li>
<p class="startli">Up to nine <code><Image></code> elements specifying the images to be drawn and in what positions.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Optionally specifying the colours for the entire frame, one of the colour elements: </p>
<ul>
<li>
<code><Colours></code> </li>
<li>
<code><ColourProperty></code> </li>
<li>
<code><ColourRectProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">Optionally, to specify the vertical formatting to use for the frame background, either of: </p>
<ul>
<li>
<code><VertFormat></code> </li>
<li>
<code><VertFormatProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">Optionally, to specify the horizontal formatting to use for the frame background, either of: </p>
<ul>
<li>
<code><HorzFormat></code> </li>
<li>
<code><HorzFormatProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
The <code><FrameComponent></code> element may only appear as a sub-element of the element <code><ImagerySection></code>. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_14_4"></a>
Examples:</h3>
<p>The following defines a full frame and background. It is taken from the TaharezLook skin specification for the Listbox widget:</p>
<div class="fragment"><pre class="fragment"><FrameComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<Image type=<span class="stringliteral">"TopLeftCorner"</span>
imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"ListboxTopLeft"</span>
/>
<Image type=<span class="stringliteral">"TopRightCorner"</span>
imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"ListboxTopRight"</span>
/>
<Image type=<span class="stringliteral">"BottomLeftCorner"</span>
imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"ListboxBottomLeft"</span>
/>
<Image type=<span class="stringliteral">"BottomRightCorner"</span>
imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"ListboxBottomRight"</span>
/>
<Image type=<span class="stringliteral">"LeftEdge"</span>
imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"ListboxLeft"</span>
/>
<Image type=<span class="stringliteral">"RightEdge"</span>
imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"ListboxRight"</span>
/>
<Image type=<span class="stringliteral">"TopEdge"</span>
imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"ListboxTop"</span>
/>
<Image type=<span class="stringliteral">"BottomEdge"</span>
imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"ListboxBottom"</span>
/>
<Image type=<span class="stringliteral">"Background"</span>
imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"ListboxBackdrop"</span>
/>
</FrameComponent>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_15"></a>
<HorzAlignment> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_15_1"></a>
Purpose:</h3>
<p>The <code><HorzAlignment></code> element is used to specify the horizontal alignment option required for a child window element.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_15_2"></a>
Attributes:</h3>
<ul>
<li><code>type</code> specifies one of the values from the HorizontalAlignment enumeration indicating the desired horizontal alignment.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_15_3"></a>
Usage:</h3>
<ul>
<li>
The <code><HorzAlignment></code> element may only appear as a sub-element of the <code><Child></code> element. </li>
<li>
The <code><HorzAlignment></code> element may not contain any sub-elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_15_4"></a>
Examples:</h3>
<p>This example defines a scrollbar type child widget. We have used the <code><HorzAlignment></code> element to specify that the scrollbar appear on the far right edge of the component being defined: </p>
<div class="fragment"><pre class="fragment">...
<Child type=<span class="stringliteral">"MyLook/VertScrollbar"</span> nameSuffix=<span class="stringliteral">"__auto_vscrollbar__"</span>>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><AbsoluteDim value=<span class="stringliteral">"15"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<HorzAlignment type=<span class="stringliteral">"RightAligned"</span> />
</Child>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_16"></a>
<HorzFormat> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_16_1"></a>
Purpose:</h3>
<p>The <code><HorzFormat></code> element is used to specify the required horizontal formatting for an image, frame, or text component.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_16_2"></a>
Attributes:</h3>
<ul>
<li><code>type</code> specifies the required horizontal formatting option.</li>
</ul>
<ul>
<li>
For use in ImageryComponents or FrameComponents, this will be one of the values from the HorizontalFormat enumeration. </li>
<li>
For use in TextComponents, this will one of the values form the HorizontalTextFormat enumeration. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_16_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><HorzFormat></code> element may only appear as a sub-element of the following elements: </p>
<ul>
<li>
<code><ImageryComponent></code> </li>
<li>
<code><FrameComponent></code> </li>
<li>
<code><TextComponent></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
The <code><HorzFormat></code> element may not contain any sub-elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_16_4"></a>
Examples:</h3>
<p>This first example shows an ImageryComponent definition. We use <code><HorzFormat></code> to specify that we want the image stretched to cover the entire width of the designated target area: </p>
<div class="fragment"><pre class="fragment">...
<ImageryComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><AbsoluteDim value=<span class="stringliteral">"25"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><AbsoluteDim value=<span class="stringliteral">"25"</span> /></Dim>
</Area>
<Image imageset=<span class="stringliteral">"myImageset"</span> image=<span class="stringliteral">"coolImage"</span> />
<VertFormat type=<span class="stringliteral">"Stretched"</span> />
<HorzFormat type=<span class="stringliteral">"Stretched"</span> />
</ImageryComponent>
...
</pre></div><p>This second example is for a TextComponent. You can see <code><HorzFormat></code> used here to specify that we want the text centred within the target area, and word-wrapped where required: </p>
<div class="fragment"><pre class="fragment"><TextComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"RightEdge"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<HorzFormat type=<span class="stringliteral">"WordWrapLeftAligned"</span> />
</TextComponent>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_17"></a>
<HorzFormatProperty> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_17_1"></a>
Purpose:</h3>
<p>The <code><HorzFormatProperty></code> element is intended to allow the system to access a property on the target window to obtain the horizontal formatting to be used when drawing the component being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_17_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the property to access. The named property must access a string value that will be set to one of the enumeration values appropriate for the component being defined (HorizontalTextFormat for TextComponent, and HorizontalFormat for either FrameComponent or ImageryComponent). Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_17_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><HorzFormatProperty></code> element may not contain sub-elements.</p>
<p class="endli"></p>
</li>
<li>
The <code><HorzFormatProperty></code> element may appear as a sub-element within any of the following elements: <ul>
<li>
<code><ImageryComponent></code> to specify a horizontal formatting to be used the the image. </li>
<li>
<code><FrameComponent></code> to specify a horizontal formatting to be used for the frame background. </li>
<li>
<code><TextComponent></code> to specify a horizontal formatting to be used for the text. </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_17_4"></a>
Examples:</h3>
<h2><a class="anchor" id="fal_elem_ref_sec_18"></a>
<Image> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_18_1"></a>
Purpose:</h3>
<p>The <code><Image></code> element is used to specify an Imageset and Image pair, and for FrameComponent images, how the image is to be used.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_18_2"></a>
Attributes:</h3>
<ul>
<li><code>imageset</code> specifies the name of an Imageset which contains the image to be used. Required attribute. </li>
<li><code>image</code> specifies the name of the image from the specified Imageset to be used. Required attribute. </li>
<li><code>type</code> Only for FrameComponent. Specifies the part of the frame that this image is to be used for. One of the values from the FrameImageComponent enumeration. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_18_3"></a>
Usage:</h3>
<ul>
<li>
The <code><Image></code> element may only appear as a sub-element of the <code><ImageryComponent></code> or <code><FrameComponent></code> elements. </li>
<li>
The <code><Image></code> element may not contain any sub-elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_18_4"></a>
Examples:</h3>
<p>Here you can see the <code><Image></code> element used to specify the image to render for an ImageryComponent being defined: </p>
<div class="fragment"><pre class="fragment">...
<ImageryComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><AbsoluteDim value=<span class="stringliteral">"15"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1.0"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<Image imageset=<span class="stringliteral">"FunkyLook"</span> image=<span class="stringliteral">"ButtonIcon"</span> />
<VertFormat type=<span class="stringliteral">"CentreAligned"</span> />
<HorzFormat type=<span class="stringliteral">"CentreAligned"</span> />
</ImageryComponent>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_19"></a>
<ImageDim> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_19_1"></a>
Purpose:</h3>
<p>The <code><ImageDim></code> element is used to define a component dimension for an area rectangle. <code><ImageDim></code> is used to specify some dimension of an image for use as an area dimension.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_19_2"></a>
Attributes:</h3>
<ul>
<li><code>imageset</code> specifies the name of an Imageset which contains the image to be used. Required attribute. </li>
<li><code>image</code> specifies the name of the image from the specified Imageset to be used. Required attribute. </li>
<li><code>dimension</code> specifies the image dimension to be used. This should be set to one of the values defined in the DimensionType enumeration. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_19_3"></a>
Usage:</h3>
<ul>
<li>
The <code><ImageDim></code> element may contain a single <code><DimOperator></code> element in order to form a dimension calculation. </li>
<li>
The <code><ImageDim></code> element can appear as a sub-element in <code><Dim></code> to form a dimension specification for an area. </li>
<li>
The <code><ImageDim></code> element can appear as a sub-element of <code><DimOperator></code> to specify the second operand for a dimension calculation. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_19_4"></a>
Examples:</h3>
<p>This example shows a dimension that uses <code><ImageDim></code> to fetch the width of a specified image for use as the dimensions value: </p>
<div class="fragment"><pre class="fragment">...
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span>>
<ImageDim imageset=<span class="stringliteral">"myImages"</span> image=<span class="stringliteral">"leftImage"</span> dimension=<span class="stringliteral">"Width"</span> />
</Dim>
...
</Area>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_20"></a>
<ImageryComponent> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_20_1"></a>
Purpose:</h3>
<p>The <code><ImageryComponent></code> element defines a single image to be drawn within a given ImagerySection. The ImageryComponent contains all information about which image is to be drawn, where it should be drawn, which colours are to be used and how the image should be formatted.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_20_2"></a>
Attributes:</h3>
<p>No attributes are defined for the <code><ImageryComponent></code> element.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_20_3"></a>
Usage:</h3>
<p>Note: the sub-elements should appear in the order that they are defined here.</p>
<ul>
<li>
<p class="startli"><code><Area></code> defining the target area for this image.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Either one of: </p>
<ul>
<li>
<code><Image></code> element specifying the image to be drawn. </li>
<li>
<code><ImageProperty></code> element specifying a property defining the image to be drawn. </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">Optionally specifying the colours for this single image, one of the colour elements: </p>
<ul>
<li>
<code><Colours></code> </li>
<li>
<code><ColourProperty></code> </li>
<li>
<code><ColourRectProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">Optionally, to specify the vertical formatting to use, either of: </p>
<ul>
<li>
<code><VertFormat></code> </li>
<li>
<code><VertFormatProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">Optionally, to specify the horizontal formatting to use, either of: </p>
<ul>
<li>
<code><HorzFormat></code> </li>
<li>
<code><HorzFormatProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
The <code><ImageryComponent></code> element may only appear as a sub-element of the element <code><ImagerySection></code>. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_20_4"></a>
Examples:</h3>
<p>The following was taken from TaharezLook.looknfeel and shows a full ImageryComponent definition: </p>
<div class="fragment"><pre class="fragment"><ImageryComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><UnifiedDim scale=<span class="stringliteral">"0"</span> type=<span class="stringliteral">"LeftEdge"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><UnifiedDim scale=<span class="stringliteral">"0.2"</span> type=<span class="stringliteral">"TopEdge"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"0.3"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<Image imageset=<span class="stringliteral">"TaharezLook"</span> image=<span class="stringliteral">"TextSelectionBrush"</span> />
<Colours
topLeft=<span class="stringliteral">"FFFFFF00"</span>
topRight=<span class="stringliteral">"FFFFFF00"</span>
bottomLeft=<span class="stringliteral">"FFFFFF00"</span>
bottomRight=<span class="stringliteral">"FFFFFF00"</span>
/>
<VertFormat type=<span class="stringliteral">"Tiled"</span> />
<HorzFormat type=<span class="stringliteral">"Stretched"</span> />
</ImageryComponent>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_21"></a>
<ImageProperty> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_21_1"></a>
Purpose:</h3>
<p>The <code><ImageProperty></code> element is intended to allow the system to access a property on the target window to obtain the final image to be used when rendering the ImageryComponent being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_21_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the property to access. Required attribute. The named property must access a imageset & image value pair of the form: <div class="fragment"><pre class="fragment"><span class="stringliteral">"set:<imageset_name> image:<image_name>"</span>
</pre></div></li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_21_3"></a>
Usage:</h3>
<ul>
<li>
The <code><ImageProperty></code> element may not contain sub-elements. </li>
<li>
The <code><ImageProperty></code> element may appear as a sub-element only within the <code><ImageryComponent></code> elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_21_4"></a>
Examples:</h3>
<h2><a class="anchor" id="fal_elem_ref_sec_22"></a>
<ImagerySection> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_22_1"></a>
Purpose:</h3>
<p>The <code><ImagerySection></code> element is used to group multiple <code><ImageryComponent></code> and <code><TextComponent></code> definitions into named sections which can then be specified for use as imagery in state definitions.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_22_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name to be given to this ImagerySection. Names are per-WidgetLook, and specifying the same name more than once will replace the previous definition. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_22_3"></a>
Usage:</h3>
<p>Note: the sub-elements should appear in the order that they are defined here.</p>
<ul>
<li>
<p class="startli">To optionally specify colours to be modulated with the individual component's colours, the <code><ImagerySection></code> may contain one of the colour definition elements: </p>
<ul>
<li>
<code><Colours></code> </li>
<li>
<code><ColourProperty></code> </li>
<li>
<code><ColourRectProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
Any number of <code><FrameComponent></code> elements may then follow. </li>
<li>
Followed by any number of <code><ImageryComponent></code> elements. </li>
<li>
Finally, any number of <code><TextComponent></code> elements may be given. </li>
<li>
The <code><ImagerySection></code> element may only appear as a sub-element of the <code><WidgetLook></code> element. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_22_4"></a>
Examples:</h3>
<div class="fragment"><pre class="fragment"><ImagerySection name=<span class="stringliteral">"example"</span>>
<ImageryComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><AbsoluteDim value=<span class="stringliteral">"15"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1.0"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<Image imageset=<span class="stringliteral">"sillyImages"</span> image=<span class="stringliteral">"anotherImage"</span> />
<VertFormat type=<span class="stringliteral">"Stretched"</span> />
<HorzFormat type=<span class="stringliteral">"Stretched"</span> />
</ImageryComponent>
<TextComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
</TextComponent>
</ImagerySection>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_23"></a>
<Layer> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_23_1"></a>
Purpose:</h3>
<p>The <code><Layer></code> element is used to define layers of imagery within the definition of a StateImagery section.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_23_2"></a>
Attributes:</h3>
<ul>
<li><code>priority</code> specifies the priority for the layer. Higher priorities appear in front of lower priorities. Default priority is 0. Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_23_3"></a>
Usage:</h3>
<ul>
<li>
The <code><Layer></code> element may only appear as a sub-element of the <code><StateImagery></code> element. </li>
<li>
The <code><Layer></code> element may contain any number of <code><Section></code> sub-elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_23_4"></a>
Examples:</h3>
<p>Here we see a single layer with multiple sections included. This example was taken from the TaharezLook skin XML file (ListHeaderSegment widget): </p>
<div class="fragment"><pre class="fragment"><StateImagery name=<span class="stringliteral">"Normal"</span>>
<Layer>
<Section section=<span class="stringliteral">"segment_normal"</span> />
<Section section=<span class="stringliteral">"splitter_normal"</span> />
<Section section=<span class="stringliteral">"label"</span> />
</Layer>
</StateImagery>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_24"></a>
<NamedArea> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_24_1"></a>
Purpose:</h3>
<p>Defines an area that can be accessed via it's name. Generally this this used by base widgets to obtain skin supplied areas for use in rendering or other widget specific operations.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_24_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies a name for the area being defined. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_24_3"></a>
Usage:</h3>
<ul>
<li>
The <code><NamedArea></code> element must contain only an <code><Area></code> sub-element defining the area rectangle for the named area. </li>
<li>
The <code><NamedArea></code> element may only appear as a sub-element within <code><WidgetLook></code> elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_24_4"></a>
Examples:</h3>
<p>This example defines a named area called 'TextArea'. It is defined as being an area seven pixels inside the total area of the widget being defined: </p>
<div class="fragment"><pre class="fragment"><NamedArea name=<span class="stringliteral">"TextArea"</span>>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> >
<AbsoluteDim value=<span class="stringliteral">"7"</span> />
</Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> >
<AbsoluteDim value=<span class="stringliteral">"7"</span> />
</Dim>
<Dim type=<span class="stringliteral">"RightEdge"</span> >
<UnifiedDim scale=<span class="stringliteral">"1.0"</span> offset=<span class="stringliteral">"-7"</span> type=<span class="stringliteral">"RightEdge"</span> />
</Dim>
<Dim type=<span class="stringliteral">"BottomEdge"</span> >
<UnifiedDim scale=<span class="stringliteral">"1.0"</span> offset=<span class="stringliteral">"-7"</span> type=<span class="stringliteral">"BottomEdge"</span> />
</Dim>
</Area>
</NamedArea>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_25"></a>
<Property> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_25_1"></a>
Purpose:</h3>
<p>The <code><Property></code> element is used to initialise a property on a window or widget being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_25_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the property to be initialised. Required attribute. </li>
<li><code>value</code> specifies the value string to be used when initialising the property. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_25_3"></a>
Usage:</h3>
<ul>
<li>
The <code><Property></code> element may not contain any sub-elements. </li>
<li>
The <code><Property></code> element may appear as a sub-element in <code><WidgetLook></code> elements to define property initialisers for the type being defined. </li>
<li>
The <code><Property></code> element may appear as a sub-element in <code><Child></code> elements to define property initialisers for the child widget being defined. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_25_4"></a>
Examples:</h3>
<p>In this extract from the definition for TaharezLook/Titlebar, we can see the <code><Property></code> element used to set the 'CaptionColour' property; this establishes a default for all instances of this widget: </p>
<div class="fragment"><pre class="fragment"><WidgetLook name=<span class="stringliteral">"TaharezLook/Titlebar"</span>>
<Property name=<span class="stringliteral">"CaptionColour"</span> value=<span class="stringliteral">"FFFFFFFF"</span> />
<ImagerySection name=<span class="stringliteral">"main"</span>>
<ImageryComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
...
</Area>
...
</ImageryComponent>
</ImagerySection>
...
</WidgetLook>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_26"></a>
<PropertyDefinition> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_26_1"></a>
Purpose:</h3>
<p>The <code><PropertyDefinition></code> element creates a new named property for the widget being defined. The defined property may be accessed via any means that a 'normal' property may.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_26_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name to use for the new property. Required attribute. </li>
<li><code>initialValue</code> specifies the initial value to be assigned to the property. Optional attribute. </li>
<li><code>type</code> specifies the data type of the property. This should be one of the values defined for the PropertyType enumeration. Optional attribute. </li>
<li><code>redrawOnWrite</code> boolean setting specifies whether writing a new value to this property should cause the widget being defined to redraw itself. Optional attribute. </li>
<li><code>layoutOnWrite</code> boolean setting specifies whether writing a new value to this property should cause the widget being defined to re-layout it's defined child widgets. Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_26_3"></a>
Usage:</h3>
<ul>
<li>
The <code><PropertyDefinition></code> element may not contain sub-elements. </li>
<li>
The <code><PropertyDefinition></code> element must appear as a sub-element within <code><WidgetLook></code> elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_26_4"></a>
Examples:</h3>
<p>In this example, within the WidgetLook we create a new property named 'ScrollbarWidth'. We then use this property to control the width of a component child widget. This effectively gives the user control over the width of the child scrollbar via the property: </p>
<div class="fragment"><pre class="fragment"><WidgetLook name=<span class="stringliteral">"PropertyDefExample"</span>>
<PropertyDefinition
name=<span class="stringliteral">"ScrollbarWidth"</span>
initialValue=<span class="stringliteral">"12"</span>
layoutOnWrite=<span class="stringliteral">"true"</span>
/>
...
<Child type=<span class="stringliteral">"MyVertScrollbar"</span> nameSuffix=<span class="stringliteral">"__auto_vscrollbar__"</span>>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><PropertyDim name=<span class="stringliteral">"ScrollbarWidth"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<HorzAlignment type=<span class="stringliteral">"RightAligned"</span> />
</Child>
...
</WidgetLook>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_27"></a>
<PropertyLinkDefinition> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_27_1"></a>
Purpose:</h3>
<p>The <code><PropertyLinkDefinition></code> element creates a new named property for the widget being defined that is linked to one or more properties on either child widget components, or on the parent widget. The target widgets and properties can be specified either as attributes (for example if the link is to be a one to one mapping), or via <PropertyLinkTarget> elements (if there is to be a one to many mapping). This allows properties on child widgets to be directly exposed to clients of the widget being defined, as well as allowing the widget being defined to make use of properties defined on a parent widget. The defined property may be accessed via any means that a 'normal' property may.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_27_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name to use for the new property. Required attribute. </li>
<li><code>widget</code> specifies either the name suffix of the child widget containing the first property to be linked to the property being defined, or the special value <code>"__parent__"</code> to indicate a back-link to the parent. Optional attribute. </li>
<li><code>targetProperty</code> specifies the name of the property on the child widget that is to be the first property linked to the new property being defined. If this is omitted but <code>widget</code> is specified, it will be assumed that the target property has the same name as the property being defined. Optional attribute. </li>
<li><code>initialValue</code> specifies the initial value to be assigned to the property. Optional attribute. </li>
<li><code>type</code> specifies the data type of the property. This should be one of the values defined for the PropertyType enumeration. Optional attribute. </li>
<li><code>redrawOnWrite</code> boolean setting specifies whether writing a new value to this property should cause the widget being defined to redraw itself. Optional attribute. </li>
<li><code>layoutOnWrite</code> boolean setting specifies whether writing a new value to this property should cause the widget being defined to re-layout it's defined child widgets. Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_27_3"></a>
Usage:</h3>
<ul>
<li>
The <code><PropertyLinkDefinition></code> element may contain any number of <code><PropertyLinkTarget></code> sub-elements. </li>
<li>
The <code><PropertyLinkDefinition></code> element may only appear as a sub-element within <code><WidgetLook></code> elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_27_4"></a>
Examples:</h3>
<p>In this example we create a new property named 'CaptionTextColour'. This is linked to a property named 'CaptionColour' on the child widget with name suffix '__auto_titlebar__'. Any access of the 'CaptionTextColour' property on the widget will actually access the 'CaptionColour' property on the specified child widget: </p>
<div class="fragment"><pre class="fragment"><WidgetLook name=<span class="stringliteral">"PropertyLinkExample"</span>>
<PropertyLinkDefinition
name=<span class="stringliteral">"CaptionTextColour"</span>
widget=<span class="stringliteral">"__auto_titlebar__"</span>
targetProperty=<span class="stringliteral">"CaptionColour"</span>
initialValue=<span class="stringliteral">"FFFF3333"</span>
layoutOnWrite=<span class="stringliteral">"true"</span>
/>
...
</WidgetLook>
</pre></div><h2><a class="anchor" id="fal_elem_propertylinktarget"></a>
<PropertyLinkTarget> Element</h2>
<h3><a class="anchor" id="fal_elem_propertylinktargetr_1"></a>
Purpose:</h3>
<p>The <code><PropertyLinkTarget></code> element specifies a target widget suffix and property name to be used with a <code><PropertyLinkDefinition></code>. Whenever the property defined by the enclosing <code><PropertyLinkDefinition></code> is written to, the property specified in the <code><PropertyLinkTarget></code> will be written also. If the <code><PropertyLinkTarget></code> is the first linked target it will also be used as the 'master linked target' and will be used as the source for read accesses to the property defined by the enclosing <code><PropertyLinkDefinition></code> element.</p>
<h3><a class="anchor" id="fal_elem_propertylinktarget_2"></a>
Attributes:</h3>
<ul>
<li><code>widget</code> specifies either the name suffix of the child widget containing the property that is to be linked to the property being defined by the enclosing <code><PropertyLinkDefinition></code> element, or the special value <code>"__parent__"</code> to indicate a back-link to the parent. Required attribute. </li>
<li><code>property</code> specifies the name of the property on the child widget that is to be linked to the property being defined by the enclosing <code><PropertyLinkDefinition></code>. If this is omitted, it will be assumed that the target property has the same name as the property being defined. Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_propertylinktarget_3"></a>
Usage:</h3>
<ul>
<li>
The <code><PropertyLinkTarget></code> element may not contain sub-elements. </li>
<li>
The <code><PropertyLinkTarget></code> element may only appear as a sub-element within <code><PropertyLinkDefinition></code> elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_propertylinktarget_4"></a>
Examples:</h3>
<p>In this example we create a new property named 'TextColour'. This is linked to separate properties on two different child components. A property named 'LabelColour' on a child widget with name suffix '__auto_button1__', and a property named 'ContentColour' on a child widget with name suffix '__auto_content_panel__. Writing to the property 'TextColour' will cause both 'LabelColour' and 'ContentColour' to be updated, while reading the property 'TextColour' will fetch the value of 'LabelColour' (because it appears first, it is treated as the master target). </p>
<div class="fragment"><pre class="fragment"><WidgetLook name=<span class="stringliteral">"PropertyLinkTargetExample"</span>>
<PropertyLinkDefinition name=<span class="stringliteral">"TextColour"</span> initialValue=<span class="stringliteral">"FFFF00FF"</span> >
<PropertyLinkTarget widget=<span class="stringliteral">"__auto_button1__"</span> <span class="keyword">property</span>=<span class="stringliteral">"LabelColour"</span> />
<PropertyLinkTarget widget=<span class="stringliteral">"__auto_content_panel__"</span> <span class="keyword">property</span>=<span class="stringliteral">"ContentColour"</span> />
</PropertyLinkDefinition>
...
</WidgetLook>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_28"></a>
<PropertyDim> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_28_1"></a>
Purpose:</h3>
<p>The <code><PropertyDim></code> element is used to define a component dimension for an area rectangle. <code><PropertyDim></code> is used to specify either a UDim or a simple floating point value - accessed via a window property - for use as an area dimension.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_28_2"></a>
Attributes:</h3>
<ul>
<li><code>widget</code> specifies the name suffix of a child window to access the property for. The final name used to access the widget will be that of the target window with this suffix appended. If this suffix is not specified, the target window itself is used. Optional attribute. </li>
<li><code>name</code> specifies the name of the property that will provide the value for this dimension. The property named should access either a UDim value or a simple floating point numerical value - the system determines which type of value to expect based upon the usage (or not) of the optional <code>type</code> attribute. </li>
<li><code>type</code> specifies the dimension for which the relative scale value of a UDim value is a portion of, and as such should be set to either <code>"Width"</code> or <code>"Height"</code>. If the property specified by the attribute <code>name</code> is intended to access a simple floating point value rather than a UDim value, this attribute should be omitted. Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_28_3"></a>
Usage:</h3>
<ul>
<li>
The <code><PropertyDim></code> element may contain a single <code><DimOperator></code> element in order to form a dimension calculation. </li>
<li>
The <code><PropertyDim></code> element can appear as a sub-element in <code><Dim></code> to form a dimension specification for an area. </li>
<li>
The <code><PropertyDim></code> element can appear as a sub-element of <code><DimOperator></code> to specify the second operand for a dimension calculation. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_28_4"></a>
Examples:</h3>
<p>This example shows a dimension that uses <code><PropertyDim></code> to fetch a property value to use as the dimension value. We are accessing the 'AbsoluteWidth' property, from an attached widget with the name suffix '__auto_button__', that accesses a simple floating point value:</p>
<div class="fragment"><pre class="fragment">...
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span>>
<PropertyDim widget=<span class="stringliteral">"__auto_button__"</span> name=<span class="stringliteral">"AbsoluteWidth"</span> />
</Dim>
...
</Area>
...
</pre></div><p> Here we show a dimension that uses <code><PropertyDim></code> to access a property named 'UserWidth' on the target window. We have specified the <code>type</code> attribute to be 'Width', which indicates to the system that the property will access a UDim value and that the scale part of the UDim is relative to the width of the target window.</p>
<div class="fragment"><pre class="fragment">...
<Area>
...
<Dim type=<span class="stringliteral">"Width"</span>>
<PropertyDim name=<span class="stringliteral">"UserWidth"</span> type=<span class="stringliteral">"Width"</span> />
</Dim>
...
</Area>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_29"></a>
<Section> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_29_1"></a>
Purpose:</h3>
<p>The <code><Section></code> element is used to name an ImagerySection to be included for rendering within a StateImagery Layer definition.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_29_2"></a>
Attributes:</h3>
<ul>
<li><code>look</code> specifies the name of a WidgetLook that contains the ImagerySection to be referenced. If this is omitted, the WidgetLook currently being defined is used. Optional attribute. </li>
<li><code>section</code> specifies the name of an ImagerySection from the chosen WidgetLook to be referenced. Required attribute. </li>
<li><code>controlProperty</code> specifies the name of a property that will be accessed to determine whether or not to render this section (see <code>controlValue</code> below for details of how it is determined whether or not the secion will be drawn). Optional attribute. </li>
<li><code>controlValue</code> specifies a value that will be compared to the value fetched from <code>controlProperty</code> in order to decide whether to draw the section. If <code>controlValue</code> is not specified, or is specified as the empty string, then the property named in <code>controlProperty</code> is treated as a boolean value. Otherwise the value fetched from the property named in <code>controlPropery</code> must exactly match the value specified in <code>controlValue</code> for the imagery section to be drawn. Optional attribute. </li>
<li><code>controlWidget</code> specifies either the name suffix of a child widget, or the special value <code>"__parent__"</code>, to indicate a widget that will be used as the source of the property named in <code>controlProperty</code>. If <code>controlWidget</code> is not specified, or is specified as the empty string, then the widget with WidgetLook assigned to it will be used as the source (matching the previous / default behaviour). Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_29_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><Section></code> element may only appear as a sub-element within the <code><Layer></code> element.</p>
<p class="endli"></p>
</li>
<li>
The <code><Section></code> element may specify colours to be modulated with any current colours used for each component within the named ImagerySection, by optionally specifying one of the colour elements as a sub-element: <ul>
<li>
<code><Colours></code> </li>
<li>
<code><ColourProperty></code> </li>
<li>
<code><ColourRectProperty></code> </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_29_4"></a>
Examples:</h3>
<p>Here we see a state definition from a button widget. The state specifies to use the 'normal' imagery section, and also the 'label' imagery section. The 'label' section is only drawn if the 'DrawText' property of the target window is 'True'. Colours for 'label' will be modulated with the colour obtained from the 'NormalTextColour' property of the target window: </p>
<div class="fragment"><pre class="fragment">...
<StateImagery name=<span class="stringliteral">"Normal"</span>>
<Layer>
<Section section=<span class="stringliteral">"normal"</span> />
<Section section=<span class="stringliteral">"label"</span> controlProperty=<span class="stringliteral">"DrawText"</span>>
<ColourProperty name=<span class="stringliteral">"NormalTextColour"</span> />
</Section>
</Layer>
</StateImagery>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_30"></a>
<StateImagery> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_30_1"></a>
Purpose:</h3>
<p>The <code><StateImagery></code> element defines imagery to be used when rendering a named state. The base widget type intended as a target for the WidgetLook being defined will specify which states are required to be defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_30_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the state being defined. Required attribute. </li>
<li><code>clipped</code> boolean setting that states whether imagery defined within this state should be clipped to the target window's defined area. If this is specified and set to false, the state imagery will only be clipped to the display area. Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_30_3"></a>
Usage:</h3>
<ul>
<li>
The <code><StateImagery>element</code> may contain any number of <code><Layer></code> sub-elements. </li>
<li>
The <code><StateImagery></code> element may only appear as a sub-element of the <code><WidgetLook></code> element. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_30_4"></a>
Examples:</h3>
<p>The following is an extract of the MenuItem definition from TaharezLook.looknfeel. The except defines some of the states required for that widget. Note that, although not shown here, a required state can be empty if no rendering is needed for that state: </p>
<div class="fragment"><pre class="fragment">...
<StateImagery name=<span class="stringliteral">"EnabledNormal"</span>>
<Layer>
<Section section=<span class="stringliteral">"label"</span> />
</Layer>
</StateImagery>
<StateImagery name=<span class="stringliteral">"EnabledHover"</span>>
<Layer>
<Section section=<span class="stringliteral">"frame"</span> />
<Section section=<span class="stringliteral">"label"</span> />
</Layer>
</StateImagery>
<StateImagery name=<span class="stringliteral">"EnabledPushed"</span>>
<Layer>
<Section section=<span class="stringliteral">"frame"</span> />
<Section section=<span class="stringliteral">"label"</span> />
</Layer>
</StateImagery>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_31"></a>
<Text> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_31_1"></a>
Purpose:</h3>
<p>The <code><Text></code> element is used to define font and text string information within a TextComponent.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_31_2"></a>
Attributes:</h3>
<ul>
<li><code>font</code> specifies the name of a font to use for this text. If this is omitted, the current font of the target window will be used instead. Optional attribute. </li>
<li><code>string</code> specifies a text string to be rendered. If this is omitted, the current window text for the target window will be used instead. Optional attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_31_3"></a>
Usage:</h3>
<ul>
<li>
The <code><Text></code> element may not contain any sub-elements. </li>
<li>
The <code><Text></code> element should only appear as a sub-element within <code><TextComponent></code> elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_31_4"></a>
Examples:</h3>
<p>In this simple example, we define a TextComponent that renders some static text. The <code><Text></code> element is used to specify the font and string to be used: </p>
<div class="fragment"><pre class="fragment">...
<TextComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<Text font=<span class="stringliteral">"Roman-18"</span> <span class="keywordtype">string</span>=<span class="stringliteral">"Render this text!"</span> />
</TextComponent>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_32"></a>
<TextComponent> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_32_1"></a>
Purpose:</h3>
<p>The <code><TextComponent></code> element defines a single item of text to be drawn within a given ImagerySection. The TextComponent contains all information about the text that is to be drawn, where it should be drawn, which colours are to be used and how the text should be formatted within its area.</p>
<p>Note that if the <code><Text></code> element appears in addition to either of the <code><TextProperty></code> or <code><FontProperty></code> elements, the string and font specified within the <code><Text></code> element will act as default values if the properties referenced in <code><TextProperty></code> or <code><FontProperty></code> evaluate to empty strings.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_32_2"></a>
Attributes:</h3>
<p>The <code><TextComponent></code> element has no attributes defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_32_3"></a>
Usage:</h3>
<p>Note: the sub-elements should appear in the order that they are defined here.</p>
<ul>
<li>
<code><Area></code> defining the target area for the text. </li>
<li>
<code><Text></code> optional element specifying the font to be used and text string to be drawn. </li>
<li>
<code><TextProperty></code> optional element specifying the name of a property that contains the text to be drawn. </li>
<li>
<p class="startli"><code><FontProperty></code> optional element specifying the name of a property that contains the name of the font to use when drawing the text.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Optionally specifying the colours for this text, one of the colour elements: </p>
<ul>
<li>
<code><Colours></code> </li>
<li>
<code><ColourProperty></code> </li>
<li>
<code><ColourRectProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">Optionally, to specify the vertical formatting to use, either of: </p>
<ul>
<li>
<code><VertFormat></code> </li>
<li>
<code><VertFormatProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">Optionally, to specify the horizontal formatting to use, either of: </p>
<ul>
<li>
<code><HorzFormat></code> </li>
<li>
<code><HorzFormatProperty></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
The <code><TextComponent></code> element may only appear as a sub-element of the element <code><ImagerySection></code>. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_32_4"></a>
Examples:</h3>
<p>The following example could be used to specify the caption text to appear within a Titlebar style widget: </p>
<div class="fragment"><pre class="fragment">...
<ImagerySection name=<span class="stringliteral">"caption"</span>>
<TextComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"10"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"2"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<ColourProperty name=<span class="stringliteral">"CaptionColour"</span> />
<VertFormat type=<span class="stringliteral">"CentreAligned"</span> />
<HorzFormat type=<span class="stringliteral">"WordWrapLeftAligned"</span> />
</TextComponent>
</ImagerySection>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_33"></a>
<TextProperty> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_33_1"></a>
Purpose:</h3>
<p>The <code><TextProperty></code> element is intended to allow the system to access a property on the target window to obtain the text to be used when rendering the TextComponent being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_33_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the property to access. The value of the named property is taken as a string to be rendered. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_33_3"></a>
Usage:</h3>
<ul>
<li>
The <code><TextProperty></code> element may not contain sub-elements. </li>
<li>
The <code><TextProperty></code> element may appear as a sub-element only within the <code><TextComponent></code> element. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_33_4"></a>
Examples:</h3>
<h2><a class="anchor" id="fal_elem_ref_sec_34"></a>
<UnifiedDim> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_34_1"></a>
Purpose:</h3>
<p>The <code><UnifiedDim></code> element is used to define a component dimension for an area rectangle. <code><UnifiedDim></code> is used to specify a value using the 'unified' co-ordinate system.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_34_2"></a>
Attributes:</h3>
<ul>
<li><code>scale</code> specifies the relative scale component of the UDim. Optional attribute. </li>
<li><code>offset</code> specifies the absolute pixel component of the UDim. Optional attribute. </li>
<li><code>type</code> specifies what the dimension represents. This is needed so that the system knows how to interpret the 'scale' component. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_34_3"></a>
Usage:</h3>
<ul>
<li>
The <code><UnifiedDim></code> element may contain a single <code><DimOperator></code> element in order to form a dimension calculation. </li>
<li>
The <code><UnifiedDim></code> element can appear as a sub-element in <code><Dim></code> to form a dimension specification for an area. </li>
<li>
The <code><UnifiedDim></code> element can appear as a sub-element of <code><DimOperator></code> to specify the second operand for a dimension calculation. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_34_4"></a>
Examples:</h3>
<p>This example shows a dimension that uses <code><UnifiedDim></code> to specify a UDim value to use as the dimension's value: </p>
<div class="fragment"><pre class="fragment">...
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span>>
<UnfiedDim scale=<span class="stringliteral">"0.5"</span> offset=<span class="stringliteral">"-8"</span> type=<span class="stringliteral">"LeftEdge"</span> />
</Dim>
...
</Area>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_35"></a>
<VertAlignment> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_35_1"></a>
Purpose:</h3>
<p>The <code><VertAlignment></code> element is used to specify the vertical alignment option required for a child window element.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_35_2"></a>
Attributes:</h3>
<ul>
<li><code>type</code> specifies one of the values from the VerticalAlignment enumeration indicating the desired vertical alignment.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_35_3"></a>
Usage:</h3>
<ul>
<li>
The <code><VertAlignment></code> element may only appear as a sub-element of the <code><Child></code> element. </li>
<li>
The <code><VertAlignment></code> element may not contain any sub-elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_35_4"></a>
Examples:</h3>
<p>This example defines a scrollbar type child widget. We have used the <code><VertAlignment></code> element to specify that the scrollbar appear on the bottom edge of the component being defined: </p>
<div class="fragment"><pre class="fragment">...
<Child type=<span class="stringliteral">"MyLook/HorzScrollbar"</span> nameSuffix=<span class="stringliteral">"__auto_hscrollbar__"</span>>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width? /></Dim></span>
<span class="stringliteral"> <Dim type="</span>Height<span class="stringliteral">" ><AbsoluteDim value="</span>15<span class="stringliteral">" /></Dim></span>
<span class="stringliteral"> </Area></span>
<span class="stringliteral"> <VertAlignment type="</span>BottomAligned<span class="stringliteral">" /></span>
<span class="stringliteral"></Child></span>
<span class="stringliteral">...</span>
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_36"></a>
<VertFormat> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_36_1"></a>
Purpose:</h3>
<p>The <code><VertFormat></code> element is used to specify the required vertical formatting for an image, frame, or text component.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_36_2"></a>
Attributes:</h3>
<ul>
<li>
<code>type</code> specifies the required vertical formatting option. <ul>
<li>
For use in ImageryComponents and FrameComponents, this will be one of the values from the VerticalFormat enumeration. </li>
<li>
For use in TextComponents, this will one of the values form the VerticalTextFormat enumeration. </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_36_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><VertFormat></code> element may only appear as a sub-element of the elements: </p>
<ul>
<li>
<code><ImageryComponent></code> </li>
<li>
<code><FrameComponent></code> </li>
<li>
<code><TextComponent></code> </li>
</ul>
<p class="endli"></p>
</li>
<li>
The <code><VertFormat></code> element may not contain any sub-elements. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_36_4"></a>
Examples:</h3>
<p>This first example shows an ImageryComponent definition. We use <code><VertFormat></code> to specify that we want the image tiled to cover the entire width of the designated target area: </p>
<div class="fragment"><pre class="fragment">...
<ImageryComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"Width"</span> ><AbsoluteDim value=<span class="stringliteral">"25"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><AbsoluteDim value=<span class="stringliteral">"25"</span> /></Dim>
</Area>
<Image imageset=<span class="stringliteral">"myImageset"</span> image=<span class="stringliteral">"coolImage"</span> />
<VertFormat type=<span class="stringliteral">"Tiled"</span> />
<HorzFormat type=<span class="stringliteral">"Stretched"</span> />
</ImageryComponent>
...
</pre></div><p>This second example is for a TextComponent. You can see <code><VertFormat></code> used here to specify that we want the text centred within the target area: </p>
<div class="fragment"><pre class="fragment">...
<TextComponent>
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> ><AbsoluteDim value=<span class="stringliteral">"0"</span> /></Dim>
<Dim type=<span class="stringliteral">"RightEdge"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width"</span> /></Dim>
<Dim type=<span class="stringliteral">"Height"</span> ><UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Height"</span> /></Dim>
</Area>
<VertFormat type=<span class="stringliteral">"CentreAligned"</span> />
</TextComponent>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_37"></a>
<VertFormatProperty> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_37_1"></a>
Purpose:</h3>
<p>The <code><VertFormatProperty></code> element is intended to allow the system to access a property on the target window to obtain the vertical formatting to be used when drawing the component being defined.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_37_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the property to access. The named property must access a string value that will be set to one of the enumeration values appropriate for the component being defined (VerticalTextFormat for TextComponent, and VerticalFormat for FrameComponent and ImageryComponent). Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_37_3"></a>
Usage:</h3>
<ul>
<li>
<p class="startli">The <code><VertFormatProperty></code> element may not contain sub-elements.</p>
<p class="endli"></p>
</li>
<li>
The <code><VertFormatProperty></code> element may appear as a sub-element within any of the following elements: <ul>
<li>
<code><ImageryComponent></code> to specify a vertical formatting to be used the the image. </li>
<li>
<code><FrameComponent></code> to specify a vertical formatting to be used for the frame background. </li>
<li>
<code><TextComponent></code> to specify a vertical formatting to be used for the text. </li>
</ul>
</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_37_4"></a>
Examples:</h3>
<h2><a class="anchor" id="fal_elem_ref_sec_38"></a>
<WidgetDim> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_38_1"></a>
Purpose:</h3>
<p>The <code><WidgetDim></code> element is used to define a component dimension for an area rectangle. <code><WidgetDim></code> is used to specify some dimension of an attached child widget for use as an area dimension.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_38_2"></a>
Attributes:</h3>
<ul>
<li><code>widget</code> specifies a suffix which will be used when building the name of the widget to access. The final name of the child widget will be that of the parent with this suffix appended. If this is not specified, the target window itself is used. Optional attribute. </li>
<li><code>dimension</code> specifies the widget dimension to be used. This should be set to one of the values defined in the DimensionType enumeration. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_38_3"></a>
Usage:</h3>
<ul>
<li>
The <code><WidgetDim></code> element may contain a single <code><DimOperator></code> element in order to form a dimension calculation. </li>
<li>
The <code><WidgetDim></code> element can appear as a sub-element in <code><Dim></code> to form a dimension specification for an area. </li>
<li>
The <code><WidgetDim></code> element can appear as a sub-element of <code><DimOperator></code> to specify the second operand for a dimension calculation. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_38_4"></a>
Examples:</h3>
<p>This example shows using <code><WidgetDim></code> to obtain dimensions from an attached child widget '__auto_titlebar__', and also from the target window itself: </p>
<div class="fragment"><pre class="fragment">...
<Area>
<Dim type=<span class="stringliteral">"LeftEdge"</span> >
<AbsoluteDim value=<span class="stringliteral">"0"</span> />
</Dim>
<Dim type=<span class="stringliteral">"TopEdge"</span> >
<WidgetDim widget=<span class="stringliteral">"__auto_titlebar__"</span> dimension=<span class="stringliteral">"BottomEdge"</span> />
</Dim>
<Dim type=<span class="stringliteral">"Width"</span> >
<UnifiedDim scale=<span class="stringliteral">"1"</span> type=<span class="stringliteral">"Width"</span> />
</Dim>
<Dim type=<span class="stringliteral">"BottomEdge"</span> >
<WidgetDim dimension=<span class="stringliteral">"BottomEdge"</span> />
</Dim>
</Area>
...
</pre></div><h2><a class="anchor" id="fal_elem_ref_sec_39"></a>
<WidgetLook> Element</h2>
<h3><a class="anchor" id="fal_elem_ref_sec_39_1"></a>
Purpose:</h3>
<p>The <code><WidgetLook></code> element is the most important element within the system. It defines a complete widget 'look' which can be assigned to one of the Falagard base widget classes to create what is essentially a new widget type.</p>
<h3><a class="anchor" id="fal_elem_ref_sec_39_2"></a>
Attributes:</h3>
<ul>
<li><code>name</code> specifies the name of the WidgetLook being defined. If a WidgetLook with this name already exists within the system, it will be replaced with the new definition. Required attribute.</li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_39_3"></a>
Usage:</h3>
<p>Note: the sub-elements should appear in the order that they are defined here.</p>
<ul>
<li>
<p class="startli">The <code><WidgetLook></code> element can contain the following sub-elements: </p>
<ul>
<li>
Any number of <code><PropertyDefinition></code> sub-elements defining new properties. </li>
<li>
Any number of <code><PropertyLinkDefinition></code> sub-elements defining new linked properties. </li>
<li>
Any number of <code><Property></code> sub-elements specifying default property values. </li>
<li>
Any number of <code><NamedArea></code> sub-elements defining areas within the widget. </li>
<li>
Any number of <code><Child></code> sub-elements defining component child widgets. </li>
<li>
Any number of <code><ImagerySection></code> sub-elements defining imagery for the widget. </li>
<li>
Any number of <code><StateImagery></code> sub-elements defining what to draw for widget states. </li>
<li>
Any number of <code><AnimationDefinition></code> sub-elements defining animations for the WidgetLook. See: <a class="el" href="xml_animation.html">Animation XML files.</a> </li>
</ul>
<p class="endli"></p>
</li>
<li>
The <code><WidgetLook></code> element may only appear as sub-elements of the root <code><Falagard></code> element. </li>
</ul>
<h3><a class="anchor" id="fal_elem_ref_sec_39_4"></a>
Examples:</h3>
<p>The following example is the complete definition for 'TaharezLook/ListHeader'. This is a trivial example that actually does no rendering, it just specifies a required property: </p>
<div class="fragment"><pre class="fragment"><WidgetLook name=<span class="stringliteral">"TaharezLook/ListHeader"</span>>
<Property
name=<span class="stringliteral">"SegmentWidgetType"</span>
value=<span class="stringliteral">"TaharezLook/ListHeaderSegment"</span>
/>
<StateImagery name=<span class="stringliteral">"Enabled"</span> />
<StateImagery name=<span class="stringliteral">"Disabled"</span> />
</WidgetLook>
</pre></div> </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>
|
