vsf_tgui_list.h File Reference

#include "./vsf_tgui_control.h"
#include "./__vk_tgui_slider.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
struct	vsf_tgui_list_scrollbar_region_t

Macros
#define	__VSF_TGUI_INTERFACE_CONTROLS_LIST
#define	__tgui_list( __NAME, __PARENT_ADDR, __PREVIOUS, __NEXT, ...)
#define	tgui_list( __NAME, __PARENT_ADDR, __PREVIOUS, __NEXT, ...)
#define	tgui_list_items(...)
#define	__use_tgui_list(__NAME, ...)
#define	use_tgui_list(__NAME, ...)   __use_tgui_list(__NAME, __VA_ARGS__)

Typedefs
typedef struct vsf_tgui_list_scrollbar_region_t	vsf_tgui_list_scrollbar_region_t

Enumerations
enum	vsf_tgui_list_work_mode_t {   VSF_TGUI_LIST_MODE_FREE_MOVE_STICK_TO_ITEM ,   VSF_TGUI_LIST_MODE_FREE_MOVE ,   VSF_TGUI_LIST_MODE_ITEM_SELECTION ,   VSF_TGUI_LIST_MODE_ITEM_SELECTION_CENTER_ALIGN }

Functions
	declare_class (vsf_tgui_list_t) def_class(vsf_tgui_list_t
	which (vsf_tgui_container_t vsf_tgui_v_list_t) union
	end_def_class (vsf_tgui_list_t) extern fsm_rt_t vk_tgui_list_update(vsf_tgui_list_t *ptList)
fsm_rt_t	vk_tgui_list_init (vsf_tgui_list_t *ptList)
fsm_rt_t	vsf_tgui_list_msg_handler (vsf_tgui_list_t *control_ptr, vsf_tgui_msg_t *ptMSG)
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)
int_fast16_t	vk_tgui_list_display_item_start_get (vsf_tgui_list_t *ptList)
int_fast16_t	vk_tgui_list_display_item_start_set (vsf_tgui_list_t *ptList, uint_fast8_t chStartIndex)
int_fast16_t	vk_tgui_list_selected_item_get (vsf_tgui_list_t *ptList)
int_fast16_t	vk_tgui_list_selected_item_set (vsf_tgui_list_t *ptList, uint_fast8_t chSelectIndex)

Variables
vsf_tgui_container_t	ptList []

Macro Definition Documentation

__VSF_TGUI_INTERFACE_CONTROLS_LIST

#define __VSF_TGUI_INTERFACE_CONTROLS_LIST

Value:

            {                       \
            .msg_handler = {                                                    \
                VSF_MSGT_NODE_HANDLER_TYPE_FSM,                                 \
                (vsf_msgt_method_fsm_t *)&vsf_tgui_list_msg_handler,            \
            },                                                                  \
            .Status = (vsf_msgt_method_status_t *)                              \
                        &vsf_tgui_control_status_get,                           \
            .Shoot = (vsf_msgt_method_shoot_t *)&vsf_tgui_control_shoot,        \
        }

\NOTE: Make sure #include "utilities/ooc_class.h" is close to the class ! definition and there is NO ANY OTHER module-interface-header file ! included in this file

__tgui_list

#define __tgui_list	(		__NAME,
			__PARENT_ADDR,
			__PREVIOUS,
			__NEXT,
			...
	)

tgui_list

#define tgui_list	(		__NAME,
			__PARENT_ADDR,
			__PREVIOUS,
			__NEXT,
			...
	)

Value:

            __tgui_list(    __NAME,                                             \
                            (__PARENT_ADDR),                                    \
                            __PREVIOUS,                                         \
                            __NEXT,                                             \
                            __VA_ARGS__)

tgui_list_items

#define tgui_list_items

(

...

)

Value:

                    .list = {                                                   \
                        VSF_TGUI_V_CONTAINER_STATIC_INIT_DEFAULT                \
                        .is_container = false,                                  \
                        .bIsTransparent = false,                                \
                        __VA_ARGS__                                             \
                        VSF_TGUI_V_CONTAINER_STATIC_INIT_OVERRIDE               \
                    },

__use_tgui_list

#define __use_tgui_list	(		__NAME,
			...
	)

Value:

    struct {                                                                    \
        implement(vsf_tgui_list_t);                                             \
        union {                                                                 \
            vsf_msgt_node_t __NAME##_FirstNode ;                                \
            use_tgui_container(list, __VA_ARGS__)                               \
        };                                                                      \
    } __NAME;

use_tgui_list

#define use_tgui_list	(		__NAME,
			...
	)		__use_tgui_list(__NAME, __VA_ARGS__)

Typedef Documentation

vsf_tgui_list_scrollbar_region_t

typedef struct vsf_tgui_list_scrollbar_region_t vsf_tgui_list_scrollbar_region_t

Enumeration Type Documentation

vsf_tgui_list_work_mode_t

enum vsf_tgui_list_work_mode_t

Enumerator
VSF_TGUI_LIST_MODE_FREE_MOVE_STICK_TO_ITEM
VSF_TGUI_LIST_MODE_FREE_MOVE
VSF_TGUI_LIST_MODE_ITEM_SELECTION
VSF_TGUI_LIST_MODE_ITEM_SELECTION_CENTER_ALIGN

Function Documentation

declare_class()

declare_class

(

vsf_tgui_list_t

)

which()

which

(

vsf_tgui_container_t

vsf_tgui_v_list_t

)

end_def_class()

end_def_class

(

vsf_tgui_list_t

)

vk_tgui_list_init()

fsm_rt_t vk_tgui_list_init ( vsf_tgui_list_t *  ptList )

extern

< slider

< host control

< use default fps

vsf_tgui_list_msg_handler()

fsm_rt_t vsf_tgui_list_msg_handler ( vsf_tgui_list_t *  control_ptr, vsf_tgui_msg_t *  ptMSG  )

extern

block backward propagation

fall-through

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  )

extern

vk_tgui_list_display_item_start_get()

int_fast16_t vk_tgui_list_display_item_start_get ( vsf_tgui_list_t *  ptList )

extern

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  )

extern

vk_tgui_list_selected_item_get()

int_fast16_t vk_tgui_list_selected_item_get ( vsf_tgui_list_t *  ptList )

extern

vk_tgui_list_selected_item_set()

int_fast16_t vk_tgui_list_selected_item_set ( vsf_tgui_list_t *  ptList, uint_fast8_t  chSelectIndex  )

extern

Variable Documentation

ptList

vsf_tgui_container_t ptList[]