aboutsummaryrefslogtreecommitdiffstats
path: root/src/gwin/gwin_checkbox.h
blob: cd66428a2d464da6045702df9d39b35cd074adcf (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
/*
 * 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_checkbox.h
 * @brief   GWIN Graphic window subsystem header file.
 *
 * @defgroup Checkbox Checkbox
 * @ingroup Widgets
 *
 * @details		GWIN allows it to easily create a group of checkbox buttons.
 *
 * @pre			GFX_USE_GWIN must be set to TRUE in your gfxconf.h
 * @pre			GWIN_NEED_CHECKBOX must be set to TRUE in your gfxconf.h
 * @{
 */

#ifndef _GWIN_CHECKBOX_H
#define _GWIN_CHECKBOX_H

/* This file is included within "src/gwin/gwin_widget.h" */

/*===========================================================================*/
/* Driver constants.														 */
/*===========================================================================*/

#define GEVENT_GWIN_CHECKBOX		(GEVENT_GWIN_CTRL_FIRST+2)

/*===========================================================================*/
/* Type definitions                                                          */
/*===========================================================================*/

typedef struct GEventGWinCheckbox {
	GEventType		type;			// The type of this event (GEVENT_GWIN_CHECKBOX)
	GHandle			gwin;			// The checkbox that has been depressed (actually triggered on release)
	#if GWIN_WIDGET_TAGS
		WidgetTag	tag;			// The checkbox tag
	#endif
	bool_t			isChecked;		// Is the checkbox currently checked or unchecked?
} GEventGWinCheckbox;

/* A Checkbox window */
typedef struct GCheckboxObject {
	GWidgetObject			w;
	#if GINPUT_NEED_TOGGLE
		uint16_t			toggle;
	#endif
} GCheckboxObject;

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief				Create a checkbox 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] gb		The GCheckboxObject structure to initialise. If this is NULL, the structure is dynamically allocated.
 * @param[in] pInit		The initialization parameters to use
 *
 * @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 White and 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 checkbox remembers its normal drawing state. If there is a window manager then it is automatically
 * 						redrawn if the window is moved or its visibility state is changed.
 * @note				A checkbox supports mouse and a toggle input.
 * @note				When assigning a toggle, only one toggle is supported. If you try to assign more than one toggle it will
 * 						forget the previous toggle. When assigning a toggle the role parameter must be 0.
 *
 * @api
 */
GHandle gwinGCheckboxCreate(GDisplay *g, GCheckboxObject *gb, const GWidgetInit *pInit);
#define gwinCheckboxCreate(gb, pInit)			gwinGCheckboxCreate(GDISP, gb, pInit)

/**
 * @brief	Set the state of a checkbox
 *
 * @param[in] gh		The window handle (must be a checkbox window)
 * @param[in] isChecked	TRUE to set the check, FALSE to uncheck.
 *
 * @api
 */
void gwinCheckboxCheck(GHandle gh, bool_t isChecked);

/**
 * @brief	Get the state of a checkbox
 * @return	TRUE if the checkbox is currently checked
 *
 * @param[in] gh	The window handle (must be a checkbox window)
 *
 * @api
 */
bool_t gwinCheckboxIsChecked(GHandle gh);

/**
 * @defgroup Renderings_Checkbox Renderings
 *
 * @brief				Built-in rendering functions for the checkbox widget.
 *
 * @details				These function may be passed to @p gwinSetCustomDraw() to get different checkbox drawing styles.
 *
 * @note				In your custom checkbox drawing function you may optionally call these
 * 						standard functions and then draw your extra details on top.
 * @note				These custom drawing routines don't have to worry about setting clipping as the framework
 * 						sets clipping to the object window prior to calling these routines.
 *
 * @{
 */

/**
 * @brief				Renders a square checkbox where the text is on the right side of the checkbox.
 *
 * @param[in] gw		The widget (must be a checkbox)
 * @param[in] param		A parameter passed in from the user. Ignored by this function.
 *
 * @api
 */
void gwinCheckboxDraw_CheckOnLeft(GWidgetObject *gw, void *param);

/**
 * @brief				Renders a square checkbox where the text is on the left side of the checkbox.
 *
 * @param[in] gw		The widget (must be a checkbox)
 * @param[in] param		A parameter passed in from the user. Ignored by this function.
 *
 * @api
 */
void gwinCheckboxDraw_CheckOnRight(GWidgetObject *gw, void *param);

/**
 * @brief				Renders a checkbox in form of a rectangular button with the text inside of it.
 *
 * @details				This behaves like a button that can be toggled.
 *
 * @param[in] gw		The widget (must be a checkbox)
 * @param[in] param		A parameter passed in from the user. Ignored by this function.
 *
 * @api
 */
void gwinCheckboxDraw_Button(GWidgetObject *gw, void *param);
/** @} */

#ifdef __cplusplus
}
#endif

#endif /* _GWIN_CHECKBOX_H */
/** @} */