vsf_tgui_text_list.h File Reference

#include "./vsf_tgui_list.h"
#include "./vsf_tgui_label.h"
#include "./__vk_tgui_slider.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Macros
#define	__VSF_TGUI_INTERFACE_CONTROLS_TEXT_LIST
#define	__tgui_text_list(__NAME, __PARENT_ADDR, __PREVIOUS, __NEXT, ...)
#define	tgui_text_list(__NAME, __PARENT_ADDR, __PREVIOUS, __NEXT, ...)
#define	tgui_text_list_content(...)

Functions
	declare_class (vsf_tgui_text_list_t) def_class(vsf_tgui_text_list_t
vsf_tgui_container_t vsf_tgui_v_text_list_t	use_tgui_container (tList, public:vsf_tgui_label_t tContent;private:vsf_tgui_label_t tBuffer;) union
	end_def_class (vsf_tgui_text_list_t) extern fsm_rt_t vsf_tgui_text_list_msg_handler(vsf_tgui_text_list_t *control_ptr
fsm_rt_t	vk_tgui_text_list_init (vsf_tgui_text_list_t *ptLabel)
fsm_rt_t	vk_tgui_text_list_update (vsf_tgui_text_list_t *ptLabel)
int_fast16_t	vsf_tgui_text_list_select_get (vsf_tgui_text_list_t *ptTextList)
void	vsf_tgui_text_list_select_set (vsf_tgui_text_list_t *ptTextList, int_fast16_t iSelect)
	set the index of selection ! !

Variables
vsf_tgui_msg_t *	ptMSG

Macro Definition Documentation

__VSF_TGUI_INTERFACE_CONTROLS_TEXT_LIST

#define __VSF_TGUI_INTERFACE_CONTROLS_TEXT_LIST

Value:

            {                     \
            .msg_handler = {                                                    \
                VSF_MSGT_NODE_HANDLER_TYPE_FSM,                                 \
                (vsf_msgt_method_fsm_t *)&vsf_tgui_text_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_text_list

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

tgui_text_list

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

Value:

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

tgui_text_list_content

#define tgui_text_list_content

(

...

)

Value:

                .tList.tContent = (vsf_tgui_label_t){                           \
                    VSF_TGUI_V_LABEL_STATIC_INIT_DEFAULT                        \
                    VSF_TGUI_V_TEXT_LIST_CONTENT_INIT_DEFAULT                   \
                    __VA_ARGS__                                                 \
                    VSF_TGUI_V_LABEL_STATIC_INIT_OVERRIDE                       \
                    VSF_TGUI_V_TEXT_LIST_CONTENT_INIT_OVERRIDE                  \
                    .id = VSF_TGUI_COMPONENT_ID_LABEL,                          \
                    .Offset = {                                                 \
                        .next =  sizeof(vsf_tgui_label_t),                      \
                    },                                                          \
                    __tgui_name_string_tag(tContent, vsf_tgui_label_t)          \
                    .bIsEnabled = true,                                         \
                    .bIsVisible = true,                                         \
                    .tLabel.bIsAutoSize = true,                                 \
                },

Function Documentation

declare_class()

declare_class

(

vsf_tgui_text_list_t

)

use_tgui_container()

vsf_tgui_container_t vsf_tgui_v_text_list_t use_tgui_container	(	tList	,
		public:vsf_tgui_label_t tContent;private:vsf_tgui_label_t tBuffer;
	)

end_def_class()

end_def_class

(

vsf_tgui_text_list_t

)

vk_tgui_text_list_init()

fsm_rt_t vk_tgui_text_list_init ( vsf_tgui_text_list_t *  ptLabel )

extern

< slider

< host control

< use default fps

vk_tgui_text_list_update()

fsm_rt_t vk_tgui_text_list_update ( vsf_tgui_text_list_t *  ptLabel )

extern

Note

before this function is called, all controls in the container are updated with TREE_UPDATE message

text list doesn't support autosize, let's fix this

vsf_tgui_text_list_select_get()

int_fast16_t vsf_tgui_text_list_select_get ( vsf_tgui_text_list_t *  ptTextList )

extern

vsf_tgui_text_list_select_set()

void vsf_tgui_text_list_select_set ( vsf_tgui_text_list_t *  ptTextList, int_fast16_t  iSelect  )

extern

set the index of selection ! !

Note

if the input number is out of the valid range, the text list will automatically ! correct it to the valid range. ! !

Parameters

ptTextList	the target text list object !
iSelect	user specified selection number !

Returns

none

Variable Documentation

ptMSG

vsf_tgui_msg_t* ptMSG