VSF Documented
Macros | Functions | Variables
vsf_tgui.h File Reference
#include "./vsf_tgui_cfg.h"
#include <VSF_TGUI_V_TEMPLATE_TYPE_HEADER_FILE>
#include "utilities/vsf_tgui_text.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Macros

#define VSF_TGUI_V_TEMPLATE_TYPE_HEADER_FILE   "./view/simple_view/vsf_tgui_v_type.h"
 

Functions

 declare_vsf_rng_buf (__vsf_tgui_evt_queue_t) def_vsf_rng_buf(__vsf_tgui_evt_queue_t
 
vsf_tgui_evt_t declare_structure (__vk_tgui_focus_t) def_structure(__vk_tgui_focus_t) const vsf_tgui_control_t *current_ptr
 
 end_def_structure (__vk_tgui_focus_t) declare_vsf_pt(__vsf_tgui_evt_shooter_t) def_vsf_pt(__vsf_tgui_evt_shooter_t
 
 def_params (__vsf_tgui_evt_queue_t *queue_ptr;vsf_msgt_t *msg_tree_ptr;const vsf_tgui_root_container_t *root_node_ptr;const vsf_msgt_node_t *node_ptr;vsf_tgui_evt_t event;const vsf_tgui_region_t *region_ptr;vsf_tgui_region_t temp_region;__vk_tgui_focus_t Activated;__vk_tgui_focus_t pointer_above;struct { uint8_t is_queue_drain :1;uint8_t is_dirty_region_include_transparent_area :1;} Attribute;)) end_def_vsf_pt(__vsf_tgui_evt_shooter_t) declare_class(vsf_tgui_t) def_class(vsf_tgui_t
 
vsf_tgui_v_port_t end_def_class (vsf_tgui_t) typedef struct vsf_tgui_cfg_t
 
vsf_err_t vk_tgui_init (vsf_tgui_t *gui_ptr, const vsf_tgui_cfg_t *cfg_ptr)
 
vsf_err_t vk_tgui_set_root_container (vsf_tgui_t *gui_ptr, vsf_tgui_root_container_t *root_node_ptr, bool req_first_refresh)
 
vsf_err_t vk_tgui_close_root_container (vsf_tgui_t *gui_ptr)
 
bool vk_tgui_send_message (vsf_tgui_t *gui_ptr, vsf_tgui_evt_t event)
 tgui msg queue producer
 
bool vk_tgui_update (vsf_tgui_t *gui_ptr, const vsf_tgui_control_t *target_ptr)
 
bool vk_tgui_update_tree (vsf_tgui_t *gui_ptr, const vsf_tgui_control_t *target_ptr)
 
bool vk_tgui_send_timer_event (vsf_tgui_t *gui_ptr, const vsf_tgui_control_t *target_ptr)
 
const vsf_tgui_control_tvsf_tgui_actived_control_get (vsf_tgui_t *gui_ptr)
 
const vsf_tgui_control_tvsf_tgui_pointed_control_get (vsf_tgui_t *gui_ptr)
 

Variables

const vsf_tgui_control_tprevious_ptr
 
 vsf_tgui_cfg_t
 

Macro Definition Documentation

◆ VSF_TGUI_V_TEMPLATE_TYPE_HEADER_FILE

#define VSF_TGUI_V_TEMPLATE_TYPE_HEADER_FILE   "./view/simple_view/vsf_tgui_v_type.h"

Function Documentation

◆ declare_vsf_rng_buf()

declare_vsf_rng_buf ( __vsf_tgui_evt_queue_t  )

\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

◆ declare_structure()

vsf_tgui_evt_t declare_structure ( __vk_tgui_focus_t  ) const

◆ end_def_structure()

end_def_structure ( __vk_tgui_focus_t  )

◆ def_params()

def_params ( __vsf_tgui_evt_queue_t *queue_ptr;vsf_msgt_t *msg_tree_ptr;const vsf_tgui_root_container_t *root_node_ptr;const vsf_msgt_node_t *node_ptr;vsf_tgui_evt_t event;const vsf_tgui_region_t *region_ptr;vsf_tgui_region_t temp_region;__vk_tgui_focus_t Activated;__vk_tgui_focus_t pointer_above;struct { uint8_t is_queue_drain :1;uint8_t is_dirty_region_include_transparent_area :1;} Attribute )

◆ end_def_class()

vsf_tgui_v_port_t end_def_class ( vsf_tgui_t  )

◆ vk_tgui_init()

vsf_err_t vk_tgui_init ( vsf_tgui_t *  gui_ptr,
const vsf_tgui_cfg_t cfg_ptr 
)
extern

◆ vk_tgui_set_root_container()

vsf_err_t vk_tgui_set_root_container ( vsf_tgui_t *  gui_ptr,
vsf_tgui_root_container_t root_node_ptr,
bool  req_first_refresh 
)
extern

◆ vk_tgui_close_root_container()

vsf_err_t vk_tgui_close_root_container ( vsf_tgui_t *  gui_ptr)
extern

◆ vk_tgui_send_message()

bool vk_tgui_send_message ( vsf_tgui_t *  gui_ptr,
vsf_tgui_evt_t  event 
)
extern

tgui msg queue producer

wake pt task up

◆ vk_tgui_update()

bool vk_tgui_update ( vsf_tgui_t *  gui_ptr,
const vsf_tgui_control_t target_ptr 
)
extern

◆ vk_tgui_update_tree()

bool vk_tgui_update_tree ( vsf_tgui_t *  gui_ptr,
const vsf_tgui_control_t target_ptr 
)
extern

◆ vk_tgui_send_timer_event()

bool vk_tgui_send_timer_event ( vsf_tgui_t *  gui_ptr,
const vsf_tgui_control_t target_ptr 
)
extern

◆ vsf_tgui_actived_control_get()

const vsf_tgui_control_t * vsf_tgui_actived_control_get ( vsf_tgui_t *  gui_ptr)
extern

◆ vsf_tgui_pointed_control_get()

const vsf_tgui_control_t * vsf_tgui_pointed_control_get ( vsf_tgui_t *  gui_ptr)
extern

Variable Documentation

◆ previous_ptr

const vsf_tgui_control_t* previous_ptr

◆ finger_idx_pre

int8_t finger_idx_pre

◆ is_finger0_down

uint8_t is_finger0_down

◆ is_finger1_down

uint8_t is_finger1_down

◆ __pad0__

uint8_t __pad0__

◆ location_pre

vsf_tgui_location_t location_pre[2]

◆ status

uint8_t status

◆ [union]

union { ... } finger

◆ current

vsf_tgui_location_t current[2]

◆ vsf_tgui_cfg_t

vsf_tgui_cfg_t