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
|
/*
* 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.io/license.html
*/
/**
* @file src/gwin/gwin_tabset.h
* @brief GWIN Graphic window subsystem header file.
*
* @defgroup Tabset Tabset
* @ingroup Containers
*
* @brief Tabwidget to implement different "Tabs" or "Pages". Used to structure menus.
*
* @details A tabset is a set of tabs that control visibility of a number of pages of widgets.
* Note: Although the tabset is implemented as a container - you don't put your controls
* directly on the tabset. Instead you create a page and put your widgets on the page.
*
* @pre GFX_USE_GWIN must be set to GFXON in your gfxconf.h
* @pre GWIN_NEED_TABSET must be set to GFXON in your gfxconf.h
* @{
*/
#ifndef _GWIN_TABSET_H
#define _GWIN_TABSET_H
/* This file is included from src/gwin/gwin_container.h */
/**
* @brief The Event Type for a Tabset Event
*/
#define GEVENT_GWIN_TABSET (GEVENT_GWIN_CTRL_FIRST+5)
/**
* @brief A Tabset Event
* @note There are currently no GEventGWinTabset listening flags - use 0 as the flags to @p gwinAttachListener()
*/
typedef struct GEventGWinTabset {
GEventType type; // The type of this event (GEVENT_GWIN_TABSET)
GHandle gwin; // The tabset window handle
#if GWIN_NEED_WIDGET && GWIN_WIDGET_TAGS
WidgetTag tag; // The tag of the tabset
#endif
// Above are the generic widget event elements, below the tabset specific elements
GHandle ghPage; // The tabpage window handle that has been selected
int nPage; // The page number (0 to n-1) that has been selected
} GEventGWinTabset;
/**
* @brief Flags for gwinTabsetCreate()
* @{
*/
#define GWIN_TABSET_BORDER 0x00000001 // Should the tab pages have a border?
/** @} */
typedef struct GTabsetObject {
GContainerObject c;
gCoord border_top;
} GTabsetObject;
/**
* @brief Create a tabset widget
*
* @details This widget provides a set of tabs.
*
* @param[in] g The GDisplay to display this window on
* @param[in] fo The GTabsetObject structure to initialize. If this is NULL the structure is dynamically allocated.
* @param[in] pInit The initialization parameters
* @param[in] flags Some flags, see notes.
*
* @note Possible flags are: GWIN_TABSET_BORDER
*
* @return NULL if there is no resulting widget. A valid GHandle otherwise.
*
* @api
*/
GHandle gwinGTabsetCreate(GDisplay *g, GTabsetObject *fo, GWidgetInit *pInit, gU32 flags);
#define gwinTabsetCreate(fo, pInit, flags) gwinGTabsetCreate(GDISP, fo, pInit, flags);
/**
* @brief Add a tab-page to the tabset
* @returns The GHandle of the tab-page container.
*
* @param[in] gh The tabset handle
* @param[in] title 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.
*
* @api
*/
GHandle gwinTabsetAddTab(GHandle gh, const char *title, gBool useAlloc);
/**
* @brief Delete a tab-page.
* @details Any widgets on the page will also be destroyed
*
* @param[in] gh The tab-page handle
*
* @note The index position of all tabs after this tab in the tabset are automatically renumbered.
*
* @api
*/
#define gwinTabsetDeleteTab(gh) gwinDestroy(gh)
/**
* @brief Count the number of tabs in the tabset
* @returns The number of tabs or zero if none exist.
*
* @param[in] gh The tabset handle
*
* @api
*/
int gwinTabsetCountTabs(GHandle gh);
/**
* @brief Get the GHandle of a tab based on its position
* @returns The GHandle of the tab-page container or NULL if that tab-page doesn't exist.
*
* @param[in] gh The tabset handle
* @param[in] index The tab-page handle to return (0 to number of pages - 1)
*
* @api
*/
GHandle gwinTabsetGetTabByIndex(GHandle gh, int index);
/**
* @brief Get the GHandle of a tab based on its title
* @returns The GHandle of the tab-page container or NULL if that tab-page doesn't exist.
*
* @param[in] gh The tabset handle
* @param[in] title The title to search for
*
* @api
*/
GHandle gwinTabsetGetTabByTitle(GHandle gh, const char *title);
/**
* @brief Set the title of a tab-page.
*
* @param[in] gh The tab-page handle (NB: Use the page handle NOT the tabset handle)
* @param[in] title 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 This function should be used to change the text associated with a tab-page
* rather than @p gwinSetText().
*
* @api
*/
void gwinTabsetSetTitle(GHandle gh, const char *title, gBool useAlloc);
/**
* @brief Get the title of a tab-page.
* @return The title of the tab.
*
* @param[in] gh The tab-page handle (NB: Use the page handle NOT the tabset handle)
*
* @api
*/
#define gwinTabsetGetTitle(gh) gwinGetText(gh)
/**
* @brief Set the active tab in a tabset.
*
* @param[in] gh The tab-page handle (NB: Use the page handle NOT the tabset handle)
*
* @api
*/
void gwinTabsetSetTab(GHandle gh);
/**
* @defgroup Renderings_Tabset Renderings
*
* @brief Built-in rendering functions for the tabset widget.
*
* @details These function may be passed to @p gwinSetCustomDraw() to get different tabset drawing styles.
*
* @note In your custom tabset 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 The default rendering function for the tabset widget.
*
* @details Fills the client area with the background color.
*
* @param[in] gw The widget object (must be a container object).
* @param[in] param A parameter passed in from the user. Ignored by this function.
*
* @api
*/
void gwinTabsetDraw_Std(GWidgetObject *gw, void *param);
/**
* @brief Renders the tabset but leaves the client area transparent.
*
* @details Will not fill the client area at all.
*
* @param[in] gw The widget object (must be a container object).
* @param[in] param A parameter passed in from the user. Ignored by this function.
*
* @api
*/
void gwinTabsetDraw_Transparent(GWidgetObject *gw, void *param);
#if GDISP_NEED_IMAGE || defined(__DOXYGEN__)
/**
* @brief Renders the tabset and uses the specified image for the client area.
*
* @details The image will be tiled throghout the client area. Therefore, to archive the best looking result the
* supplied image needs to be of the same size as the client area size of the tabset widget (inner size).
*
* @param[in] gw The widget object (must be a tabset object).
* @param[in] param A parameter passed in from the user. Must be an image handle. See note below.
*
* @note The image must be already opened before calling @p gwinSetCustomDraw(). The handle is passed as the parameter
* to this function.
*
* @pre GDISP_NEED_IMAGE must be set to GFXON
*
* @api
*/
void gwinTabsetDraw_Image(GWidgetObject *gw, void *param);
#endif /* GDISP_NEED_IMAGE */
/** @} */
#endif /* _GWIN_TABSET_H */
/** @} */
|
