aboutsummaryrefslogtreecommitdiffstats
path: root/src/gwin/gwin.h
blob: 557d3373694767359b9e0cb8e5f42fb65332a9c5 (plain)
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
/*
 * This file is subject to the terms of the GFX License. If a copy of
 * the license was not distributed with this file, you can obtain one at:
 *
 *              http://ugfx.org/license.html
 */

/**
 * @file    src/gwin/gwin.h
 *
 * @defgroup Window Window
 * @ingroup Windows
 *
 * @brief		The basic window implementation (base class).
 *
 * @details		GWIN provides a basic window manager which allows it to easily
 *				create and destroy different windows at runtime. Each window
 *				will have it's own properties such as colors as well as
 *				it's own drawing origin.
 *
 * @pre		GFX_USE_GWIN must be set to GFXON in your gfxconf.h
 * @{
 */

#ifndef _GWIN_H
#define _GWIN_H

#include "../../gfx.h"

#if GFX_USE_GWIN || defined(__DOXYGEN__)

/* Forward declaration */
typedef struct GWindowObject *GHandle;

/**
 * @brief	A window object structure
 * @note	Do not access the members directly. Treat it as a black-box and use the method functions.
 * @{
 */
typedef struct GWindowObject {
	#if GWIN_NEED_WINDOWMANAGER
		// This MUST be the first member of the structure
		gfxQueueASyncItem	wmq;				/**< The next window (for the window manager) */
	#endif
	const struct gwinVMT*	vmt;				/**< The VMT for this GWIN */
	GDisplay *				display;			/**< The display this window is on */
	gCoord					x;					/**< The position relative to the screen */
	gCoord					y;					/**< The position relative to the screen */
	gCoord					width;				/**< The width of this window */
	gCoord					height;				/**< The height of this window */
	gColor					color;				/**< The current foreground drawing color */
	gColor					bgcolor;			/**< The current background drawing color */
	uint32_t				flags;				/**< Window flags (the meaning is private to the GWIN class) */
	#if GDISP_NEED_TEXT
		gFont				font;				/**< The current font */
	#endif
	#if GWIN_NEED_CONTAINERS
		GHandle				parent;				/**< The parent window */
	#endif
} GWindowObject, * GHandle;
/** @} */

/**
 * @brief	The structure to initialise a GWIN.
 *
 * @note	Some gwin's will need extra parameters.
 * @note	The dimensions and position may be changed to fit on the real screen.
 * @note	If you create this structure on the stack, you should always memset
 * 			it to all zero's first in case a future version of the software
 * 			add's extra fields. Alternatively you can use @p gwinClearInit()
 * 			to clear it.
 *
 * @{
 */
typedef struct GWindowInit {
	gCoord			x;								/**< The initial position relative to its parent */
	gCoord			y;								/**< The initial position relative to its parent */
	gCoord			width;							/**< The width */
	gCoord			height;							/**< The height */
	gBool			show;							/**< Should the window be visible initially */
	#if GWIN_NEED_CONTAINERS
		GHandle		parent;							/**< The parent - must be a container or NULL */
	#endif
} GWindowInit;
/** @} */

/**
 * @brief	A window's minimized, maximized or normal size
 */
typedef enum { GWIN_NORMAL, GWIN_MAXIMIZE, GWIN_MINIMIZE } GWindowMinMax;

/*-------------------------------------------------
 * Window Manager functions
 *-------------------------------------------------*/

#if GWIN_NEED_WINDOWMANAGER || defined(__DOXYGEN__)
	// Forward definition
	struct GWindowManager;

	/**
	 * @brief   Set the window manager for the GWIN system.
	 *
	 * @param[in] gwm		The window manager to use. Can be NULL to turn off the existing window manager.
	 *
	 * @note				A window manager is responsible for handling when window visibility is changed or
	 * 						a window is resized for moved. Note that only saved window states will be redrawn. Each
	 * 						window type can save different information (or none at all). See the documentation on each window
	 * 						type to see which information it saves (and can therefore be automatically redrawn).
	 * 						For window types that do not save any state information, the window manager determines what to do.
	 * 						Generally it will just clear the window to its background color.
	 *
	 * @api
	 */
	void gwinSetWindowManager(struct GWindowManager *gwm);
#endif

/*-------------------------------------------------
 * Functions that affect all windows
 *-------------------------------------------------*/

/**
 * @brief	Clear a GWindowInit structure to all zero's
 * @note	This function is provided just to prevent problems
 * 			on operating systems where using memset() causes issues
 * 			in the users application.
 *
 * @param[in] pwi	The GWindowInit structure to clear
 *
 * @api
 */
void gwinClearInit(GWindowInit *pwi);

/**
 * @brief	Set the default foreground color for all new GWIN windows
 *
 * @param[in] clr	The color to be set
 *
 * @api
 */
void gwinSetDefaultColor(gColor clr);

/**
 * @brief	Get the default foreground color for all new GWIN windows
 *
 * @return	The current default color for all new GWIN windows
 *
 * @api
 */
gColor gwinGetDefaultColor(void);

/**
 * @brief	Set the default background color for all new GWIN windows
 *
 * @param[in] bgclr	The background color
 *
 * @api
 */
void gwinSetDefaultBgColor(gColor bgclr);

/**
 * @brief	Get the default background color for all new GWIN windows
 *
 * @return	The current default background color for all new GWIN windows
 *
 * @api
 */
gColor gwinGetDefaultBgColor(void);

#if GDISP_NEED_TEXT || defined(__DOXYGEN__)
	/**
	 * @brief	Set the default font for all new GWIN windows
	 *
	 * @param[in] font	The new font to be set
	 *
	 * @api
	 */
	void gwinSetDefaultFont(gFont font);

	/**
	 * @brief	Get the current default font
	 *
	 * @return	The current default font
	 *
	 * @api
	 */
	gFont gwinGetDefaultFont(void);
#endif

/*-------------------------------------------------
* Base functions
*-------------------------------------------------*/

/**
 * @brief   Create a basic window.
 * @return  NULL if there is no resultant drawing area, otherwise a window handle.
 *
 * @param[in] g			The GDisplay to display this window on
 * @param[in] pgw		The window structure to initialize. If this is NULL the structure is dynamically allocated.
 * @param[in] pInit		How to initialise the window
 *
 * @note				The drawing color and the background color get set to the current defaults. If you haven't called
 * 						@p gwinSetDefaultColor() or @p gwinSetDefaultBgColor() then these are GFX_WHITE and GFX_BLACK respectively.
 * @note				The font gets set to the current default font. If you haven't called @p gwinSetDefaultFont() then there
 * 						is no default font and text drawing operations will no nothing.
 * @note				A basic window does not save the drawing state. It is not automatically redrawn if the window is moved or
 * 						its visibility state is changed.
 *
 * @api
 */
GHandle gwinGWindowCreate(GDisplay *g, GWindowObject *pgw, const GWindowInit *pInit);
#define gwinWindowCreate(pgw, pInit)		gwinGWindowCreate(GDISP, pgw, pInit);

/**
 * @brief   Destroy a window (of any type). Releases any dynamically allocated memory.
 *
 * @param[in] gh		The window handle
 *
 * @api
 */
void gwinDestroy(GHandle gh);

/**
 * @brief	Get the real class name of the GHandle
 * @details	Returns a string describing the object class.
 *
 * @param[in] gh	The window
 *
 * @return	A string describing the object class.
 *
 * @api
 */
const char* gwinGetClassName(GHandle gh);

/**
 * @brief	Get an ID that uniquely describes the class of the GHandle
 *
 * @param[in] gh	The window
 *
 * @api
 */
#define gwinGetClassID(gh)		((void *)((gh)->vmt))

/**
 * @brief	Get the X coordinate of the window
 * @details	Returns the X coordinate of the origin of the window.
 *			The coordinate is relative to the physical screen zero point.
 *
 * @param[in] gh	The window
 *
 * @api
 */
#define gwinGetScreenX(gh)			((gh)->x)

/**
 * @brief	Get the Y coordinate of the window
 * @details	Returns the Y coordinate of the origin of the window.
 *			The coordinate is relative to the physical screen zero point.
 *
 * @param[in] gh	The window
 *
 * @api
 */
#define gwinGetScreenY(gh)			((gh)->y)

/**
 * @brief	Get the width of the window
 *
 * @param[in] gh	The window
 *
 * @api
 */
#define gwinGetWidth(gh)			((gh)->width)

/**
 * @brief	Get the height of the window
 *
 * @param[in] gh	The window
 *
 * @api
 */
#define gwinGetHeight(gh)			((gh)->height)

/**
 * @brief	Set foreground color
 * @details Set the color which will be used to draw
 *
 * @param[in] gh	The window
 * @param[in] clr	The color to be set
 *
 * @api
 */
#define gwinSetColor(gh, clr)		(gh)->color = (clr)

/**
 * @brief	Set background color
 * @details	Set the color which will be used as background
 * @note	gwinClear() must be called to set the background color
 *
 * @param[in] gh	The window
 * @param[in] bgclr	The background color
 *
 * @api
 */
#define gwinSetBgColor(gh, bgclr)	(gh)->bgcolor = (bgclr)

/**
 * @brief	Get the foreground color of a window
 *
 * @param[in] gh	The window
 *
 * @api
 */
#define gwinGetColor(gh)			(gh)->color

/**
 * @brief	Get the background color of a window
 *
 * @param[in] gh	The window
 *
 * @api
 */
#define gwinGetBgColor(gh)			(gh)->bgcolor

/**
 * @brief	Sets whether a window is visible or not
 *
 * @param[in] gh		The window
 * @param[in] visible	Whether the window should be visible or not
 *
 * @note	When a window is marked as not visible, drawing operations
 * 			on the window do nothing.
 * @note	When a window is marked as visible, it is not automatically
 * 			redrawn as many window types don't remember their drawing state.
 * 			Widgets such as Buttons, Sliders etc will be redrawn.
 * @note	If there is no window manager in use, when a window is marked
 * 			as not visible, nothing is done to remove the window from the screen.
 * 			When there is a window manager, it is up to the window manager to
 * 			handle what happens.
 * @note	Even when you mark a window as visible, it may still not be displayed
 * 			if it's parent is invisible. When the parent becomes visible this child
 * 			will automatically be shown because it is already marked as visible.
 *
 * @api
 */
void gwinSetVisible(GHandle gh, gBool visible);

/**
 * @brief	Makes a widget become visible
 *
 * @param[in] gh		The window handle
 *
 * @api
 */
#define gwinShow(gh)		gwinSetVisible(gh, gTrue)

/**
 * @brief	Makes a widget become invisible
 *
 * @param[in] gh		The window handle
 *
 * @api
 */
#define gwinHide(gh)		gwinSetVisible(gh, gFalse)

/**
 * @brief	Gets the visibility of a window
 * @return	gTrue if visible
 *
 * @note	It is possible for a child to be marked as visible by @p gwinSetVisible()
 * 			but for this call to return gFalse if one of its parents are not visible.
 *
 * @param[in] gh		The window
 *
 * @api
 */
gBool gwinGetVisible(GHandle gh);

/**
 * @brief	Enable or disable a window
 *
 * @param[in] gh		The window handle
 * @param[in] enabled	Enable or disable the window
 *
 * @note	The window is automatically redrawn if it supports self-redrawing.
 * @note	Even when you mark a window as enabled, it may still remain disabled
 * 			if it's parent is disabled. When the parent becomes enabled this child
 * 			will automatically be enabled because it is already marked as enabled.
 *
 * @api
 */
void gwinSetEnabled(GHandle gh, gBool enabled);

/**
 * @brief	Enables a widget
 *
 * @param[in] gh		The window handle
 *
 * @api
 */
#define gwinEnable(gh)		gwinSetEnabled(gh, gTrue)

/**
 * @brief	Disables a widget
 *
 * @param[in] gh		The window handle
 *
 * @api
 */
#define gwinDisable(gh)		gwinSetEnabled(gh, gFalse)

/**
 * @brief	Gets the enabled state of a window
 * @return	gTrue if enabled
 *
 * @note	It is possible for a child to be marked as enabled by @p gwinSetEnabled()
 * 			but for this call to return gFalse if one of its parents are not enabled.
 *
 * @param[in] gh		The window
 *
 * @api
 */
gBool gwinGetEnabled(GHandle gh);

/**
 * @brief	Move a window
 *
 * @param[in] gh		The window
 * @param[in] x, y		The new position (screen relative) for this window
 *
 * @note	The final window position may not be the requested position. Windows
 * 			are clipped to the screen area and the window manager may also affect the position.
 * @note	The window is redrawn if it is visible. See the comments in @p gwinSetVisible()
 * 			with regard to what can be redrawn and what can't.
 * @note	It is up to the window manager to determine what happens with the screen area
 * 			uncovered by moving the window. When there is no window manager, nothing
 * 			is done with the uncovered area.
 *
 * @api
 */
void gwinMove(GHandle gh, gCoord x, gCoord y);

/**
 * @brief	Resize a window
 *
 * @param[in] gh				The window
 * @param[in] width, height		The new size of the window
 *
 * @note	The final window size may not be the requested size. Windows
 * 			are clipped to the screen area and the window manager may also affect the size.
 * @note	The window is redrawn if it is visible. See the comments in @p gwinSetVisible()
 * 			with regard to what can be redrawn and what can't.
 * @note	It is up to the window manager to determine what happens with any screen area
 * 			uncovered by resizing the window. When there is no window manager, nothing
 * 			is done with the uncovered area.
 *
 * @api
 */
void gwinResize(GHandle gh, gCoord width, gCoord height);

/**
 * @brief	Redraw a window
 *
 * @param[in] gh				The window
 *
 * @note	This is normally never required as windows and widgets will redraw as required.
 * 			Note that some windows are incapable of redrawing themselves as they don't save
 * 			their drawing state.
 *
 * @api
 */
void gwinRedraw(GHandle gh);

#if GWIN_NEED_WINDOWMANAGER || defined (__DOXYGEN__)
	/**
	 * @brief	Redraw a display
	 *
	 * @param[in] g				The display to redraw. Passing NULL will redraw all displays.
	 * @param[in] preserve		Should the redraw try to preserve existing screen data for those
	 * 							windows that can't redraw themselves?
	 *
	 * @note	This is normally never required as windows and widgets will redraw as required.
	 * @note	Some windows are incapable of redrawing themselves as they don't save
	 * 			their drawing state.
	 * @note	This does not clear the background - just redraws the gwin windows (where possible)
	 *
	 * @api
	 */
	void gwinRedrawDisplay(GDisplay *g, gBool preserve);

	/**
	 * @brief	Minimize, Maximize or Restore a window
	 * @pre		GWIN_NEED_WINDOWMANAGER must be GFXON
	 *
	 * @param[in] gh				The window
	 * @param[in] minmax			The new minimized/maximized state
	 *
	 * @note	The final window state may not be the requested state. Window Managers
	 * 			do not need to implement changing the minmax state. If there is no
	 * 			window manager this call is ignored.
	 * @note	The window is redrawn if it is changed. See the comments in @p gwinSetVisible()
	 * 			with regard to what can be redrawn and what can't.
	 * @note	It is up to the window manager to determine what happens with any screen area
	 * 			uncovered by resizing the window.
	 * @note	When a window is minimised it may be asked to draw the window or the window
	 * 			manager may draw the minimised window.
	 *
	 * @api
	 */
	void gwinSetMinMax(GHandle gh, GWindowMinMax minmax);

	/**
	 * @brief	Get the Minimized/Maximized state of a window
	 * @pre		GWIN_NEED_WINDOWMANAGER must be GFXON
	 *
	 * @param[in] gh				The window
	 *
	 * @return	GWIN_NORMAL, GWIN_MAXIMIZE or GWIN_MINIMIZE
	 *
	 * @api
	 */
	GWindowMinMax gwinGetMinMax(GHandle gh);

	/**
	 * @brief	Raise a window to the top of the z-order
	 * @pre		GWIN_NEED_WINDOWMANAGER must be GFXON
	 *
	 * @param[in] gh				The window
	 *
	 * @note	The window z-order is only supported by some window managers. See the comments
	 * 			in @p gwinSetVisible() with regard to what can be redrawn and what can't.
	 *
	 * @api
	 */
	void gwinRaise(GHandle gh);

	/**
	 * @brief	Get the next window in the z-order
	 * @return	The next window or NULL if no more windows
	 *
	 * @param[in] gh		The previous window or NULL to get the first window
	 *
	 * @note	This returns the next window in the system from top to bottom.
	 * @note	Where there are parent child relationships, this ignores them
	 * 			and will list all windows in the system. There is no defined
	 * 			order between children of siblings and they can in fact be mixed
	 * 			in order. The only relationship honored is that parents will be
	 * 			listed before their children.
	 *
	 * @api
	 */
	GHandle gwinGetNextWindow(GHandle gh);

	/**
	 * @brief	Set a window or widget to flash
	 *
	 * @param[in] gh		The window handle
	 * @param[in] flash		Enable or disable the flashing of the window
	 *
	 * @note	The window is automatically redrawn if it supports self-redrawing.
	 * @note	When a window is set to flash, its appearance changes in some
	 * 			way every flash period (GWIN_FLASHING_PERIOD). How its appearance
	 * 			changes depends on the draw for each window/widget.
	 *
	 * @pre		Requires GWIN_NEED_FLASHING to be GFXON
	 *
	 * @api
	 */
	void gwinSetFlashing(GHandle gh, gBool flash);

	/**
	 * @brief	Enables flashing of a window or widget
	 *
	 * @param[in] gh		The window handle
	 *
	 * @api
	 */
	#define gwinFlash(gh)		gwinSetFlashing(gh, gTrue)

	/**
	 * @brief	Disables a widget
	 *
	 * @param[in] gh		The window handle
	 *
	 * @api
	 */
	#define gwinNoFlash(gh)		gwinSetFlashing(gh, gFalse)
#endif

#if GDISP_NEED_TEXT || defined(__DOXYGEN__)
	/**
	 * @brief   Set the current font for this window.
	 *
	 * @param[in] gh		The window handle
	 * @param[in] font		The font to use for text functions
	 *
	 * @api
	 */
	void gwinSetFont(GHandle gh, gFont font);
#endif

/*-------------------------------------------------
* Drawing functions
*-------------------------------------------------*/

/**
 * @brief   Clear the window
 * @note	Uses the current background color to clear the window
 *
 * @param[in] gh		The window handle
 *
 * @api
 */
void gwinClear(GHandle gh);

/**
 * @brief   Set a pixel in the window
 * @note	Uses the current foreground color to set the pixel
 * @note	May leave GDISP clipping to this window's dimensions
 *
 * @param[in] gh		The window handle
 * @param[in] x,y		The coordinates of the pixel
 *
 * @api
 */
void gwinDrawPixel(GHandle gh, gCoord x, gCoord y);

/**
 * @brief   Draw a line in the window
 * @note	Uses the current foreground color to draw the line
 * @note	May leave GDISP clipping to this window's dimensions
 *
 * @param[in] gh		The window handle
 * @param[in] x0,y0		The start position
 * @param[in] x1,y1 	The end position
 *
 * @api
 */
void gwinDrawLine(GHandle gh, gCoord x0, gCoord y0, gCoord x1, gCoord y1);

/**
 * @brief   Draw a box in the window
 * @note	Uses the current foreground color to draw the box
 * @note	May leave GDISP clipping to this window's dimensions
 *
 * @param[in] gh		The window handle
 * @param[in] x,y		The start position
 * @param[in] cx,cy		The size of the box (outside dimensions)
 *
 * @api
 */
void gwinDrawBox(GHandle gh, gCoord x, gCoord y, gCoord cx, gCoord cy);

/**
 * @brief   Fill an rectangular area in the window
 * @note	Uses the current foreground color to fill the box
 * @note	May leave GDISP clipping to this window's dimensions
 *
 * @param[in] gh		The window handle
 * @param[in] x,y		The start position
 * @param[in] cx,cy		The size of the box (outside dimensions)
 *
 * @api
 */
void gwinFillArea(GHandle gh, gCoord x, gCoord y, gCoord cx, gCoord cy);

/**
 * @brief   Fill an area in the window using the supplied bitmap.
 * @details The bitmap is in the pixel format specified by the low level driver
 * @note	If GDISP_NEED_ASYNC is defined then the buffer must be static
 * 			or at least retained until this call has finished the blit. You can
 * 			tell when all graphics drawing is finished by @p gdispIsBusy() going gFalse.
 * @note	May leave GDISP clipping to this window's dimensions
 *
 * @param[in] gh		The window handle
 * @param[in] x, y		The start filled area
 * @param[in] cx, cy	The width and height to be filled
 * @param[in] srcx, srcy	The bitmap position to start the fill from
 * @param[in] srccx		The width of a line in the bitmap.
 * @param[in] buffer	The pixels to use to fill the area.
 *
 * @api
 */
void gwinBlitArea(GHandle gh, gCoord x, gCoord y, gCoord cx, gCoord cy, gCoord srcx, gCoord srcy, gCoord srccx, const gPixel *buffer);

/*-------------------------------------------------
* Circle, ellipse, arc and arc-sectors functions
*-------------------------------------------------*/

#if GDISP_NEED_CIRCLE || defined(__DOXYGEN__)
	/**
	 * @brief   Draw a circle in the window.
	 * @note	Uses the current foreground color to draw the circle
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x, y		The center of the circle
	 * @param[in] radius	The radius of the circle
	 *
	 * @api
	 */
	void gwinDrawCircle(GHandle gh, gCoord x, gCoord y, gCoord radius);

	/**
	 * @brief   Draw a filled circle in the window.
	 * @note	Uses the current foreground color to draw the filled circle
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x, y		The center of the circle
	 * @param[in] radius	The radius of the circle
	 *
	 * @api
	 */
	void gwinFillCircle(GHandle gh, gCoord x, gCoord y, gCoord radius);
#endif

#if GDISP_NEED_DUALCIRCLE || defined(__DOXYGEN__)
	/**
	 * @brief   Draw two filled circles with the same centre in the window.
	 * @note	Uses the current foreground color to draw the inner circle
	 * @note	Uses the current background color to draw the outer circle
	 * @note	May leave GDISP clipping to this window's dimensions
	 * @pre		GDISP_NEED_DUALCIRCLE must be GFXON in your gfxconf.h
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The center of the circle
	 * @param[in] radius1	The radius of the larger circle
	 * @param[in] radius2	The radius of the smaller circle
	 *
	 * @api
	 */
	void gwinFillDualCircle(GHandle gh, gCoord x, gCoord y, gCoord radius1, gCoord radius2);
#endif

#if GDISP_NEED_ELLIPSE || defined(__DOXYGEN__)
	/**
	 * @brief   Draw an ellipse.
	 * @note	Uses the current foreground color to draw the ellipse
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The center of the ellipse
	 * @param[in] a,b		The dimensions of the ellipse
	 *
	 * @api
	 */
	void gwinDrawEllipse(GHandle gh, gCoord x, gCoord y, gCoord a, gCoord b);

	/**
	 * @brief   Draw an filled ellipse.
	 * @note	Uses the current foreground color to draw the filled ellipse
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The center of the ellipse
	 * @param[in] a,b		The dimensions of the ellipse
	 *
	 * @api
	 */
	void gwinFillEllipse(GHandle gh, gCoord x, gCoord y, gCoord a, gCoord b);
#endif

#if GDISP_NEED_ARC || defined(__DOXYGEN__)
	/*
	 * @brief	Draw an arc in the window.
	 * @note	Uses the current foreground color to draw the arc
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The center point
	 * @param[in] radius	The radius of the arc
	 * @param[in] start		The start angle (0 to 360)
	 * @param[in] end		The end angle (0 to 360)
	 *
	 * @api
	 */
	void gwinDrawArc(GHandle gh, gCoord x, gCoord y, gCoord radius, gCoord startangle, gCoord endangle);

	/*
	 * @brief	Draw a filled arc in the window.
	 * @note	Uses the current foreground color to draw the filled arc
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The center point
	 * @param[in] radius	The radius of the arc
	 * @param[in] start		The start angle (0 to 360)
	 * @param[in] end		The end angle (0 to 360)
	 *
	 * @api
	 */
	void gwinFillArc(GHandle gh, gCoord x, gCoord y, gCoord radius, gCoord startangle, gCoord endangle);

	/*
	 * @brief	Draw a thick arc in the window.
	 * @note	Uses the current foreground color to draw the thick arc
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The center point
	 * @param[in] startradius	The inner radius of the thick arc
	 * @param[in] endradius		The outer radius of the thick arc
	 * @param[in] startangle	The start angle (0 to 360)
	 * @param[in] endangle		The end angle (0 to 360)
	 *
	 * @api
	 */
	void gwinDrawThickArc(GHandle gh, gCoord x, gCoord y, gCoord startradius, gCoord endradius, gCoord startangle, gCoord endangle);
#endif

#if GDISP_NEED_ARCSECTORS || defined(__DOXYGEN__)
	/*
	 * @brief	Draw a selection of 45 degree arcs of a circle in the window.
	 * @note	Uses the current foreground color to draw the arc sector
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The center of the circle
	 * @param[in] radius	The radius of the circle
	 * @param[in] sectors	Bits determine which sectors are drawn.
	 * 						Bits go anti-clockwise from the 0 degree mark (y = 0, x is positive), as follows:
	 *  						bit 0 - upper right right		  -----
	 *  						bit 1 - upper upper right		 /2   1\
	 *  						bit 2 - upper upper left		/3     0\
	 *  						bit 3 - upper left  left		\4     7/
	 *  						bit 4 - lower left  left		 \5   6/
	 *  						bit 5 - lower lower left		  -----
	 *  						bit 6 - lower lower right
	 *  						bit 7 - lower left  left
	 *
	 * @api
	 */
	void gwinDrawArcSectors(GHandle gh, gCoord x, gCoord y, gCoord radius, uint8_t sectors);

	/*
	 * @brief	Draw a filled selection of 45 degree arcs of a circle in the window.
	 * @note	Uses the current foreground color to draw the arc sector
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The center of the circle
	 * @param[in] radius	The radius of the circle
	 * @param[in] sectors	Bits determine which sectors are drawn.
	 * 						Bits go anti-clockwise from the 0 degree mark (y = 0, x is positive), as follows:
	 *  						bit 0 - upper right right		  -----
	 *  						bit 1 - upper upper right		 /2   1\
	 *  						bit 2 - upper upper left		/3     0\
	 *  						bit 3 - upper left  left		\4     7/
	 *  						bit 4 - lower left  left		 \5   6/
	 *  						bit 5 - lower lower left		  -----
	 *  						bit 6 - lower lower right
	 *  						bit 7 - lower left  left
	 *
	 * @api
	 */
	void gwinFillArcSectors(GHandle gh, gCoord x, gCoord y, gCoord radius, uint8_t sectors);
#endif

/*-------------------------------------------------
* Pixel read-back functions
*-------------------------------------------------*/

#if GDISP_NEED_PIXELREAD || defined(__DOXYGEN__)
	/**
	 * @brief   Get the color of a pixel in the window.
	 * @return  The color of the pixel.
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The position in the window
	 *
	 * @api
	 */
	gColor gwinGetPixelColor(GHandle gh, gCoord x, gCoord y);
#endif

/*-------------------------------------------------
* Text functions
*-------------------------------------------------*/

#if GDISP_NEED_TEXT || defined(__DOXYGEN__)
	/**
	 * @brief   Draw a text character at the specified position in the window.
	 * @pre		The font must have been set.
	 * @note	Uses the current foreground color to draw the character
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The position for the text
	 * @param[in] c			The character to draw
	 *
	 * @api
	 */
	void gwinDrawChar(GHandle gh, gCoord x, gCoord y, char c);

	/**
	 * @brief   Draw a text character with a filled background at the specified position in the window.
	 * @pre		The font must have been set.
	 * @note	Uses the current foreground color to draw the character and fills the background using the background drawing color
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The position for the text
	 * @param[in] c			The character to draw
	 *
	 * @api
	 */
	void gwinFillChar(GHandle gh, gCoord x, gCoord y, char c);

	/**
	 * @brief   Draw a text string in the window
	 * @pre		The font must have been set.
	 * @note	Uses the current foreground color to draw the character
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The position for the text
	 * @param[in] str		The string to draw
	 *
	 * @api
	 */
	void gwinDrawString(GHandle gh, gCoord x, gCoord y, const char *str);

	/**
	 * @brief   Draw a text string with a filled background in the window
	 * @pre		The font must have been set.
	 * @note	Uses the current foreground color to draw the character and fills the background using the background drawing color
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The position for the text
	 * @param[in] str		The string to draw
	 *
	 * @api
	 */
	void gwinFillString(GHandle gh, gCoord x, gCoord y, const char *str);

	/**
	 * @brief   Draw a text string verticly centered within the specified box.
	 * @pre		The font must have been set.
	 * @note	Uses the current foreground color to draw the character.
	 * @note    The specified box does not need to align with the window box
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The position for the text (need to define top-right or base-line - check code)
	 * @param[in] cx,cy		The width and height of the box
	 * @param[in] str		The string to draw
	 * @param[in] justify	Justify the text left, center or right within the box
	 *
	 * @api
	 */
	void gwinDrawStringBox(GHandle gh, gCoord x, gCoord y, gCoord cx, gCoord cy, const char* str, gJustify justify);

	/**
	 * @brief   Draw a text string verticly centered within the specified filled box.
	 * @pre		The font must have been set.
	 * @note	Uses the current foreground color to draw the character and fills the background using the background drawing color
	 * @note    The entire box is filled. Note this box does not need to align with the window box
	 * @note	May leave GDISP clipping to this window's dimensions
	 *
	 * @param[in] gh		The window handle
	 * @param[in] x,y		The position for the text (need to define top-right or base-line - check code)
	 * @param[in] cx,cy		The width and height of the box
	 * @param[in] str		The string to draw
	 * @param[in] justify	Justify the text left, center or right within the box
	 *
	 * @api
	 */
	void gwinFillStringBox(GHandle gh, gCoord x, gCoord y, gCoord cx, gCoord cy, const char* str, gJustify justify);
#endif

/*-------------------------------------------------
* Polygon functions
*-------------------------------------------------*/

#if GDISP_NEED_CONVEX_POLYGON || defined(__DOXYGEN__)
	/**
	 * @brief   Draw an enclosed polygon (convex, non-convex or complex).
	 *
	 * @note	Uses the current foreground color.
	 *
	 * @param[in] gh		The window handle
	 * @param[in] tx, ty	Transform all points in pntarray by tx, ty
	 * @param[in] pntarray	An array of points
	 * @param[in] cnt		The number of points in the array
	 *
	 * @api
	 */
	void gwinDrawPoly(GHandle gh, gCoord tx, gCoord ty, const gPoint *pntarray, unsigned cnt);

	/**
	 * @brief   Fill a convex polygon
	 * @details Doesn't handle non-convex or complex polygons.
	 *
	 * @note	Uses the current foreground color.
	 *
	 * @param[in] gh		The window handle
	 * @param[in] tx, ty	Transform all points in pntarray by tx, ty
	 * @param[in] pntarray	An array of points
	 * @param[in] cnt		The number of points in the array
	 *
	 * @note	Convex polygons are those that have no internal angles. That is;
	 * 			you can draw a line from any point on the polygon to any other point
	 * 			on the polygon without it going outside the polygon. In our case we generalise
	 * 			this a little by saying that an infinite horizontal line (at any y value) will cross
	 * 			no more than two edges on the polygon. Some non-convex polygons do fit this criteria
	 * 			and can therefore be drawn.
	 * @note	This routine is designed to be very efficient with even simple display hardware.
	 *
	 * @api
	 */
	void gwinFillConvexPoly(GHandle gh, gCoord tx, gCoord ty, const gPoint *pntarray, unsigned cnt);

	/**
	 * @brief	Draw a thick line in the window
	 * @details	The line thickness is specified in pixels. The line ends can
	 *		be selected to be either flat or round.
	 * @note	Uses gdispGFillConvexPoly() internally to perform the drawing.
	 * @note	Uses the current foreground color to draw the line
	 * 
	 * @param[in] gh		The window handle
	 * @param[in] x0,y0		The start position
	 * @param[in] x1,y1		The end position
	 * @param[in] width		The width of the line
	 * @param[in] round		Use round ends for the line
	 * 
	 * @api
	 */
	void gwinDrawThickLine(GHandle gh, gCoord x0, gCoord y0, gCoord x1, gCoord y1, gCoord width, gBool round);
#endif

/*-------------------------------------------------
* Image functions
*-------------------------------------------------*/

#if GDISP_NEED_IMAGE || defined(__DOXYGEN__)
	/**
	 * @brief	Draw the image
	 * @return	GDISP_IMAGE_ERR_OK (0) on success or an error code.
	 *
	 * @param[in] gh		The window handle
	 * @param[in] img   	The image structure
	 * @param[in] x,y		The window location to draw the image
	 * @param[in] cx,cy		The area on the screen to draw
	 * @param[in] sx,sy		The image position to start drawing at
	 *
	 * @pre		gdispImageOpen() must have returned successfully.
	 *
	 * @note	If sx,sy + cx,cy is outside the image boundaries the area outside the image
	 * 			is simply not drawn.
	 * @note	If @p gdispImageCache() has been called first for this frame, this routine will draw using a
	 * 			fast blit from the cached frame. If not, it reads the input and decodes it as it
	 * 			is drawing. This may be significantly slower than if the image has been cached (but
	 * 			uses a lot less RAM)
	 *
	 * @api
	 */
	gdispImageError gwinDrawImage(GHandle gh, gdispImage *img, gCoord x, gCoord y, gCoord cx, gCoord cy, gCoord sx, gCoord sy);
#endif

/*-------------------------------------------------
* Additional functionality
*-------------------------------------------------*/

/* Include widgets */
#if GWIN_NEED_WIDGET || defined(__DOXYGEN__)
	#include "gwin_widget.h"
#endif

/* Include containers */
#if GWIN_NEED_CONTAINERS || defined(__DOXYGEN__)
	#include "gwin_container.h"
#endif

/* Include vanilla window objects */
#if GWIN_NEED_CONSOLE || defined(__DOXYGEN__)
	#include "gwin_console.h"
#endif
#if GWIN_NEED_GRAPH || defined(__DOXYGEN__)
	#include "gwin_graph.h"
#endif
#if GWIN_NEED_IMAGE || defined(__DOXYGEN__)
	#include "gwin_image.h"
#endif
#if GWIN_NEED_GL3D || defined(__DOXYGEN__)
	#include "gwin_gl3d.h"
#endif

#endif /* GFX_USE_GWIN */

#endif /* _GWIN_H */
/** @} */