lv_dropdown.h

Go to the documentation of this file.

 
#ifndef LV_DROPDOWN_H
#define LV_DROPDOWN_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#if LV_USE_DROPDOWN != 0
 
/*Testing of dependencies*/
 
#if LV_USE_LABEL == 0
#error "lv_dropdown: lv_label is required. Enable it in lv_conf.h (LV_USE_LABEL 1)"
#endif
 
#include "../widgets/lv_label.h"
 
/*********************
 *      DEFINES
 *********************/
#define LV_DROPDOWN_POS_LAST 0xFFFF
LV_EXPORT_CONST_INT(LV_DROPDOWN_POS_LAST);
 
/**********************
 *      TYPEDEFS
 **********************/
 
typedef struct {
    lv_obj_t obj;
    lv_obj_t * list;                
    const char * text;              
    const void * symbol;            
    char * options;                 
    uint16_t option_cnt;            
    uint16_t sel_opt_id;            
    uint16_t sel_opt_id_orig;       
    uint16_t pr_opt_id;             
    lv_dir_t dir              : 4;  
    uint8_t static_txt        : 1;  
    uint8_t selected_highlight: 1;  
} lv_dropdown_t;
 
typedef struct {
    lv_obj_t obj;
    lv_obj_t * dropdown;
} lv_dropdown_list_t;
 
extern const  lv_obj_class_t lv_dropdown_class;
extern const  lv_obj_class_t lv_dropdownlist_class;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_dropdown_create(lv_obj_t * parent);
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_dropdown_set_text(lv_obj_t * obj, const char * txt);
 
void lv_dropdown_set_options(lv_obj_t * obj, const char * options);
 
void lv_dropdown_set_options_static(lv_obj_t * obj, const char * options);
 
void lv_dropdown_add_option(lv_obj_t * obj, const char * option, uint32_t pos);
 
void lv_dropdown_clear_options(lv_obj_t * obj);
 
void lv_dropdown_set_selected(lv_obj_t * obj, uint16_t sel_opt);
 
void lv_dropdown_set_dir(lv_obj_t * obj, lv_dir_t dir);
 
void lv_dropdown_set_symbol(lv_obj_t * obj, const void * symbol);
 
void lv_dropdown_set_selected_highlight(lv_obj_t * obj, bool en);
 
/*=====================
 * Getter functions
 *====================*/
 
lv_obj_t * lv_dropdown_get_list(lv_obj_t * obj);
 
const char * lv_dropdown_get_text(lv_obj_t * obj);
 
const char * lv_dropdown_get_options(const lv_obj_t * obj);
 
uint16_t lv_dropdown_get_selected(const lv_obj_t * obj);
 
uint16_t lv_dropdown_get_option_cnt(const lv_obj_t * obj);
 
void lv_dropdown_get_selected_str(const lv_obj_t * obj, char * buf, uint32_t buf_size);
 
int32_t lv_dropdown_get_option_index(lv_obj_t * obj, const char * option);
 
const char * lv_dropdown_get_symbol(lv_obj_t * obj);
 
bool lv_dropdown_get_selected_highlight(lv_obj_t * obj);
 
lv_dir_t lv_dropdown_get_dir(const lv_obj_t * obj);
 
/*=====================
 * Other functions
 *====================*/
 
void lv_dropdown_open(lv_obj_t * dropdown_obj);
 
void lv_dropdown_close(lv_obj_t * obj);
 
bool lv_dropdown_is_open(lv_obj_t * obj);
 
/**********************
 *      MACROS
 **********************/
 
#endif /*LV_USE_DROPDOWN*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_DROPDOWN_H*/