VSF Documented
vsf_tgui_list.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18/****************************************************************************
19* Copyright 2020 by Gorgon Meducer (Email:embedded_zhuoran@hotmail.com) *
20* *
21* Licensed under the Apache License, Version 2.0 (the "License"); *
22* you may not use this file except in compliance with the License. *
23* You may obtain a copy of the License at *
24* *
25* http://www.apache.org/licenses/LICENSE-2.0 *
26* *
27* Unless required by applicable law or agreed to in writing, software *
28* distributed under the License is distributed on an "AS IS" BASIS, *
29* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
30* See the License for the specific language governing permissions and *
31* limitations under the License. *
32* *
33****************************************************************************/
34
35#ifndef __VSF_TGUI_CONTROLS_LIST_H__
36#define __VSF_TGUI_CONTROLS_LIST_H__
37
38/*============================ INCLUDES ======================================*/
39
40#include "./vsf_tgui_control.h"
41#include "./__vk_tgui_slider.h"
42
43#if VSF_TGUI_CFG_SUPPORT_LIST == ENABLED
49#if defined(__VSF_TGUI_CONTROLS_LIST_CLASS_IMPLEMENT)
50# define __PLOOC_CLASS_IMPLEMENT__
51# undef __VSF_TGUI_CONTROLS_LIST_CLASS_IMPLEMENT
52#elif defined(__VSF_TGUI_CONTROLS_LIST_CLASS_INHERIT)
53# define __PLOOC_CLASS_INHERIT__
54# undef __VSF_TGUI_CONTROLS_LIST_CLASS_INHERIT
55#endif
56
57#include "utilities/ooc_class.h"
58
59#ifdef __cplusplus
60extern "C" {
61#endif
62
63/*============================ MACROS ========================================*/
64
65# define __VSF_TGUI_INTERFACE_CONTROLS_LIST { \
66 .msg_handler = { \
67 VSF_MSGT_NODE_HANDLER_TYPE_FSM, \
68 (vsf_msgt_method_fsm_t *)&vsf_tgui_list_msg_handler, \
69 }, \
70 .Status = (vsf_msgt_method_status_t *) \
71 &vsf_tgui_control_status_get, \
72 .Shoot = (vsf_msgt_method_shoot_t *)&vsf_tgui_control_shoot, \
73 }
74
75
76/*============================ MACROFIED FUNCTIONS ===========================*/
77
78# define __tgui_list( __NAME, \
79 __PARENT_ADDR, \
80 __PREVIOUS, \
81 __NEXT, ...) \
82 tgui_container_base( __NAME, \
83 VSF_TGUI_COMPONENT_ID_LIST, \
84 vsf_tgui_list_t, \
85 (__PARENT_ADDR), \
86 __PREVIOUS, \
87 __NEXT, \
88 VSF_TGUI_V_LIST_STATIC_INIT_DEFAULT \
89 __VA_ARGS__ \
90 VSF_TGUI_V_LIST_STATIC_INIT_OVERRIDE \
91 \
92 .ContainerAttribute \
93 .u5Type = VSF_TGUI_CONTAINER_TYPE_PLANE, \
94 .ContainerAttribute \
95 .bIsAutoSize = false, \
96 .bIsHideContentInsideContainer = false, \
97 .list.parent_ptr = \
98 (vsf_msgt_container_t *)&((__PARENT_ADDR)-> \
99 __NAME.use_as__vsf_msgt_node_t), \
100 .list.id = VSF_TGUI_COMPONENT_ID_CONTAINER, \
101 .list.Offset = {0}, \
102 .list.is_container = true, \
103 .list.bIsTransparent = true, \
104 .list.ContainerAttribute \
105 .bIsAutoSize = true, \
106 .list.bIsEnabled = true, \
107 .list.bIsVisible = true, \
108 .list.node_ptr = \
109 (vsf_msgt_node_t*) \
110 &((__PARENT_ADDR)-> \
111 __NAME.list.list_FirstNode), \
112 .list \
113 __tgui_name_string_tag( __NAME.list, \
114 vsf_tgui_list_t) \
115 )
116
117
118#define tgui_list( __NAME, \
119 __PARENT_ADDR, \
120 __PREVIOUS, \
121 __NEXT, \
122 ...) \
123 __tgui_list( __NAME, \
124 (__PARENT_ADDR), \
125 __PREVIOUS, \
126 __NEXT, \
127 __VA_ARGS__)
128
129# define tgui_list_items(...) \
130 .list = { \
131 VSF_TGUI_V_CONTAINER_STATIC_INIT_DEFAULT \
132 .is_container = false, \
133 .bIsTransparent = false, \
134 __VA_ARGS__ \
135 VSF_TGUI_V_CONTAINER_STATIC_INIT_OVERRIDE \
136 },
137
138
139#define __use_tgui_list(__NAME, ...) \
140 struct { \
141 implement(vsf_tgui_list_t); \
142 union { \
143 vsf_msgt_node_t __NAME##_FirstNode ; \
144 use_tgui_container(list, __VA_ARGS__) \
145 }; \
146 } __NAME;
147
148#define use_tgui_list(__NAME, ...) __use_tgui_list(__NAME, __VA_ARGS__)
149
150
151/*============================ TYPES =========================================*/
152
153typedef enum {
154 VSF_TGUI_LIST_MODE_FREE_MOVE_STICK_TO_ITEM ,
155 VSF_TGUI_LIST_MODE_FREE_MOVE , /* reserve for future */
156 VSF_TGUI_LIST_MODE_ITEM_SELECTION , /* reserve for future */
157 VSF_TGUI_LIST_MODE_ITEM_SELECTION_CENTER_ALIGN , /* reserve for future */
158} vsf_tgui_list_work_mode_t;
159
160typedef struct vsf_tgui_list_scrollbar_region_t {
161 vsf_tgui_region_t tTrack;
162 vsf_tgui_region_t tBar;
163} vsf_tgui_list_scrollbar_region_t;
164
165declare_class(vsf_tgui_list_t)
166
167def_class(vsf_tgui_list_t,
168 which(
169 implement(vsf_tgui_container_t)
170 implement(vsf_tgui_v_list_t)
171 )
172#if VSF_TGUI_CFG_LIST_SUPPORT_SLIDE == ENABLED
173 union {
174 struct {
175 private_member(
176 implement(__vk_tgui_slider_t)
177 /* use vsf_tgui_list_work_mode_t value*/
178 struct {
179 uint8_t u2WorkMode : 2;
180 uint8_t bIsSliding : 1;
181 uint8_t : 5;
182 }tMode;
183 union {
184 uint8_t chStartIndex;
185 uint8_t chSelectIndex;
186 };
187 )
188 };
189 struct {
190 inherit_ex(__vk_tgui_slider_t, tSlider)
191 /* use vsf_tgui_list_work_mode_t value*/
192 uint8_t u2WorkMode : 2;
193 };
194 };
195#else
196 union {
197 struct {
198 private_member(
199 /* use vsf_tgui_list_work_mode_t value*/
200 struct {
201 uint8_t u2WorkMode : 2;
202 uint8_t bIsSliding : 1;
203 uint8_t : 5;
204 }tMode;
205 union {
206 uint8_t chStartIndex;
207 uint8_t chSelectIndex;
208 };
209 )
210 };
211 struct {
212 /* use vsf_tgui_list_work_mode_t value*/
213 uint8_t u2WorkMode : 2;
214 };
215 };
216#endif
217 vsf_tgui_container_t ptList[];
218)
219
220end_def_class(vsf_tgui_list_t)
221
222/*============================ GLOBAL VARIABLES ==============================*/
223/*============================ PROTOTYPES ====================================*/
224
225extern
226fsm_rt_t vk_tgui_list_update(vsf_tgui_list_t* ptList);
227
228extern
229fsm_rt_t vk_tgui_list_init(vsf_tgui_list_t* ptList);
230
231extern
232fsm_rt_t vsf_tgui_list_msg_handler( vsf_tgui_list_t* control_ptr,
233 vsf_tgui_msg_t* ptMSG);
234
235#if VSF_TGUI_CFG_LIST_SUPPORT_SCROOLBAR == ENABLED
236VSF_CAL_SECTION(".text.vsf.component.tgui.vsf_tgui_list_scrollbar_regions_generate")
237extern
238vsf_tgui_list_scrollbar_region_t * vsf_tgui_list_scrollbar_regions_generate(
239 const vsf_tgui_control_t* control_ptr,
240 const vsf_tgui_list_t* ptList,
241 uint_fast8_t chScalingRatio,
242 vsf_tgui_list_scrollbar_region_t *ptOutputBuffer);
243#endif
244
245/*----------------------------------------------------------------------------*
246 * APIs for VSF_TGUI_LIST_MODE_FREE_MOVE_STICK_TO_ITEM mode *
247 *----------------------------------------------------------------------------*/
248extern
249int_fast16_t vk_tgui_list_display_item_start_get(vsf_tgui_list_t* ptList);
250
251extern
252int_fast16_t vk_tgui_list_display_item_start_set(vsf_tgui_list_t* ptList,
253 uint_fast8_t chStartIndex);
254
255/*----------------------------------------------------------------------------*
256 * APIs for VSF_TGUI_LIST_MODE_ITEM_SELECTION(_*) mode *
257 *----------------------------------------------------------------------------*/
258extern
259int_fast16_t vk_tgui_list_selected_item_get(vsf_tgui_list_t* ptList);
260
261extern
262int_fast16_t vk_tgui_list_selected_item_set(vsf_tgui_list_t* ptList,
263 uint_fast8_t chSelectIndex);
264
265#ifdef __cplusplus
266}
267#endif
268
269#endif
270#endif
271/* EOF */
VSF_CAL_SECTION
#define VSF_CAL_SECTION(__SEC)
Definition __compiler.h:181
ENABLED
#define ENABLED
Definition __type.h:28
__vk_tgui_slider.h
uint8_t
unsigned char uint8_t
Definition lvgl.h:40
ooc_class.h
uint_fast8_t
unsigned char uint_fast8_t
Definition stdint.h:23
int_fast16_t
short int_fast16_t
Definition stdint.h:24
vsf_tgui_list_scrollbar_region_t
Definition vsf_tgui_list.h:160
vsf_tgui_list_scrollbar_region_t::tBar
vsf_tgui_region_t tBar
Definition vsf_tgui_list.h:162
vsf_tgui_list_scrollbar_region_t::tTrack
vsf_tgui_region_t tTrack
Definition vsf_tgui_list.h:161
vsf_tgui_msg_t
Definition vsf_tgui_common.h:558
vsf_tgui_region_t
Definition vsf_tgui_common.h:281
fsm_rt_t
fsm_rt_t
Definition vsf_fsm.h:315
def_class
def_class(vsf_stream_fifo_t, which(vsf_stream_tx_t TX;vsf_stream_rx_t RX;), private:vsf_slist_queue_t union { vsf_stream_fifo_cfg_t cfg;struct { vsf_stream_dat_rdy_evt_t tDataReadyEventHandling;vsf_stream_dat_drn_evt_t tDataDrainEventHandling;vsf_stream_status_t Status;#if !defined(VSF_PBUF_QUEUE_CFG_ATOM_ACCESS) vsf_protect_region_t *pregion;#endif };};) end_def_class(vsf_stream_fifo_t) extern vsf_err_t vsf_stream_fifo_init(vsf_stream_fifo_t *obj_ptr
VSF_TGUI_CFG_LIST_SUPPORT_SLIDE
#define VSF_TGUI_CFG_LIST_SUPPORT_SLIDE
Definition vsf_tgui_cfg.h:226
vsf_tgui_control_t
struct vsf_tgui_control_t vsf_tgui_control_t
Definition vsf_tgui_common.h:555
vsf_tgui_control.h
ptMSG
which(vsf_tgui_control_t vsf_tgui_v_label_t) public vsf_tgui_msg_t * ptMSG
Definition vsf_tgui_label.h:161
vk_tgui_list_update
fsm_rt_t vk_tgui_list_update(vsf_tgui_list_t *ptList)
Definition vsf_tgui_list.c:392
which
which(vsf_tgui_container_t vsf_tgui_v_list_t) union
Definition vsf_tgui_list.h:168
declare_class
declare_class(vsf_tgui_list_t) def_class(vsf_tgui_list_t
vk_tgui_list_selected_item_get
int_fast16_t vk_tgui_list_selected_item_get(vsf_tgui_list_t *ptList)
Definition vsf_tgui_list.c:458
ptList
vsf_tgui_container_t ptList[]
Definition vsf_tgui_list.h:217
vk_tgui_list_display_item_start_get
int_fast16_t vk_tgui_list_display_item_start_get(vsf_tgui_list_t *ptList)
Definition vsf_tgui_list.c:432
end_def_class
end_def_class(vsf_tgui_list_t) extern fsm_rt_t vk_tgui_list_update(vsf_tgui_list_t *ptList)
vk_tgui_list_selected_item_set
int_fast16_t vk_tgui_list_selected_item_set(vsf_tgui_list_t *ptList, uint_fast8_t chSelectIndex)
Definition vsf_tgui_list.c:469
vsf_tgui_list_msg_handler
fsm_rt_t vsf_tgui_list_msg_handler(vsf_tgui_list_t *control_ptr, vsf_tgui_msg_t *ptMSG)
Definition vsf_tgui_list.c:284
vk_tgui_list_display_item_start_set
int_fast16_t vk_tgui_list_display_item_start_set(vsf_tgui_list_t *ptList, uint_fast8_t chStartIndex)
Definition vsf_tgui_list.c:443
vsf_tgui_list_scrollbar_regions_generate
vsf_tgui_list_scrollbar_region_t * vsf_tgui_list_scrollbar_regions_generate(const vsf_tgui_control_t *control_ptr, const vsf_tgui_list_t *ptList, uint_fast8_t chScalingRatio, vsf_tgui_list_scrollbar_region_t *ptOutputBuffer)
Definition vsf_tgui_list.c:487
vsf_tgui_list_work_mode_t
vsf_tgui_list_work_mode_t
Definition vsf_tgui_list.h:153
VSF_TGUI_LIST_MODE_ITEM_SELECTION
@ VSF_TGUI_LIST_MODE_ITEM_SELECTION
Definition vsf_tgui_list.h:156
VSF_TGUI_LIST_MODE_ITEM_SELECTION_CENTER_ALIGN
@ VSF_TGUI_LIST_MODE_ITEM_SELECTION_CENTER_ALIGN
Definition vsf_tgui_list.h:157
VSF_TGUI_LIST_MODE_FREE_MOVE_STICK_TO_ITEM
@ VSF_TGUI_LIST_MODE_FREE_MOVE_STICK_TO_ITEM
Definition vsf_tgui_list.h:154
VSF_TGUI_LIST_MODE_FREE_MOVE
@ VSF_TGUI_LIST_MODE_FREE_MOVE
Definition vsf_tgui_list.h:155
vk_tgui_list_init
fsm_rt_t vk_tgui_list_init(vsf_tgui_list_t *ptList)
Definition vsf_tgui_list.c:411
control_ptr
const vsf_tgui_control_t * control_ptr
Definition vsf_tgui_scguiv_port.h:91
Generated by doxygen 1.9.8