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
|
<!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 Window Renderer Requirements</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 Window Renderer Requirements </div> </div>
</div>
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="fal_wr_ref_sec_0"></a>
Section Contents</h2>
<p><a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_1">Falagard/Button</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_2">Falagard/Default</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_3">Falagard/Editbox</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_4">Falagard/FrameWindow</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_5">Falagard/ItemEntry</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_6">Falagard/ItemListbox</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_7">Falagard/Listbox</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_8">Falagard/ListHeader</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_9">Falagard/ListHeaderSegment</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_10">Falagard/Menubar</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_11">Falagard/MenuItem</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_12">Falagard/MultiColumnList</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_13">Falagard/MultiLineEditbox</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_14">Falagard/PopupMenu</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_15">Falagard/ProgressBar</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_16">Falagard/ToggleButton</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_17">Falagard/ScrollablePane</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_18">Falagard/Scrollbar</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_19">Falagard/Slider</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_20">Falagard/Static</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_21">Falagard/StaticImage</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_22">Falagard/StaticText</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_23">Falagard/SystemButton</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_24">Falagard/TabButton</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_25">Falagard/TabControl</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_26">Falagard/Titlebar</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_27">Falagard/Tooltip</a> <br/>
<a class="el" href="fal_wr_ref.html#fal_wr_ref_sec_28">Falagard/Tree</a> <br/>
</p>
<h2><a class="anchor" id="fal_wr_ref_sec_1"></a>
Falagard/Button</h2>
<p>General purpose push button widget class.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
StateImagery definitions (missing states will default to 'Normal'): <ul>
<li>
Normal - Imagery used when the widget is neither pushed nor has the mouse hovering over it. </li>
<li>
Hover - Imagery used when the widget is not pushed and has the mouse hovering over it. </li>
<li>
Pushed - Imagery used when the widget is pushed and the mouse is over the widget. </li>
<li>
PushedOff - Imagery used when the widget is pushed and the mouse is not over the widget. </li>
<li>
Disabled - Imagery used when the widget is disabled. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_2"></a>
Falagard/Default</h2>
<p>Generic window which can be used as a container window, amongst other uses.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
StateImagery definitions: <ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_3"></a>
Falagard/Editbox</h2>
<p>General purpose single-line text box widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - Imagery used when widget is enabled. </li>
<li>
Disabled - Imagery used when widget is disabled. </li>
<li>
ReadOnly - Imagery used when widget is in 'Read Only' state. </li>
<li>
ActiveSelection - Additional imagery used when a text selection is defined and the widget is active. The imagery for this state will be rendered within the selection area. </li>
<li>
InactiveSelection - Additional imagery used when a text selection is defined and the widget is not active. The imagery for this state will be rendered within the selection area. </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">NamedArea definitions: </p>
<ul>
<li>
TextArea - Defines the area where the text, carat, and any selection imagery will appear. </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">PropertyDefinition specifications (optional, defaults will be black): </p>
<ul>
<li>
NormalTextColour - property that accesses a colour value to be used to render normal unselected text. </li>
<li>
SelectedTextColour - property that accesses a colour value to be used to render selected text. </li>
</ul>
<p class="endli"></p>
</li>
<li>
ImagerySection definitions: <ul>
<li>
Carat - Additional imagery used to display the insertion position carat. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_4"></a>
Falagard/FrameWindow</h2>
<p>General purpose window type which can be sized and moved.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
ActiveWithTitleWithFrame - Imagery used when the widget has its title bar enabled, has its frame enabled, and is active. </li>
<li>
InactiveWithTitleWithFrame - Imagery used when the widget has its title bar enabled, has its frame enabled, and is inactive. </li>
<li>
DisabledWithTitleWithFrame - Imagery used when the widget has its title bar enabled, has its frame enabled, and is disabled. </li>
<li>
ActiveWithTitleNoFrame - Imagery used when the widget has its title bar enabled, has its frame disabled, and is active. </li>
<li>
InactiveWithTitleNoFrame - Imagery used when the widget has its title bar enabled, has its frame disabled, and is inactive. </li>
<li>
DisabledWithTitleNoFrame - Imagery used when the widget has its title bar enabled, has its frame disabled, and is disabled. </li>
<li>
ActiveNoTitleWithFrame - Imagery used when the widget has its title bar disabled, has its frame enabled, and is active. </li>
<li>
InactiveNoTitleWithFrame - Imagery used when the widget has its title bar disabled, has its frame enabled, and is inactive. </li>
<li>
DisabledNoTitleWithFrame - Imagery used when the widget has its title bar disabled, has its frame enabled, and is disabled. </li>
<li>
ActiveNoTitleNoFrame - Imagery used when the widget has its title bar disabled, has its frame disabled, and is active. </li>
<li>
InactiveNoTitleNoFrame - Imagery used when the widget has its title bar disabled, has its frame disabled, and is inactive. </li>
<li>
DisabledNoTitleNoFrame - Imagery used when the widget has its title bar disabled, has its frame disabled, and is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
ClientWithTitleWithFrame - Area that defines the clipping region for the client area when the widget has its title bar enabled, and has its frame enabled. </li>
<li>
ClientWithTitleNoFrame - Area that defines the clipping region for the client area when the widget has its title bar enabled, and has its frame disabled. </li>
<li>
ClientNoTitleWithFrame - Area that defines the clipping region for the client area when the widget has its title bar disabled, and has its frame enabled. </li>
<li>
ClientNoTitleNoFrame - Area that defines the clipping region for the client area when the widget has its title bar disabled, and has its frame disabled. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_5"></a>
Falagard/ItemEntry</h2>
<p>Basic class that may be added to any of the ItemListBase base classes.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
ContentSize - Area defining the size of the item content. Required. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_6"></a>
Falagard/ItemListbox</h2>
<p>Improved single column list widget that is able to make use of ItemEntry based windows for listbox items.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
ItemRenderingArea - Target area where list items will appear when no scrollbars are visible (also acts as default area). Required. </li>
<li>
ItemRenderingAreaHScroll - Target area where list items will appear when the horizontal scrollbar is visible. Optional. </li>
<li>
ItemRenderingAreaVScroll - Target area where list items will appear when the vertical scrollbar is visible. Optional. </li>
<li>
ItemRenderingAreaHVScroll - Target area where list items will appear when both the horizontal and vertical scrollbars are visible. Optional. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_7"></a>
Falagard/Listbox</h2>
<p>General purpose single column list widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions (you should choose one set, or the other): <ul>
<li>
ItemRenderingArea - Target area where list items will appear when no scrollbars are visible (also acts as default area). Required. </li>
<li>
ItemRenderingAreaHScroll - Target area where list items will appear when the horizontal scrollbar is visible. Optional. </li>
<li>
ItemRenderingAreaVScroll - Target area where list items will appear when the vertical scrollbar is visible. Optional. </li>
<li>
ItemRenderingAreaHVScroll - Target area where list items will appear when both the horizontal and vertical scrollbars are visible. Optional. </li>
</ul>
</li>
<li>
OR: <ul>
<li>
ItemRenderArea - Target area where list items will appear when no scrollbars are visible (also acts as default area). Required. </li>
<li>
ItemRenderAreaHScroll - Target area where list items will appear when the horizontal scrollbar is visible. Optional. </li>
<li>
ItemRenderAreaVScroll - Target area where list items will appear when the vertical scrollbar is visible. Optional. </li>
<li>
ItemRenderAreaHVScroll - Target area where list items will appear when both the horizontal and vertical scrollbars are visible. Optional. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_8"></a>
Falagard/ListHeader</h2>
<p>List header widget. Acts as a container for ListHeaderSegment based widgets. Usually used as a component part widget for multi-column list widgets.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
Property initialiser definitions: <ul>
<li>
SegmentWidgetType - specifies the name of a "ListHeaderSegment" based widget type; an instance of which will be created for each column within the header. (Required) </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_9"></a>
Falagard/ListHeaderSegment</h2>
<p>Widget type intended for use as a single column header within a list header widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Disabled - Imagery to use when the widget is disabled. </li>
<li>
Normal - Imagery to use when the widget is enabled and the mouse is not within any part of the segment widget. </li>
<li>
Hover - Imagery to use when the widget is enabled and the mouse is within the main area of the widget (not the drag-sizing 'splitter' area). </li>
<li>
SplitterHover - Imagery to use when the widget is enabled and the mouse is within the drag-sizing 'splitter' area. </li>
<li>
DragGhost - Imagery to use for the drag-moving 'ghost' of the segment. This state should specify that its imagery be render unclipped. </li>
<li>
AscendingSortIcon - Additional imagery used when the segment has the ascending sort direction set. </li>
<li>
DescendingSortDown - Additional imagery used when the segment has the descending sort direction set. </li>
<li>
GhostAscendingSortIcon - Additional imagery used for the drag-moving 'ghost' when the segment has the ascending sort direction set. </li>
<li>
GhostDescendingSortDown - Additional imagery used for the drag-moving 'ghost' when the segment has the descending sort direction set. </li>
</ul>
<p class="endli"></p>
</li>
<li>
Property initialiser definitions: <ul>
<li>
MovingCursorImage - Property to define a mouse cursor image to use when drag-moving the widget. (Optional). </li>
<li>
SizingCursorImage - Property to define a mouse cursor image to use when drag-sizing the widget. (Optional). </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_10"></a>
Falagard/Menubar</h2>
<p>General purpose horizontal menu bar widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
ItemRenderArea - Target area where menu items will appear. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_11"></a>
Falagard/MenuItem</h2>
<p>General purpose textual menu item widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
EnabledNormal - Imagery used when the item is enabled and the mouse is not within its area. </li>
<li>
EnabledHover - Imagery used when the item is enabled and the mouse is within its area. </li>
<li>
EnabledPushed - Imagery used when the item is enabled and user has pushed the mouse button over it. </li>
<li>
EnabledPopupOpen - Imagery used when the item is enabled and attached popup menu is opened. </li>
<li>
DisabledNormal - Imagery used when the item is disabled and the mouse is not within its area. </li>
<li>
DisabledHover - Imagery used when the item is disabled and the mouse is within its area. </li>
<li>
DisabledPushed - Imagery used when the item is disabled and user has pushed the mouse button over it. </li>
<li>
DisabledPopupOpen - Imagery used when the item is disabled and attached popup menu is opened. </li>
<li>
PopupClosedIcon - Additional imagery used when the item is attached to a popup menu widget and has a a 'sub' popup menu attached to itself, and that popup is closed. </li>
<li>
PopupOpenIcon - Additional imagery used when the item is attached to a popup menu widget and has a a 'sub' popup menu attached to itself, and that popup is open. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
ContentSize - Area defining the size of this item's content. Required. </li>
<li>
HasPopupContentSize - Area defining the size of this item's content if the item has an attached popup menu and is not attached to a Menubar (basically the content size with allowance for the 'popup icon'. Optional. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_12"></a>
Falagard/MultiColumnList</h2>
<p>General purpose multi-column list / grid widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
ItemRenderingArea - Target area where list items will appear when no scrollbars are visible (also acts as default area). Required. </li>
<li>
ItemRenderingAreaHScroll - Target area where list items will appear when the horizontal scrollbar is visible. Optional. </li>
<li>
ItemRenderingAreaVScroll - Target area where list items will appear when the vertical scrollbar is visible. Optional. </li>
<li>
ItemRenderingAreaHVScroll - Target area where list items will appear when both the horizontal and vertical scrollbars are visible. Optional. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_13"></a>
Falagard/MultiLineEditbox</h2>
<p>General purpose multi-line text box widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - Imagery used when widget is enabled. </li>
<li>
Disabled - Imagery used when widget is disabled. </li>
<li>
ReadOnly - Imagery used when widget is in 'Read Only' state. </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">NamedArea definitions: </p>
<ul>
<li>
TextArea - Target area where text lines will appear when no scrollbars are visible (also acts as default area). Required. </li>
<li>
TextAreaHScroll - Target area where text lines will appear when the horizontal scrollbar is visible. Optional. </li>
<li>
TextAreaVScroll - Target area where text lines will appear when the vertical scrollbar is visible. Optional. </li>
<li>
TextAreaHVScroll - Target area where text lines will appear when both the horizontal and vertical scrollbars are visible. Optional. </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">ImagerySection definitions: </p>
<ul>
<li>
Carat - Additional imagery used to display the insertion position carat. </li>
</ul>
<p class="endli"></p>
</li>
<li>
PropertyDefinition specifications (optional, defaults will be black): <ul>
<li>
NormalTextColour - property that accesses a colour value to be used to render normal unselected text. </li>
<li>
SelectedTextColour - property that accesses a colour value to be used to render selected text. </li>
<li>
ActiveSelectionColour - property that accesses a colour value to be used to render active selection highlight. </li>
<li>
InactiveSelectionColour - property that accesses a colour value to be used to render inactive selection highlight. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_14"></a>
Falagard/PopupMenu</h2>
<p>General purpose popup menu widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
ItemRenderArea - Target area where menu items will appear. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_15"></a>
Falagard/ProgressBar</h2>
<p>General purpose progress widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery used when widget is enabled. </li>
<li>
Disabled - General imagery used when widget is disabled. </li>
<li>
EnabledProgress - imagery for 100\ progress used when widget is enabled. The drawn imagery will appear in named area "ProgressArea" and will be clipped appropriately according to widget settings and the current progress value. </li>
<li>
DisabledProgress - imagery for 100\ progress used when widget is disabled. The drawn imagery will appear in named area "ProgressArea" and will be clipped appropriately according to widget settings and the current progress value. </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">NamedArea definitions: </p>
<ul>
<li>
ProgressArea - Target area where progress imagery will appear. </li>
</ul>
<p class="endli"></p>
</li>
<li>
Property initialiser definitions: <ul>
<li>
VerticalProgress - boolean property. Determines whether the progress widget is horizontal or vertical. Default is horizontal. Optional. </li>
<li>
ReversedProgress - boolean property. Determines whether the progress grows in the opposite direction to what is considered 'usual'. Set to "True" to have progress grow towards the left or bottom of the progress area. Optional. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_16"></a>
Falagard/ToggleButton</h2>
<p>General purpose radio button style widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
StateImagery definitions (missing states will default to 'Normal' or 'SelectedNormal'): <ul>
<li>
Normal - Imagery used when the widget is in the deselected / off state, and is neither pushed nor has the mouse hovering over it. </li>
<li>
Hover - Imagery used when the widget is in the deselected / off state, and has the mouse hovering over it. </li>
<li>
Pushed - Imagery used when the widget is in the deselected / off state, is pushed and has mouse over the widget. </li>
<li>
PushedOff - Imagery used when the widget is in the deselected / off state, is pushed and does not have the mouse over the widget. </li>
<li>
Disabled - Imagery used when the widget is in the deselected / off state, and is disabled. </li>
<li>
SelectedNormal - Imagery used when the widget is in the selected / on state, and is neither pushed nor has the mouse hovering over it. </li>
<li>
SelectedHover - Imagery used when the widget is in the selected / on state, and has the mouse hovering over it. </li>
<li>
SelectedPushed - Imagery used when the widget is in the selected / on state, is pushed and has the mouse over the widget. </li>
<li>
SelectedPushedOff - Imagery used when the widget is in the selected / on state, is pushed and does not have the mouse over the widget. </li>
<li>
SelectedDisabled - Imagery used when the widget is in the selected / on state, and is disabled. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_17"></a>
Falagard/ScrollablePane</h2>
<p>General purpose scrollable pane widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
ViewableArea - Target area where visible content will appear when no scrollbars are visible (also acts as default area). Required. </li>
<li>
ViewableAreaHScroll - Target area where visible content will appear when the horizontal scrollbar is visible. Optional. </li>
<li>
ViewableAreaVScroll - Target area where visible content will appear when the vertical scrollbar is visible. Optional. </li>
<li>
ViewableAreaHVScroll - Target area where visible content will appear when both the horizontal and vertical scrollbars are visible. Optional. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_18"></a>
Falagard/Scrollbar</h2>
<p>General purpose scrollbar widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">NamedArea definitions: </p>
<ul>
<li>
ThumbTrackArea - Target area in which thumb may be moved. </li>
</ul>
<p class="endli"></p>
</li>
<li>
Property initialiser definitions: <ul>
<li>
VerticalScrollbar - boolean property. Indicates whether this scrollbar will operate in the vertical or horizontal direction. Default is for horizontal. Optional. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_19"></a>
Falagard/Slider</h2>
<p>General purpose slider widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">NamedArea definitions: </p>
<ul>
<li>
ThumbTrackArea - Target area in which thumb may be moved. </li>
</ul>
<p class="endli"></p>
</li>
<li>
Property initialiser definitions: <ul>
<li>
VerticalSlider - boolean property. Indicates whether this slider will operate in the vertical or horizontal direction. Default is for horizontal. Optional. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_20"></a>
Falagard/Static</h2>
<p>Generic non-interactive 'static' widget. Used as a base class for Falagard/StaticImage and Falagard/StaticText.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
StateImagery definitions: <ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
<li>
EnabledFrame - Additional imagery used when the widget is enabled and the widget frame is enabled. </li>
<li>
DisabledFrame - Additional imagery used when the widget is disabled and the widget frame is enabled. </li>
<li>
WithFrameEnabledBackground - Additional imagery used when the widget is enabled, the widget frame is enabled, and the widget background is enabled. </li>
<li>
WithFrameDisabledBackground - Additional imagery used when the widget is disabled, the widget frame is enabled, and the widget background is enabled. </li>
<li>
NoFrameEnabledBackground - Additional imagery used when the widget is enabled, the widget frame is disabled, and the widget background is enabled. </li>
<li>
NoFrameDisabledBackground - Additional imagery used when the widget is disabled, the widget frame is disabled, and the widget background is enabled. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_21"></a>
Falagard/StaticImage</h2>
<p>Static widget that displays a configurable image.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
StateImagery definitions: <ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
<li>
EnabledFrame - Additional imagery used when the widget is enabled and the widget frame is enabled. </li>
<li>
DisabledFrame - Additional imagery used when the widget is disabled and the widget frame is enabled. </li>
<li>
WithFrameEnabledBackground - Additional imagery used when the widget is enabled, the widget frame is enabled, and the widget background is enabled. </li>
<li>
WithFrameDisabledBackground - Additional imagery used when the widget is disabled, the widget frame is enabled, and the widget background is enabled. </li>
<li>
NoFrameEnabledBackground - Additional imagery used when the widget is enabled, the widget frame is disabled, and the widget background is enabled. </li>
<li>
NoFrameDisabledBackground - Additional imagery used when the widget is disabled, the widget frame is disabled, and the widget background is enabled. </li>
<li>
WithFrameImage - Image rendering when the frame is enabled. </li>
<li>
NoFrameImage - Image rendering when the frame is disabled. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_22"></a>
Falagard/StaticText</h2>
<p>Static widget that displays configurable text.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
<li>
EnabledFrame - Additional imagery used when the widget is enabled and the widget frame is enabled. </li>
<li>
DisabledFrame - Additional imagery used when the widget is disabled and the widget frame is enabled. </li>
<li>
WithFrameEnabledBackground - Additional imagery used when the widget is enabled, the widget frame is enabled, and the widget background is enabled. </li>
<li>
WithFrameDisabledBackground - Additional imagery used when the widget is disabled, the widget frame is enabled, and the widget background is enabled. </li>
<li>
NoFrameEnabledBackground - Additional imagery used when the widget is enabled, the widget frame is disabled, and the widget background is enabled. </li>
<li>
NoFrameDisabledBackground - Additional imagery used when the widgetis disabled, the widget frame is disabled, and the widget background is enabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">NamedArea definitions (missing areas will default to WithFrameTextRenderArea): </p>
<ul>
<li>
WithFrameTextRenderArea - Target area where text will appear when the frame is enabled and no scrollbars are visible (also acts as default area). Required. </li>
<li>
WithFrameTextRenderAreaHScroll - Target area where text will appear when the frame is enabled and the horizontal scrollbar is visible. Optional. </li>
<li>
WithFrameTextRenderAreaVScroll - Target area where text will appear when the frame is enabled and the vertical scrollbar is visible. Optional. </li>
<li>
WithFrameTextRenderAreaHVScroll - Target area where text will appear when the frame is enabled and both the horizontal and vertical scrollbars are visible. Optional. </li>
<li>
NoFrameTextRenderArea - Target area where text will appear when the frame is disabled and no scrollbars are visible (also acts as default area). Optional. </li>
<li>
NoFrameTextRenderAreaHScroll - Target area where text will appear when the frame is disabled and the horizontal scrollbar is visible. Optional. </li>
<li>
NoFrameTextRenderAreaVScroll - Target area where text will appear when the frame is disabled and the vertical scrollbar is visible. Optional. </li>
<li>
NoFrameTextRenderAreaHVScroll - Target area where text will appear when the frame is disabled and both the horizontal and vertical scrollbars are visible. Optional. </li>
</ul>
<p class="endli"></p>
</li>
<li>
Child widget definitions: <ul>
<li>
Scrollbar based widget with name suffix "__auto_vscrollbar__". This widget will be used to control vertical scroll position. </li>
<li>
Scrollbar based widget with name suffix "__auto_hscrollbar__". This widget will be used to control horizontal scroll position. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_23"></a>
Falagard/SystemButton</h2>
<p>Specialised push button widget intended to be used for 'system' buttons appearing outside of the client area of a frame window style widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
StateImagery definitions (missing states will default to 'Normal'): <ul>
<li>
Normal - Imagery used when the widget is neither pushed nor has the mouse hovering over it. </li>
<li>
Hover - Imagery used when the widget is not pushed and has the mouse hovering over it. </li>
<li>
Pushed - Imagery used when the widget is pushed and the mouse is over the widget. </li>
<li>
PushedOff - Imagery used when the widget is pushed and the mouse is not over the widget. </li>
<li>
Disabled - Imagery used when the widget is disabled. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_24"></a>
Falagard/TabButton</h2>
<p>Special widget type used for tab buttons within a tab control based widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
StateImagery definitions (missing states will default to 'Normal'): <ul>
<li>
Normal - Imagery used when the widget is neither selected nor has the mouse hovering over it. </li>
<li>
Hover - Imagery used when the widget has the mouse hovering over it. </li>
<li>
Selected - Imagery used when the widget is the active / selected tab. </li>
<li>
Disabled - Imagery used when the widget is disabled. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_25"></a>
Falagard/TabControl</h2>
<p>General purpose tab control widget.</p>
<p>The current TabControl base class enforces a fairly strict layout, so while imagery can be customised as desired, the general layout of the component widgets is, at least for the time being, mostly fixed.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
Property initialiser definitions: <ul>
<li>
TabButtonType - specifies a TabButton based widget type to be created each time a new tab button is required. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_26"></a>
Falagard/Titlebar</h2>
<p>Title bar widget intended for use as the title bar of a frame window widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
StateImagery definitions (missing states will default to 'Normal'): <ul>
<li>
Active - Imagery used when the widget is active. </li>
<li>
Inactive - Imagery used when the widget is inactive. </li>
<li>
Disabled - Imagery used when the widget is disabled. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_27"></a>
Falagard/Tooltip</h2>
<p>General purpose tool-tip widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
TextArea - Typically this would be the same area as the TextComponent you define to receive the tool-tip text. This named area is used when deciding how to dynamically size the tool-tip so that text is not clipped. </li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="fal_wr_ref_sec_28"></a>
Falagard/Tree</h2>
<p>Basic Tree type widget.</p>
<p>Assigned WidgetLook should provide the following: </p>
<ul>
<li>
<p class="startli">StateImagery definitions: </p>
<ul>
<li>
Enabled - General imagery for when the widget is enabled. </li>
<li>
Disabled - General imagery for when the widget is disabled. </li>
</ul>
<p class="endli"></p>
</li>
<li>
NamedArea definitions: <ul>
<li>
ItemRenderingArea - Target area where tree items will appear when no scrollbars are visible (also acts as default area). Required. </li>
<li>
ItemRenderingAreaHScroll - Target area where tree items will appear when the horizontal scrollbar is visible. Optional. </li>
<li>
ItemRenderingAreaVScroll - Target area where tree items will appear when the vertical scrollbar is visible. Optional. </li>
<li>
ItemRenderingAreaHVScroll - Target area where tree items will appear when both the horizontal and vertical scrollbars are visible. Optional. </li>
</ul>
</li>
</ul>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
