vsf_tgui_button.h File Reference

#include "./__vsf_tgui_controls_common.h"
#include "./vsf_tgui_label.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Macros
#define	__VSF_TGUI_INTERFACE_CONTROLS_BUTTON
#define	__tgui_button(__NAME, __PARENT_ADDR, __PREVIOUS, __NEXT, ...)
#define	tgui_button(__NAME, __PARENT_ADDR, __PREVIOUS, __NEXT, ...)
#define	__tgui_set_internal_button(__OWNER_ADDR, __MEMBER, __PREVIOUS, __NEXT, ...)
#define	tgui_set_internal_button(__OWNER_ADDR, __MEMBER, __PREVIOUS, __NEXT, ...)
#define	tgui_set_priv_button(__OWNER_ADDR, __MEMBER, ...)

Functions
	declare_class (vsf_tgui_button_t) def_class(vsf_tgui_button_t
which(vsf_tgui_label_t vsf_tgui_v_button_t) public fsm_rt_t	vk_tgui_button_update (vsf_tgui_button_t *ptButton)
fsm_rt_t	vsf_tgui_button_msg_handler (vsf_tgui_button_t *control_ptr, vsf_tgui_msg_t *ptMSG)

Macro Definition Documentation

__VSF_TGUI_INTERFACE_CONTROLS_BUTTON

#define __VSF_TGUI_INTERFACE_CONTROLS_BUTTON

Value:

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

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

Value:

        tgui_control_base(   __NAME,                                            \
                            VSF_TGUI_COMPONENT_ID_BUTTON,                       \
                            vsf_tgui_button_t,                                  \
                            (__PARENT_ADDR),                                    \
                            __PREVIOUS,                                         \
                            __NEXT,                                             \
                            VSF_TGUI_V_BUTTON_STATIC_INIT_DEFAULT               \
                            __VA_ARGS__                                         \
                            VSF_TGUI_V_BUTTON_STATIC_INIT_OVERRIDE)

tgui_button

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

Value:

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

__tgui_set_internal_button

#define __tgui_set_internal_button	(		__OWNER_ADDR,
			__MEMBER,
			__PREVIOUS,
			__NEXT,
			...
	)

Value:

            (*__OWNER_ADDR) tgui_button(                                        \
                                __MEMBER,                                       \
                                (__OWNER_ADDR),                                 \
                                __PREVIOUS,                                     \
                                __NEXT,                                         \
                                __VA_ARGS__)

tgui_set_internal_button

#define tgui_set_internal_button	(		__OWNER_ADDR,
			__MEMBER,
			__PREVIOUS,
			__NEXT,
			...
	)

Value:

        __tgui_set_internal_button(   (__OWNER_ADDR),                           \
                                    __MEMBER,                                   \
                                    __PREVIOUS,                                 \
                                    __NEXT,                                     \
                                    __VA_ARGS__)

tgui_set_priv_button

#define tgui_set_priv_button	(		__OWNER_ADDR,
			__MEMBER,
			...
	)

Value:

        __tgui_set_internal_button(   (__OWNER_ADDR),                           \
                                    __MEMBER,                                   \
                                    __MEMBER,                                   \
                                    __MEMBER,                                   \
                                    __VA_ARGS__)

Function Documentation

declare_class()

declare_class

(

vsf_tgui_button_t

)

vk_tgui_button_update()

which(vsf_tgui_label_t vsf_tgui_v_button_t) public fsm_rt_t vk_tgui_button_update ( vsf_tgui_button_t *  ptButton )

extern

vsf_tgui_button_msg_handler()

fsm_rt_t vsf_tgui_button_msg_handler ( vsf_tgui_button_t *  control_ptr, vsf_tgui_msg_t *  ptMSG  )

extern

some message has to be handled before calling user handler

fall-through

fall-through

fall-through

toggle the bIsChecked flag

fall-through

fall-through

fall-through