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
|
/*
* 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_widget.h
* @brief GWIN Widgets header file.
*
* @defgroup Widget Widget
* @ingroup Widgets
*
* @brief The basic widget implementation (base class).
*
* @details A widget is a Window that supports interacting with the user
* via an input device such as a mouse or toggle buttons. It is the
* base class for widgets such as buttons and sliders.
*
* @pre GFX_USE_GWIN and GWIN_NEED_WIDGET must be set to GFXON in your gfxconf.h
* @{
*/
#ifndef _GWIDGET_H
#define _GWIDGET_H
/* This file is included within "src/gwin/gwin.h" */
// Forward definition
struct GWidgetObject;
/**
* @brief The GColorSet structure
* @{
*/
typedef struct GColorSet {
gColor text; /**< The text color */
gColor edge; /**< The edge color */
gColor fill; /**< The fill color */
gColor progress; /**< The color of progress bars */
} GColorSet;
/** @} */
/**
* @brief The GWidgetStyle structure
* @details A GWidgetStyle is a set of colors that together form a "style".
* These colors should not be confused with the GWindow foreground
* and background colors which are used for drawing operations.
* @{
*/
typedef struct GWidgetStyle {
gColor background; /**< The window background color */
gColor focus; /**< The color when a widget is focused */
GColorSet enabled; /**< The colors when enabled */
GColorSet disabled; /**< The colors when disabled */
GColorSet pressed; /**< The colors when pressed */
} GWidgetStyle;
/** @} */
/**
* @brief We define a couple of GWidgetStyle's that you can use in your
* application. The Black style is the default style if you don't
* specify one.
* @note BlackWidgetStyle means that it is designed for a Black background.
* Similarly WhiteWidgetStyle is designed for a White background.
* @{
*/
extern const GWidgetStyle BlackWidgetStyle;
extern const GWidgetStyle WhiteWidgetStyle;
/** @} */
/**
* @brief Defines a custom drawing function for a widget
*/
typedef void (*CustomWidgetDrawFunction)(struct GWidgetObject *gw, void *param);
/**
* @brief Defines a the type of a tag on a widget
*/
typedef uint16_t WidgetTag;
/**
* @brief The structure to initialise a widget.
*
* @note Some widgets may have extra parameters.
* @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 gwinWidgetClearInit()
* to clear it.
* @note The text element must be static string (not stack allocated). If you want to use
* a dynamic string (eg a stack allocated string) use NULL for this member and then call
* @p gwinSetText() with useAlloc set to gTrue.
*
* @{
*/
typedef struct GWidgetInit {
GWindowInit g; /**< The GWIN initializer */
const char * text; /**< The initial text */
CustomWidgetDrawFunction customDraw; /**< A custom draw function - use NULL for the standard */
void * customParam; /**< A parameter for the custom draw function (default = NULL) */
const GWidgetStyle * customStyle; /**< A custom style to use - use NULL for the default style */
#if GWIN_WIDGET_TAGS || defined(__DOXYGEN__)
WidgetTag tag; /**< The tag to associate with the widget */
#endif
} GWidgetInit;
/** @} */
/**
* @brief The GWIN Widget structure
* @note A widget is a GWIN window that accepts user input.
* It also has a number of other properties such as its ability
* to redraw itself (a widget maintains drawing state).
* @note Do not access the members directly. Treat it as a black-box and use the method functions.
*
* @{
*/
typedef struct GWidgetObject {
GWindowObject g; /**< This is still a GWIN */
const char * text; /**< The widget text */
CustomWidgetDrawFunction fnDraw; /**< The current draw function */
void * fnParam; /**< A parameter for the current draw function */
const GWidgetStyle * pstyle; /**< The current widget style colors */
#if GWIN_WIDGET_TAGS || defined(__DOXYGEN__)
WidgetTag tag; /**< The widget tag */
#endif
} GWidgetObject;
/** @} */
/**
* A comment/rant on the above structure:
* We would really like the GWindowObject member to be anonymous. While this is
* allowed under the C11, C99, GNU and various other standards which have been
* around forever - compiler support often requires special flags e.g
* gcc requires the -fms-extensions flag (no wonder the language and compilers have
* not really progressed in 30 years). As portability is a key requirement
* we unfortunately won't use this useful feature in case we get a compiler that
* won't support it even with special flags.
*/
/**
* @brief A Generic GWIN Event
* @note All gwin windows when sending events will either use this structure or a
* structure that is 100% compatible except that it may also have extra fields.
* @note There are currently no GEventGWin listening flags - use 0 as the flags to @p gwinAttachListener()
*
* @{
*/
typedef struct GEventGWin {
GEventType type; /**< The type of this event */
GHandle gwin; /**< The gwin window handle */
#if GWIN_NEED_WIDGET && GWIN_WIDGET_TAGS
WidgetTag tag; /**< The tag (if applicable) */
#endif
} GEventGWin;
/** @} */
/**
* @brief The list of predefined GWIN events.
* @note The definition of an event type does not mean it is always sent. For example,
* close events are sent by Frame windows but by little else. They are normally
* only sent if there is a specific reason that the event should be sent.
* @{
*/
#define GEVENT_GWIN_OPEN (GEVENT_GWIN_FIRST+0x00)
#define GEVENT_GWIN_CLOSE (GEVENT_GWIN_FIRST+0x01)
#define GEVENT_GWIN_RESIZE (GEVENT_GWIN_FIRST+0x02)
#define GEVENT_GWIN_CTRL_FIRST (GEVENT_GWIN_FIRST+0x40)
/** @} */
/**
* @brief Clear a GWidgetInit 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 GWidgetInit structure to clear
*
* @api
*/
void gwinWidgetClearInit(GWidgetInit *pwi);
/**
* @brief Set the default style for widgets created hereafter.
*
* @param[in] pstyle The default style. Passing NULL uses the system compiled style.
* @param[in] updateAll If gTrue then all existing widgets that are using the current default style
* will be updated to use this new style. Widgets that have custom styles different
* from the default style will not be updated.
*
* @note The style must be allocated statically (not on the stack) as only the pointer is stored.
*
* @api
*/
void gwinSetDefaultStyle(const GWidgetStyle *pstyle, gBool updateAll);
/**
* @brief Get the current default style.
*
* @return The current default style.
*
* @api
*/
const GWidgetStyle *gwinGetDefaultStyle(void);
/**
* @brief Set the text of a widget.
*
* @param[in] gh The widget handle
* @param[in] text The text to set. This must be a constant string unless useAlloc is set.
* @param[in] useAlloc If gTrue the string specified will be copied into dynamically allocated memory.
*
* @note The widget is automatically redrawn
* @note Non-widgets will ignore this call.
*
* @api
*/
void gwinSetText(GHandle gh, const char *text, gBool useAlloc);
/**
* @brief Get the text of a widget.
* @return The widget text or NULL if it isn't a widget
*
* @param[in] gh The widget handle
*
* @api
*/
const char *gwinGetText(GHandle gh);
#if (GFX_USE_GFILE && GFILE_NEED_PRINTG && GFILE_NEED_STRINGS) || defined(__DOXYGEN__)
/**
* @brief Set the text of a widget using a printf style format.
* @pre GFX_USE_GFILE, GFILE_NEED_PRINTG and GFILE_NEED_STRINGS must all be GFXON
*
* @param[in] gh The widget handle
* @param[in] fmt The format string using a printf/g syntax. See @p vsnprintg()
* @param[in] ... The printg paramters.
*
* @note The widget is automatically redrawn
* @note Non-widgets will ignore this call.
* @note The memory for the text is always allocated by this function.
*
* @api
*/
void gwinPrintg(GHandle gh, const char * fmt,...);
#endif
/**
* @brief Check whether a handles is a widget handle or not
*
* @param[in] gh The handle to check.
*
* @return gTrue if the passed handle is a widget handle. gFalse otherwise.
*
* @api
*/
gBool gwinIsWidget(GHandle gh);
#if GWIN_WIDGET_TAGS || defined(__DOXYGEN__)
/**
* @brief Set the tag of a widget.
*
* @param[in] gh The widget handle
* @param[in] tag The tag to set.
*
* @note Non-widgets will ignore this call.
*
* @pre Requires GWIN_WIDGET_TAGS to be GFXON
*
* @api
*/
void gwinSetTag(GHandle gh, WidgetTag tag);
/**
* @brief Get the tag of a widget.
* @return The widget tag value (or 0 if it is not a widget)
*
* @param[in] gh The widget handle
*
* @pre Requires GWIN_WIDGET_TAGS to be GFXON
*
* @api
*/
WidgetTag gwinGetTag(GHandle gh);
#endif
/**
* @brief Set the style of a widget.
*
* @param[in] gh The widget handle
* @param[in] pstyle The style to set. This must be a static structure (not allocated on a transient stack).
* Use NULL to reset to the default style.
*
* @note The widget is automatically redrawn
* @note Non-widgets will ignore this call.
*
* @api
*/
void gwinSetStyle(GHandle gh, const GWidgetStyle *pstyle);
/**
* @brief Get the style of a widget.
* @return The widget style or NULL if it isn't a widget
*
* @param[in] gh The widget handle
*
* @api
*/
const GWidgetStyle *gwinGetStyle(GHandle gh);
/**
* @brief Set the routine to perform a custom widget drawing.
*
* @param[in] gh The widget handle
* @param[in] fn The function to use to draw the widget
* @param[in] param A parameter to pass to the widget drawing function
*
* @note The widget is not automatically redrawn. Call @p gwinDraw() to redraw the widget.
* @note Non-widgets will ignore this call.
*
* @api
*/
void gwinSetCustomDraw(GHandle gh, CustomWidgetDrawFunction fn, void *param);
/**
* @brief Attach a Listener to listen for widget events
* @return gTrue on success
*
* @param[in] pl The listener
*
* @api
*/
gBool gwinAttachListener(GListener *pl);
#if (GFX_USE_GINPUT && GINPUT_NEED_MOUSE) || defined(__DOXYGEN__)
gBool DEPRECATED("This call can now be removed. Attaching the mouse to GWIN is now automatic.") gwinAttachMouse(uint16_t instance);
#endif
#if (GFX_USE_GINPUT && GINPUT_NEED_TOGGLE) || defined(__DOXYGEN__)
/**
* @brief Attach a toggle to a widget
* @return gTrue on success
*
* @param[in] gh The widget handle
* @param[in] role The function the toggle will perform for the widget
* @param[in] instance The toggle instance
*
* @note See the documentation on the specific widget to see the possible
* values for the role parameter. If it is out of range, this function
* will return gFalse
*
* @api
*/
gBool gwinAttachToggle(GHandle gh, uint16_t role, uint16_t instance);
/**
* @brief Detach a toggle from a widget
* @return gTrue on success
*
* @param[in] gh The widget handle
* @param[in] role The function the toggle will perform for the widget
*
* @note See the documentation on the specific widget to see the possible
* values for the role parameter. If it is out of range, this function
* will return gFalse
*
* @api
*/
gBool gwinDetachToggle(GHandle gh, uint16_t role);
#endif
#if (GFX_USE_GINPUT && GINPUT_NEED_DIAL) || defined(__DOXYGEN__)
/**
* @brief Attach a toggle to a widget
* @return gTrue on success
*
* @param[in] gh The widget handle
* @param[in] role The function the dial will perform for the widget
* @param[in] instance The dial instance
*
* @note See the documentation on the specific widget to see the possible
* values for the role parameter. If it is out of range, this function
* will return gFalse
*
* @api
*/
gBool gwinAttachDial(GHandle gh, uint16_t role, uint16_t instance);
#endif
#if (GFX_USE_GINPUT && GINPUT_NEED_KEYBOARD) || GWIN_NEED_KEYBOARD || defined(__DOXYGEN__)
/**
* @brief Set the keyboard focus to a specific window
* @return Returns gTrue if the focus could be set to that window
*
* @param[in] gh The window
*
* @note Passing NULL will remove the focus from any window.
* @note Only visible enabled widgets are capable of getting the focus.
*
* @api
*/
gBool gwinSetFocus(GHandle gh);
/**
* @brief Get the widget that is currently in focus
*
* @details The widget that is currently in focus is the widget that
* receives mouse and keyboard events.
*
* @return The handle of the widget that is currently in focus. May be NULL.
*
* @api
*/
GHandle gwinGetFocus(void);
#else
#define gwinGetFocus() (0)
#define gwinSetFocus(gh) (gFalse)
#endif
/* Include extra widget types */
#if GWIN_NEED_BUTTON || defined(__DOXYGEN__)
#include "gwin_button.h"
#endif
#if GWIN_NEED_SLIDER || defined(__DOXYGEN__)
#include "gwin_slider.h"
#endif
#if GWIN_NEED_CHECKBOX || defined(__DOXYGEN__)
#include "gwin_checkbox.h"
#endif
#if GWIN_NEED_RADIO || defined(__DOXYGEN__)
#include "gwin_radio.h"
#endif
#if GWIN_NEED_LABEL || defined(__DOXYGEN__)
#include "gwin_label.h"
#endif
#if GWIN_NEED_LIST || defined(__DOXYGEN__)
#include "gwin_list.h"
#endif
#if GWIN_NEED_PROGRESSBAR || defined(__DOXYGEN__)
#include "gwin_progressbar.h"
#endif
#if GWIN_NEED_KEYBOARD || defined(__DOXYGEN__)
#include "gwin_keyboard.h"
#endif
#if GWIN_NEED_TEXTEDIT || defined(__DOXYGEN__)
#include "gwin_textedit.h"
#endif
#endif /* _GWIDGET_H */
/** @} */
|