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
|
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naess�n and Per Larsson
* Copyright (C) 2011-2012 The ManaPlus Developers
*
*
* Per Larsson a.k.a finalman
* Olof Naess�n a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef GCN_WIDGET_HPP
#define GCN_WIDGET_HPP
#include <list>
#include <set>
#include <string>
#include "guichan/color.hpp"
#include "guichan/rectangle.hpp"
#include "localconsts.h"
namespace gcn
{
class ActionListener;
class BasicContainer;
class DeathListener;
class FocusHandler;
class FocusListener;
class Font;
class Graphics;
class KeyInput;
class KeyListener;
class MouseInput;
class MouseListener;
class WidgetListener;
/**
* Abstract class for widgets of Guichan. It contains basic functions
* every widget should have.
*
* NOTE: Functions begining with underscore "_" should not
* be overloaded unless you know what you are doing
*
* @author Olof Naess�n
* @author Per Larsson.
* @since 0.1.0
*/
class GCN_CORE_DECLSPEC Widget
{
public:
/**
* Constructor. Resets member variables. Noteable, a widget is not
* focusable as default, therefore, widgets that are supposed to be
* focusable should overide this default in their own constructor.
*/
Widget();
A_DELETE_COPY(Widget);
/**
* Default destructor.
*/
virtual ~Widget();
/**
* Draws the widget. It is called by the parent widget when it is time
* for the widget to draw itself. The graphics object is set up so
* that all drawing is relative to the widget, i.e coordinate (0,0) is
* the top left corner of the widget. It is not possible to draw
* outside of a widget's dimension.
*
* @param graphics aA graphics object to draw with.
* @since 0.1.0
*/
virtual void draw(Graphics* graphics) = 0;
/**
* Called when a widget is given a chance to draw a frame around itself.
* The frame is not considered a part of the widget, it only allows a frame
* to be drawn around the widget, thus a frame will never be included when
* calculating if a widget should receive events from user input. Also
* a widget's frame will never be included when calculating a widget's
* position.
*
* The size of the frame is calculated using the widget's frame size.
* If a widget has a frame size of 10 pixels than the area the drawFrame
* function can draw to will be the size of the widget with an additional
* extension of 10 pixels in each direction.
*
* An example when drawFrame is a useful function is if a widget needs
* a glow around itself.
*
* @param graphics A graphics object to draw with.
* @see setFrameSize, getFrameSize
* @since 0.8.0
*/
virtual void drawFrame(Graphics* graphics);
/**
* Sets the size of the widget's frame. The frame is not considered a part of
* the widget, it only allows a frame to be drawn around the widget, thus a frame
* will never be included when calculating if a widget should receive events
* from user input. Also a widget's frame will never be included when calculating
* a widget's position.
*
* A frame size of 0 means that the widget has no frame. The default frame size
* is 0.
*
* @param frameSize The size of the widget's frame.
* @see getFrameSize, drawFrame
* @since 0.8.0
*/
void setFrameSize(unsigned int frameSize);
/**
* Gets the size of the widget's frame. The frame is not considered a part of
* the widget, it only allows a frame to be drawn around the widget, thus a frame
* will never be included when calculating if a widget should receive events
* from user input. Also a widget's frame will never be included when calculating
* a widget's position.
*
* A frame size of 0 means that the widget has no frame. The default frame size
* is 0.
*
* @return The size of the widget's frame.
* @see setFrameSize, drawFrame
* @since 0.8.0
*/
unsigned int getFrameSize() const;
/**
* Called for all widgets in the gui each time Gui::logic is called.
* You can do logic stuff here like playing an animation.
*
* @see Gui::logic
* @since 0.1.0
*/
virtual void logic()
{ }
/**
* Gets the widget's parent container.
*
* @return The widget's parent container. NULL if the widget
* has no parent.
* @since 0.1.0
*/
virtual Widget* getParent() const;
/**
* Sets the width of the widget.
*
* @param width The width of the widget.
* @see getWidth, setHeight, getHeight, setSize,
* setDimension, getDimensi
* @since 0.1.0
*/
void setWidth(int width);
/**
* Gets the width of the widget.
*
* @return The width of the widget.
* @see setWidth, setHeight, getHeight, setSize,
* setDimension, getDimension
* @since 0.1.0
*/
int getWidth() const;
/**
* Sets the height of the widget.
*
* @param height The height of the widget.
* @see getHeight, setWidth, getWidth, setSize,
* setDimension, getDimension
* @since 0.1.0
*/
void setHeight(int height);
/**
* Gets the height of the widget.
*
* @return The height of the widget.
* @see setHeight, setWidth, getWidth, setSize,
* setDimension, getDimension
* @since 0.1.0
*/
int getHeight() const;
/**
* Sets the size of the widget.
*
* @param width The width of the widget.
* @param height The height of the widget.
* @see setWidth, setHeight, getWidth, getHeight,
* setDimension, getDimension
* @since 0.1.0
*/
void setSize(int width, int height);
/**
* Sets the x coordinate of the widget. The coordinate is
* relateive to the widget's parent.
*
* @param x The x coordinate of the widget.
* @see getX, setY, getY, setPosition, setDimension, getDimension
* @since 0.1.0
*/
void setX(int x);
/**
* Gets the x coordinate of the widget. The coordinate is
* relative to the widget's parent.
*
* @return The x coordinate of the widget.
* @see setX, setY, getY, setPosition, setDimension, getDimension
* @since 0.1.0
*/
int getX() const;
/**
* Sets the y coordinate of the widget. The coordinate is
* relative to the widget's parent.
*
* @param y The y coordinate of the widget.
* @see setY, setX, getX, setPosition, setDimension, getDimension
* @since 0.1.0
*/
void setY(int y);
/**
* Gets the y coordinate of the widget. The coordinate is
* relative to the widget's parent.
*
* @return The y coordinate of the widget.
* @see setY, setX, getX, setPosition, setDimension, getDimension
* @since 0.1.0
*/
int getY() const;
/**
* Sets position of the widget. The position is relative
* to the widget's parent.
*
* @param x The x coordinate of the widget.
* @param y The y coordinate of the widget.
* @see setX, getX, setY, getY, setDimension, getDimension
* @since 0.1.0
*/
void setPosition(int x, int y);
/**
* Sets the dimension of the widget. The dimension is
* relative to the widget's parent.
*
* @param dimension The dimension of the widget.
* @see getDimension, setX, getX, setY, getY, setPosition
* @since 0.1.0
*/
void setDimension(const Rectangle& dimension);
/**
* Gets the dimension of the widget. The dimension is
* relative to the widget's parent.
*
* @return The dimension of the widget.
* @see getDimension, setX, getX, setY, getY, setPosition
* @since 0.1.0
*/
const Rectangle& getDimension() const;
/**
* Sets the widget to be fosusable, or not.
*
* @param focusable True if the widget should be focusable,
* false otherwise.
* @see isFocusable
* @since 0.1.0
*/
void setFocusable(bool focusable);
/**
* Checks if a widget is focsable.
*
* @return True if the widget should be focusable, false otherwise.
* @see setFocusable
* @since 0.1.0
*/
bool isFocusable() const;
/**
* Checks if the widget is focused.
*
* @return True if the widget is focused, false otherwise.
* @since 0.1.0
*/
virtual bool isFocused() const;
/**
* Sets the widget to enabled, or not. A disabled
* widget will never recieve mouse or key events.
*
* @param enabled True if widget should be enabled,
* false otherwise.
* @see isEnabled
* @since 0.1.0
*/
void setEnabled(bool enabled);
/**
* Checks if the widget is enabled. A disabled
* widget will never recieve mouse or key events.
*
* @return True if widget is enabled, false otherwise.
* @see setEnabled
* @since 0.1.0
*/
bool isEnabled() const;
/**
* Sets the widget to be visible, or not.
*
* @param visible True if widget should be visible, false otherwise.
* @see isVisible
* @since 0.1.0
*/
void setVisible(bool visible);
/**
* Checks if the widget is visible.
*
* @return True if widget is be visible, false otherwise.
* @see setVisible
* @since 0.1.0
*/
bool isVisible() const
{ return mVisible && (!mParent || mParent->isVisible()); }
/**
* Sets the base color of the widget.
*
* @param color The baseground color.
* @see getBaseColor
* @since 0.1.0
*/
void setBaseColor(const Color& color);
/**
* Gets the base color.
*
* @return The base color.
* @see setBaseColor
* @since 0.1.0
*/
const Color& getBaseColor() const;
/**
* Sets the foreground color.
*
* @param color The foreground color.
* @see getForegroundColor
* @since 0.1.0
*/
void setForegroundColor(const Color& color);
/**
* Gets the foreground color.
*
* @see setForegroundColor
* @since 0.1.0
*/
const Color& getForegroundColor() const;
/**
* Sets the background color.
*
* @param color The background Color.
* @see setBackgroundColor
* @since 0.1.0
*/
void setBackgroundColor(const Color& color);
/**
* Gets the background color.
*
* @see setBackgroundColor
* @since 0.1.0
*/
const Color& getBackgroundColor() const;
/**
* Sets the selection color.
*
* @param color The selection color.
* @see getSelectionColor
* @since 0.6.0
*/
void setSelectionColor(const Color& color);
/**
* Gets the selection color.
*
* @return The selection color.
* @see setSelectionColor
* @since 0.6.0
*/
const Color& getSelectionColor() const;
/**
* Requests focus for the widget. A widget will only recieve focus
* if it is focusable.
*/
virtual void requestFocus();
/**
* Requests a move to the top in the parent widget.
*/
virtual void requestMoveToTop();
/**
* Requests a move to the bottom in the parent widget.
*/
virtual void requestMoveToBottom();
/**
* Sets the focus handler to be used.
*
* WARNING: This function is used internally and should not
* be called or overloaded unless you know what you
* are doing.
*
* @param focusHandler The focus handler to use.
* @see _getFocusHandler
* @since 0.1.0
*/
virtual void _setFocusHandler(FocusHandler* focusHandler);
/**
* Gets the focus handler used.
*
* WARNING: This function is used internally and should not
* be called or overloaded unless you know what you
* are doing.
*
* @return The focus handler used.
* @see _setFocusHandler
* @since 0.1.0
*/
virtual FocusHandler* _getFocusHandler();
/**
* Adds an action listener to the widget. When an action event
* is fired by the widget the action listeners of the widget
* will get notified.
*
* @param actionListener The action listener to add.
* @see removeActionListener
* @since 0.1.0
*/
void addActionListener(ActionListener* actionListener);
/**
* Removes an added action listener from the widget.
*
* @param actionListener The action listener to remove.
* @see addActionListener
* @since 0.1.0
*/
void removeActionListener(ActionListener* actionListener);
/**
* Adds a death listener to the widget. When a death event is
* fired by the widget the death listeners of the widget will
* get notified.
*
* @param deathListener The death listener to add.
* @see removeDeathListener
* @since 0.1.0
*/
void addDeathListener(DeathListener* deathListener);
/**
* Removes an added death listener from the widget.
*
* @param deathListener The death listener to remove.
* @see addDeathListener
* @since 0.1.0
*/
void removeDeathListener(DeathListener* deathListener);
/**
* Adds a mouse listener to the widget. When a mouse event is
* fired by the widget the mouse listeners of the widget will
* get notified.
*
* @param mouseListener The mouse listener to add.
* @see removeMouseListener
* @since 0.1.0
*/
void addMouseListener(MouseListener* mouseListener);
/**
* Removes an added mouse listener from the widget.
*
* @param mouseListener The mouse listener to remove.
* @see addMouseListener
* @since 0.1.0
*/
void removeMouseListener(MouseListener* mouseListener);
/**
* Adds a key listener to the widget. When a key event is
* fired by the widget the key listeners of the widget will
* get notified.
*
* @param keyListener The key listener to add.
* @see removeKeyListener
* @since 0.1.0
*/
void addKeyListener(KeyListener* keyListener);
/**
* Removes an added key listener from the widget.
*
* @param keyListener The key listener to remove.
* @see addKeyListener
* @since 0.1.0
*/
void removeKeyListener(KeyListener* keyListener);
/**
* Adds a focus listener to the widget. When a focus event is
* fired by the widget the key listeners of the widget will
* get notified.
*
* @param focusListener The focus listener to add.
* @see removeFocusListener
* @since 0.7.0
*/
void addFocusListener(FocusListener* focusListener);
/**
* Removes an added focus listener from the widget.
*
* @param focusListener The focus listener to remove.
* @see addFocusListener
* @since 0.7.0
*/
void removeFocusListener(FocusListener* focusListener);
/**
* Adds a widget listener to the widget. When a widget event is
* fired by the widget the key listeners of the widget will
* get notified.
*
* @param widgetListener The widget listener to add.
* @see removeWidgetListener
* @since 0.8.0
*/
void addWidgetListener(WidgetListener* widgetListener);
/**
* Removes an added widget listener from the widget.
*
* @param widgetListener The widget listener to remove.
* @see addWidgetListener
* @since 0.8.0
*/
void removeWidgetListener(WidgetListener* widgetListener);
/**
* Sets the action event identifier of the widget. The identifier is
* used to be able to identify which action has occured.
*
* NOTE: An action event identifier should not be used to identify a
* certain widget but rather a certain event in your application.
* Several widgets can have the same action event identifer.
*
* @param actionEventId The action event identifier.
* @see getActionEventId
* @since 0.6.0
*/
void setActionEventId(const std::string& actionEventId);
/**
* Gets the action event identifier of the widget.
*
* @return The action event identifier of the widget.
* @see setActionEventId
* @since 0.6.0
*/
const std::string& getActionEventId() const;
/**
* Gets the absolute position on the screen for the widget.
*
* @param x The absolute x coordinate will be stored in this parameter.
* @param y The absolute y coordinate will be stored in this parameter.
* @since 0.1.0
*/
virtual void getAbsolutePosition(int& x, int& y) const;
/**
* Sets the parent of the widget. A parent must be a BasicContainer.
*
* WARNING: This function is used internally and should not
* be called or overloaded unless you know what you
* are doing.
*
* @param parent The parent of the widget.
* @see getParent
* @since 0.1.0
*/
virtual void _setParent(Widget* parent);
/**
* Gets the font set for the widget. If no font has been set,
* the global font will be returned. If no global font has been set,
* the default font will be returend.
*
* @return The font set for the widget.
* @see setFont, setGlobalFont
* @since 0.1.0
*/
Font *getFont() const;
/**
* Sets the global font to be used by default for all widgets.
*
* @param font The global font.
* @see getGlobalFont
* @since 0.1.0
*/
static void setGlobalFont(Font* font);
/**
* Sets the font for the widget. If NULL is passed, the global font
* will be used.
*
* @param font The font to set for the widget.
* @see getFont
* @since 0.1.0
*/
void setFont(Font* font);
/**
* Called when the font has changed. If the change is global,
* this function will only be called if the widget doesn't have a
* font already set.
*
* @since 0.1.0
*/
virtual void fontChanged()
{ }
/**
* Checks if a widget exists or not, that is if it still exists
* an instance of the object.
*
* @param widget The widget to check.
* @return True if an instance of the widget exists, false otherwise.
* @since 0.1.0
*/
static bool widgetExists(const Widget* widget);
/**
* Checks if tab in is enabled. Tab in means that you can set focus
* to this widget by pressing the tab button. If tab in is disabled
* then the focus handler will skip this widget and focus the next
* in its focus order.
*
* @return True if tab in is enabled, false otherwise.
* @see setTabInEnabled
* @since 0.1.0
*/
bool isTabInEnabled() const;
/**
* Sets tab in enabled, or not. Tab in means that you can set focus
* to this widget by pressing the tab button. If tab in is disabled
* then the FocusHandler will skip this widget and focus the next
* in its focus order.
*
* @param enabled True if tab in should be enabled, false otherwise.
* @see isTabInEnabled
* @since 0.1.0
*/
void setTabInEnabled(bool enabled);
/**
* Checks if tab out is enabled. Tab out means that you can lose
* focus to this widget by pressing the tab button. If tab out is
* disabled then the FocusHandler ignores tabbing and focus will
* stay with this widget.
*
* @return True if tab out is enabled, false otherwise.
* @see setTabOutEnabled
* @since 0.1.0
*/
bool isTabOutEnabled() const;
/**
* Sets tab out enabled. Tab out means that you can lose
* focus to this widget by pressing the tab button. If tab out is
* disabled then the FocusHandler ignores tabbing and focus will
* stay with this widget.
*
* @param enabled True if tab out should be enabled, false otherwise.
* @see isTabOutEnabled
* @since 0.1.0
*/
void setTabOutEnabled(bool enabled);
/**
* Requests modal focus. When a widget has modal focus, only that
* widget and it's children may recieve input.
*
* @throws Exception if another widget already has modal focus.
* @see releaseModalFocus, isModalFocused
* @since 0.4.0
*/
virtual void requestModalFocus();
/**
* Requests modal mouse input focus. When a widget has modal input focus
* that widget will be the only widget receiving input even if the input
* occurs outside of the widget and no matter what the input is.
*
* @throws Exception if another widget already has modal focus.
* @see releaseModalMouseInputFocus, isModalMouseInputFocused
* @since 0.6.0
*/
virtual void requestModalMouseInputFocus();
/**
* Releases modal focus. Modal focus will only be released if the
* widget has modal focus.
*
* @see requestModalFocus, isModalFocused
* @since 0.4.0
*/
virtual void releaseModalFocus();
/**
* Releases modal mouse input focus. Modal mouse input focus will only
* be released if the widget has modal mouse input focus.
*
* @see requestModalMouseInputFocus, isModalMouseInputFocused
* @since 0.6.0
*/
virtual void releaseModalMouseInputFocus();
/**
* Checks if the widget or it's parent has modal focus.
*
* @return True if the widget has modal focus, false otherwise.
* @see requestModalFocus, releaseModalFocus
* @since 0.8.0
*/
virtual bool isModalFocused() const;
/**
* Checks if the widget or it's parent has modal mouse input focus.
*
* @return True if the widget has modal mouse input focus, false
* otherwise.
* @see requestModalMouseInputFocus, releaseModalMouseInputFocus
* @since 0.8.0
*/
virtual bool isModalMouseInputFocused() const;
/**
* Gets a widget from a certain position in the widget.
* This function is used to decide which gets mouse input,
* thus it can be overloaded to change that behaviour.
*
* NOTE: This always returns NULL if the widget is not
* a container.
*
* @param x The x coordinate of the widget to get.
* @param y The y coordinate of the widget to get.
* @return The widget at the specified coodinate, NULL
* if no widget is found.
* @since 0.6.0
*/
virtual Widget *getWidgetAt(int x, int y);
/**
* Gets the mouse listeners of the widget.
*
* @return The mouse listeners of the widget.
* @since 0.6.0
*/
virtual const std::list<MouseListener*>& _getMouseListeners();
/**
* Gets the key listeners of the widget.
*
* @return The key listeners of the widget.
* @since 0.6.0
*/
virtual const std::list<KeyListener*>& _getKeyListeners();
/**
* Gets the focus listeners of the widget.
*
* @return The focus listeners of the widget.
* @since 0.7.0
*/
virtual const std::list<FocusListener*>& _getFocusListeners();
/**
* Gets the area of the widget occupied by the widget's children.
* By default this method returns an empty rectangle as not all
* widgets are containers. If you want to make a container this
* method should return the area where the children resides. This
* method is used when drawing children of a widget when computing
* clip rectangles for the children.
*
* An example of a widget that overloads this method is ScrollArea.
* A ScrollArea has a view of its contant and that view is the
* children area. The size of a ScrollArea's children area might
* vary depending on if the scroll bars of the ScrollArea is shown
* or not.
*
* @return The area of the widget occupied by the widget's children.
* @see BasicContainer
* @see BasicContainer::getChildrenArea
* @see BasicContainer::drawChildren
* @since 0.1.0
*/
virtual Rectangle getChildrenArea();
/**
* Gets the internal focus handler used.
*
* @return the internalFocusHandler used. If no internal focus handler
* is used, NULL will be returned.
* @see setInternalFocusHandler
* @since 0.1.0
*/
virtual FocusHandler* _getInternalFocusHandler();
/**
* Sets the internal focus handler. An internal focus handler is
* needed if both a widget in the widget and the widget itself
* should be foucsed at the same time.
*
* @param focusHandler The internal focus handler to be used.
* @see getInternalFocusHandler
* @since 0.1.0
*/
void setInternalFocusHandler(FocusHandler* internalFocusHandler);
/**
* Moves a widget to the top of this widget. The moved widget will be
* drawn above all other widgets in this widget.
*
* @param widget The widget to move to the top.
* @see moveToBottom
* @since 0.1.0
*/
virtual void moveToTop(Widget* widget A_UNUSED)
{ };
/**
* Moves a widget in this widget to the bottom of this widget.
* The moved widget will be drawn below all other widgets in this widget.
*
* @param widget The widget to move to the bottom.
* @see moveToTop
* @since 0.1.0
*/
virtual void moveToBottom(Widget* widget A_UNUSED)
{ };
/**
* Focuses the next widget in the widget.
*
* @see moveToBottom
* @since 0.1.0
*/
virtual void focusNext()
{ };
/**
* Focuses the previous widget in the widget.
*
* @see moveToBottom
* @since 0.1.0
*/
virtual void focusPrevious()
{ };
/**
* Tries to show a specific part of a widget by moving it. Used if the
* widget should act as a container.
*
* @param widget The target widget.
* @param area The area to show.
* @since 0.1.0
*/
virtual void showWidgetPart(Widget* widget A_UNUSED,
Rectangle area A_UNUSED)
{ };
/**
* Sets an id of a widget. An id can be useful if a widget needs to be
* identified in a container. For example, if widgets are created by an
* XML document, a certain widget can be retrieved given that the widget
* has an id.
*
* @param id The id to set to the widget.
* @see getId, BasicContainer::findWidgetById
* @since 0.8.0
*/
void setId(const std::string& id);
/**
* Gets the id of a widget. An id can be useful if a widget needs to be
* identified in a container. For example, if widgets are created by an
* XML document, a certain widget can be retrieved given that the widget
* has an id.
*
* @param id The id to set to the widget.
* @see setId, BasicContainer::findWidgetById
* @since 0.8.0
*/
const std::string& getId();
/**
* Shows a certain part of a widget in the widget's parent.
* Used when widgets want a specific part to be visible in
* its parent. An example is a TextArea that wants a specific
* part of its text to be visible when a TextArea is a child
* of a ScrollArea.
*
* @param rectangle The rectangle to be shown.
* @since 0.8.0
*/
virtual void showPart(Rectangle rectangle);
protected:
/**
* Distributes an action event to all action listeners
* of the widget.
*
* @since 0.8.0
*/
void distributeActionEvent();
/**
* Distributes resized events to all of the widget's listeners.
*
* @since 0.8.0
*/
void distributeResizedEvent();
/**
* Distributes moved events to all of the widget's listeners.
*
* @since 0.8.0
*/
void distributeMovedEvent();
/**
* Distributes hidden events to all of the widget's listeners.
*
* @since 0.8.0
* @author Olof Naess�n
*/
void distributeHiddenEvent();
/**
* Distributes shown events to all of the widget's listeners.
*
* @since 0.8.0
* @author Olof Naess�n
*/
void distributeShownEvent();
/**
* Typdef.
*/
typedef std::list<MouseListener*> MouseListenerList;
/**
* Typdef.
*/
typedef MouseListenerList::iterator MouseListenerIterator;
/**
* Holds the mouse listeners of the widget.
*/
MouseListenerList mMouseListeners;
/**
* Typdef.
*/
typedef std::list<KeyListener*> KeyListenerList;
/**
* Holds the key listeners of the widget.
*/
KeyListenerList mKeyListeners;
/**
* Typdef.
*/
typedef KeyListenerList::iterator KeyListenerIterator;
/**
* Typdef.
*/
typedef std::list<ActionListener*> ActionListenerList;
/**
* Holds the action listeners of the widget.
*/
ActionListenerList mActionListeners;
/**
* Typdef.
*/
typedef ActionListenerList::iterator ActionListenerIterator;
/**
* Typdef.
*/
typedef std::list<DeathListener*> DeathListenerList;
/**
* Holds the death listeners of the widget.
*/
DeathListenerList mDeathListeners;
/**
* Typdef.
*/
typedef DeathListenerList::iterator DeathListenerIterator;
/**
* Typdef.
*/
typedef std::list<FocusListener*> FocusListenerList;
/**
* Holds the focus listeners of the widget.
*/
FocusListenerList mFocusListeners;
/**
* Typdef.
*/
typedef FocusListenerList::iterator FocusListenerIterator;
typedef std::list<WidgetListener*> WidgetListenerList;
/**
* Holds the widget listeners of the widget.
*/
WidgetListenerList mWidgetListeners;
/**
* Typdef.
*/
typedef WidgetListenerList::iterator WidgetListenerIterator;
/**
* Holds the foreground color of the widget.
*/
Color mForegroundColor;
/**
* Holds the background color of the widget.
*/
Color mBackgroundColor;
/**
* Holds the base color of the widget.
*/
Color mBaseColor;
/**
* Holds the selection color of the widget.
*/
Color mSelectionColor;
/**
* Holds the focus handler used by the widget.
*/
FocusHandler* mFocusHandler;
/**
* Holds the focus handler used by the widget. NULL
* if no internal focus handler is used.
*/
FocusHandler* mInternalFocusHandler;
/**
* Holds the parent of the widget. NULL if the widget
* has no parent.
*/
Widget* mParent;
/**
* Holds the dimension of the widget.
*/
Rectangle mDimension;
/**
* Holds the frame size of the widget.
*/
unsigned int mFrameSize;
/**
* Holds the action event of the widget.
*/
std::string mActionEventId;
/**
* True if the widget focusable, false otherwise.
*/
bool mFocusable;
/**
* True if the widget visible, false otherwise.
*/
bool mVisible;
/**
* True if the widget has tab in enabled, false otherwise.
*/
bool mTabIn;
/**
* True if the widget has tab in enabled, false otherwise.
*/
bool mTabOut;
/**
* True if the widget is enabled, false otherwise.
*/
bool mEnabled;
/**
* Holds the id of the widget.
*/
std::string mId;
/**
* Holds the font used by the widget.
*/
Font* mCurrentFont;
/**
* Holds the global font used by the widget.
*/
static Font* mGlobalFont;
/**
* Holds a list of all instances of widgets.
*/
static std::list<Widget*> mWidgets;
static std::set<Widget*> mWidgetsSet;
};
}
#endif // end GCN_WIDGET_HPP
|