/** * @file lv_ddlist.c * */ /********************* * INCLUDES *********************/ #include "lv_dropdown.h" #if LV_USE_DROPDOWN != 0 #include "../lv_misc/lv_debug.h" #include "../lv_draw/lv_draw.h" #include "../lv_core/lv_group.h" #include "../lv_core/lv_indev.h" #include "../lv_core/lv_disp.h" #include "../lv_themes/lv_theme.h" #include "../lv_font/lv_symbol_def.h" #include "../lv_misc/lv_anim.h" #include "../lv_misc/lv_math.h" #include /********************* * DEFINES *********************/ #define LV_OBJX_NAME "lv_dropdown" #if LV_USE_ANIMATION == 0 #undef LV_DROPDOWN_DEF_ANIM_TIME #define LV_DROPDOWN_DEF_ANIM_TIME 0 /*No animation*/ #endif #define LV_DROPDOWN_PR_NONE 0xFFFF /********************** * TYPEDEFS **********************/ typedef struct { lv_page_ext_t page; lv_obj_t * ddlist; /*Pointer to the ddlist where the page belongs*/ } lv_dropdown_page_ext_t; /********************** * STATIC PROTOTYPES **********************/ static lv_design_res_t lv_dropdown_design(lv_obj_t * ddlist, const lv_area_t * clip_area, lv_design_mode_t mode); static lv_design_res_t lv_dropdown_page_design(lv_obj_t * ddlist, const lv_area_t * clip_area, lv_design_mode_t mode); static lv_res_t lv_dropdown_signal(lv_obj_t * ddlist, lv_signal_t sign, void * param); static lv_res_t lv_dropdown_page_signal(lv_obj_t * page, lv_signal_t sign, void * param); static lv_res_t lv_dropdown_page_scrl_signal(lv_obj_t * scrl, lv_signal_t sign, void * param); static lv_style_list_t * lv_dropdown_get_style(lv_obj_t * ddlist, uint8_t part); static void draw_box(lv_obj_t * ddlist, const lv_area_t * clip_area, uint16_t id, lv_state_t state); static void draw_box_label(lv_obj_t * ddlist, const lv_area_t * clip_area, uint16_t id, lv_state_t state); static lv_res_t page_release_handler(lv_obj_t * page); static void page_press_handler(lv_obj_t * page); static uint16_t get_id_on_point(lv_obj_t * ddlist, lv_coord_t x, lv_coord_t y); static void position_to_selected(lv_obj_t * ddlist); static lv_obj_t * get_label(const lv_obj_t * ddlist); /********************** * STATIC VARIABLES **********************/ static lv_signal_cb_t ancestor_signal; static lv_signal_cb_t ancestor_page_signal; static lv_signal_cb_t ancestor_page_scrl_signal; static lv_design_cb_t ancestor_design; static lv_design_cb_t ancestor_page_design; /********************** * MACROS **********************/ /********************** * GLOBAL FUNCTIONS **********************/ /** * Create a drop down list objects * @param par pointer to an object, it will be the parent of the new drop down list * @param copy pointer to a drop down list object, if not NULL then the new object will be copied * from it * @return pointer to the created drop down list */ lv_obj_t * lv_dropdown_create(lv_obj_t * par, const lv_obj_t * copy) { LV_LOG_TRACE("drop down list create started"); /*Create the ancestor drop down list*/ lv_obj_t * ddlist = lv_obj_create(par, copy); LV_ASSERT_MEM(ddlist); if(ddlist == NULL) return NULL; if(ancestor_signal == NULL) ancestor_signal = lv_obj_get_signal_cb(ddlist); if(ancestor_design == NULL) ancestor_design = lv_obj_get_design_cb(ddlist); /*Allocate the drop down list type specific extended data*/ lv_dropdown_ext_t * ext = lv_obj_allocate_ext_attr(ddlist, sizeof(lv_dropdown_ext_t)); LV_ASSERT_MEM(ext); if(ext == NULL) { lv_obj_del(ddlist); return NULL; } /*Initialize the allocated 'ext' */ ext->page = NULL; ext->options = NULL; ext->symbol = LV_SYMBOL_DOWN; ext->text = "Select"; ext->static_txt = 1; ext->show_selected = 1; ext->sel_opt_id = 0; ext->sel_opt_id_orig = 0; ext->pr_opt_id = LV_DROPDOWN_PR_NONE; ext->option_cnt = 0; ext->dir = LV_DROPDOWN_DIR_DOWN; ext->max_height = (3 * lv_disp_get_ver_res(NULL)) / 4; lv_style_list_init(&ext->style_page); lv_style_list_init(&ext->style_scrlbar); lv_style_list_init(&ext->style_selected); /*The signal and design functions are not copied so set them here*/ lv_obj_set_signal_cb(ddlist, lv_dropdown_signal); lv_obj_set_design_cb(ddlist, lv_dropdown_design); /*Init the new drop down list drop down list*/ if(copy == NULL) { lv_obj_set_width(ddlist, LV_DPX(150)); lv_dropdown_set_options_static(ddlist, "Option 1\nOption 2\nOption 3"); lv_theme_apply(ddlist, LV_THEME_DROPDOWN); } /*Copy an existing drop down list*/ else { lv_dropdown_ext_t * copy_ext = lv_obj_get_ext_attr(copy); if(copy_ext->static_txt == 0) lv_dropdown_set_options(ddlist, lv_dropdown_get_options(copy)); else lv_dropdown_set_options_static(ddlist, lv_dropdown_get_options(copy)); ext->option_cnt = copy_ext->option_cnt; ext->sel_opt_id = copy_ext->sel_opt_id; ext->sel_opt_id_orig = copy_ext->sel_opt_id; ext->symbol = copy_ext->symbol; ext->max_height = copy_ext->max_height; ext->text = copy_ext->text; ext->dir = copy_ext->dir; ext->show_selected = copy_ext->show_selected; lv_style_list_copy(&ext->style_page, ©_ext->style_page); lv_style_list_copy(&ext->style_selected, ©_ext->style_selected); lv_style_list_copy(&ext->style_scrlbar, ©_ext->style_scrlbar); } LV_LOG_INFO("drop down list created"); return ddlist; } /*===================== * Setter functions *====================*/ /** * Set text of the ddlist (Displayed on the button if `show_selected = false`) * @param ddlist pointer to a drop down list object * @param txt the text as a string (Only it's pointer is saved) */ void lv_dropdown_set_text(lv_obj_t * ddlist, const char * txt) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(ext->text == txt) return; ext->text = txt; lv_obj_invalidate(ddlist); } /** * Clear any options in a drop down list. Static or dynamic. * @param ddlist pointer to drop down list object */ void lv_dropdown_clear_options(lv_obj_t * ddlist) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(ext->options == NULL) return; if(ext->static_txt == 0) lv_mem_free(ext->options); ext->options = NULL; ext->static_txt = 0; ext->option_cnt = 0; lv_obj_invalidate(ddlist); } /** * Set the options in a drop down list from a string * @param ddlist pointer to drop down list object * @param options a string with '\n' separated options. E.g. "One\nTwo\nThree" * The options string can be destroyed after calling this function */ void lv_dropdown_set_options(lv_obj_t * ddlist, const char * options) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); LV_ASSERT_STR(options); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); /*Count the '\n'-s to determine the number of options*/ ext->option_cnt = 0; uint32_t i; for(i = 0; options[i] != '\0'; i++) { if(options[i] == '\n') ext->option_cnt++; } ext->option_cnt++; /*Last option has no `\n`*/ ext->sel_opt_id = 0; ext->sel_opt_id_orig = 0; /*Allocate space for the new text*/ size_t len = strlen(options) + 1; if(ext->options != NULL && ext->static_txt == 0) { lv_mem_free(ext->options); ext->options = NULL; } ext->options = lv_mem_alloc(len); LV_ASSERT_MEM(ext->options); if(ext->options == NULL) return; strcpy(ext->options, options); /*Now the text is dynamically allocated*/ ext->static_txt = 0; } /** * Set the options in a drop down list from a string * @param ddlist pointer to drop down list object * @param options a static string with '\n' separated options. E.g. "One\nTwo\nThree" */ void lv_dropdown_set_options_static(lv_obj_t * ddlist, const char * options) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); LV_ASSERT_STR(options); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); /*Count the '\n'-s to determine the number of options*/ ext->option_cnt = 0; uint32_t i; for(i = 0; options[i] != '\0'; i++) { if(options[i] == '\n') ext->option_cnt++; } ext->option_cnt++; /*Last option has no `\n`*/ ext->sel_opt_id = 0; ext->sel_opt_id_orig = 0; if(ext->static_txt == 0 && ext->options != NULL) { lv_mem_free(ext->options); ext->options = NULL; } ext->static_txt = 1; ext->options = (char *)options; } /** * Add an options to a drop down list from a string. Only works for dynamic options. * @param ddlist pointer to drop down list object * @param option a string without '\n'. E.g. "Four" * @param pos the insert position, indexed from 0, LV_DROPDOWN_POS_LAST = end of string */ void lv_dropdown_add_option(lv_obj_t * ddlist, const char * option, uint32_t pos) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); LV_ASSERT_STR(option); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); /*Convert static options to dynamic*/ if(ext->static_txt != 0) { char * static_options = ext->options; size_t len = strlen(static_options) + 1; ext->options = lv_mem_alloc(len); LV_ASSERT_MEM(ext->options); if(ext->options == NULL) return; strcpy(ext->options, static_options); ext->static_txt = 0; } /*Allocate space for the new option*/ size_t old_len = (ext->options == NULL) ? 0 : strlen(ext->options); size_t ins_len = strlen(option); size_t new_len = ins_len + old_len + 2; /* +2 for terminating NULL and possible \n */ ext->options = lv_mem_realloc(ext->options, new_len + 1); LV_ASSERT_MEM(ext->options); if(ext->options == NULL) return; ext->options[old_len] = 0; /*Find the insert character position*/ uint32_t insert_pos = old_len; if(pos != LV_DROPDOWN_POS_LAST) { uint32_t opcnt = 0; for(insert_pos = 0; ext->options[insert_pos] != 0; insert_pos++) { if(opcnt == pos) break; if(ext->options[insert_pos] == '\n') opcnt++; } } /*Add delimiter to existing options*/ if((insert_pos > 0) && (pos >= ext->option_cnt)) _lv_txt_ins(ext->options, _lv_txt_encoded_get_char_id(ext->options, insert_pos++), "\n"); /*Insert the new option, adding \n if necessary*/ char * ins_buf = _lv_mem_buf_get(ins_len + 2); /* + 2 for terminating NULL and possible \n */ LV_ASSERT_MEM(ins_buf); if(ins_buf == NULL) return; strcpy(ins_buf, option); if(pos < ext->option_cnt) strcat(ins_buf, "\n"); _lv_txt_ins(ext->options, _lv_txt_encoded_get_char_id(ext->options, insert_pos), ins_buf); _lv_mem_buf_release(ins_buf); ext->option_cnt++; lv_obj_invalidate(ddlist); } /** * Set the selected option * @param ddlist pointer to drop down list object * @param sel_opt id of the selected option (0 ... number of option - 1); */ void lv_dropdown_set_selected(lv_obj_t * ddlist, uint16_t sel_opt) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(ext->sel_opt_id == sel_opt) return; ext->sel_opt_id = sel_opt < ext->option_cnt ? sel_opt : ext->option_cnt - 1; ext->sel_opt_id_orig = ext->sel_opt_id; /*Move the list to show the current option*/ if(ext->page != NULL) { lv_obj_invalidate(ddlist); } } /** * Set the direction of the a drop down list * @param ddlist pointer to a drop down list object * @param dir LV_DROPDOWN_DIR_LEF/RIGHT/TOP/BOTTOM */ void lv_dropdown_set_dir(lv_obj_t * ddlist, lv_dropdown_dir_t dir) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(ext->dir == dir) return; ext->dir = dir; lv_obj_invalidate(ddlist); } /** * Set the maximal height for the drop down list * @param ddlist pointer to a drop down list * @param h the maximal height */ void lv_dropdown_set_max_height(lv_obj_t * ddlist, lv_coord_t h) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(ext->max_height == h) return; ext->max_height = h; if(ext->page) { if(h == 0) { lv_cont_set_fit(ext->page, LV_FIT_TIGHT); } else { lv_cont_set_fit2(ext->page, LV_FIT_TIGHT, LV_FIT_NONE); lv_obj_set_height(ext->page, h); } } } /** * Set an arrow or other symbol to display when the drop-down list is closed. * @param ddlist pointer to drop down list object * @param symbol a text like `LV_SYMBOL_DOWN` or NULL to not draw icon */ void lv_dropdown_set_symbol(lv_obj_t * ddlist, const char * symbol) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); ext->symbol = symbol; lv_obj_invalidate(ddlist); } /** * Set whether the ddlist highlight the last selected option and display its text or not * @param ddlist pointer to a drop down list object * @param show true/false */ void lv_dropdown_set_show_selected(lv_obj_t * ddlist, bool show) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(ext->show_selected == show) return; ext->show_selected = show; lv_obj_invalidate(ddlist); } /*===================== * Getter functions *====================*/ /** * Get text of the ddlist (Displayed on the button if `show_selected = false`) * @param ddlist pointer to a drop down list object * @return the text string */ const char * lv_dropdown_get_text(lv_obj_t * ddlist) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); return ext->text; } /** * Get the options of a drop down list * @param ddlist pointer to drop down list object * @return the options separated by '\n'-s (E.g. "Option1\nOption2\nOption3") */ const char * lv_dropdown_get_options(const lv_obj_t * ddlist) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); return ext->options; } /** * Get the selected option * @param ddlist pointer to drop down list object * @return id of the selected option (0 ... number of option - 1); */ uint16_t lv_dropdown_get_selected(const lv_obj_t * ddlist) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); return ext->sel_opt_id; } /** * Get the total number of options * @param ddlist pointer to drop down list object * @return the total number of options in the list */ uint16_t lv_dropdown_get_option_cnt(const lv_obj_t * ddlist) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); return ext->option_cnt; } /** * Get the current selected option as a string * @param ddlist pointer to ddlist object * @param buf pointer to an array to store the string * @param buf_size size of `buf` in bytes. 0: to ignore it. */ void lv_dropdown_get_selected_str(const lv_obj_t * ddlist, char * buf, uint32_t buf_size) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); uint32_t i; uint32_t line = 0; size_t txt_len = strlen(ext->options); for(i = 0; i < txt_len && line != ext->sel_opt_id_orig; i++) { if(ext->options[i] == '\n') line++; } uint32_t c; for(c = 0; i < txt_len && ext->options[i] != '\n'; c++, i++) { if(buf_size && c >= buf_size - 1) { LV_LOG_WARN("lv_dropdown_get_selected_str: the buffer was too small") break; } buf[c] = ext->options[i]; } buf[c] = '\0'; } /** * Get the fix height value. * @param ddlist pointer to a drop down list object * @return the height if the ddlist is opened (0: auto size) */ lv_coord_t lv_dropdown_get_max_height(const lv_obj_t * ddlist) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); return ext->max_height; } /** * Get the symbol to draw when the drop-down list is closed * @param ddlist pointer to drop down list object * @return the symbol or NULL if not enabled */ const char * lv_dropdown_get_symbol(lv_obj_t * ddlist) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); return ext->symbol; } /** * Get the direction of the drop down list * @param ddlist pointer to a drop down list object * @return LV_DROPDOWN_DIR_LEF/RIGHT/TOP/BOTTOM */ lv_dropdown_dir_t lv_dropdown_get_dir(const lv_obj_t * ddlist) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); return ext->dir; } /** * Get whether the ddlist highlight the last selected option and display its text or not * @param ddlist pointer to a drop down list object * @return true/false */ bool lv_dropdown_get_show_selected(lv_obj_t * ddlist) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); return ext->show_selected ? true : false; } /*===================== * Other functions *====================*/ /** * Open the drop down list with or without animation * @param ddlist pointer to drop down list object */ void lv_dropdown_open(lv_obj_t * ddlist) { lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(ext->page) return; ext->page = lv_page_create(lv_obj_get_screen(ddlist), NULL); lv_obj_add_protect(ext->page, LV_PROTECT_POS | LV_PROTECT_CLICK_FOCUS); lv_obj_add_protect(lv_page_get_scrollable(ext->page), LV_PROTECT_CLICK_FOCUS); lv_obj_set_base_dir(ext->page, lv_obj_get_base_dir(ddlist)); if(ancestor_page_signal == NULL) ancestor_page_signal = lv_obj_get_signal_cb(ext->page); if(ancestor_page_scrl_signal == NULL) ancestor_page_scrl_signal = lv_obj_get_signal_cb(lv_page_get_scrollable( ext->page)); if(ancestor_page_design == NULL) ancestor_page_design = lv_obj_get_design_cb(ext->page); lv_dropdown_page_ext_t * page_ext = lv_obj_allocate_ext_attr(ext->page, sizeof(lv_dropdown_page_ext_t)); LV_ASSERT_MEM(page_ext); if(page_ext == NULL) { lv_obj_del(ext->page); ext->page = NULL; return; } page_ext->ddlist = ddlist; lv_obj_set_design_cb(ext->page, lv_dropdown_page_design); lv_obj_set_signal_cb(ext->page, lv_dropdown_page_signal); lv_obj_set_signal_cb(lv_page_get_scrollable(ext->page), lv_dropdown_page_scrl_signal); lv_style_list_copy(lv_obj_get_style_list(ext->page, LV_PAGE_PART_BG), &ext->style_page); lv_style_list_copy(lv_obj_get_style_list(ext->page, LV_PAGE_PART_SCROLLBAR), &ext->style_scrlbar); lv_obj_clean_style_list(ext->page, LV_PAGE_PART_SCROLLABLE); lv_obj_refresh_style(ext->page, LV_OBJ_PART_ALL, LV_STYLE_PROP_ALL); lv_obj_t * label = lv_label_create(ext->page, NULL); lv_label_set_text_static(label, ext->options); lv_cont_set_fit2(ext->page, LV_FIT_TIGHT, LV_FIT_NONE); /*Set small width to the width of the button*/ if(lv_obj_get_width(ext->page) < lv_obj_get_width(ddlist) && (ext->dir == LV_DROPDOWN_DIR_UP || ext->dir == LV_DROPDOWN_DIR_DOWN)) { lv_cont_set_fit2(ext->page, LV_FIT_NONE, LV_FIT_NONE); lv_obj_set_width(ext->page, lv_obj_get_width(ddlist)); } lv_coord_t label_h = lv_obj_get_height(label); lv_style_int_t top = lv_obj_get_style_pad_top(ddlist, LV_DROPDOWN_PART_LIST); lv_style_int_t bottom = lv_obj_get_style_pad_bottom(ddlist, LV_DROPDOWN_PART_LIST); lv_coord_t list_fit_h = label_h + top + bottom; lv_coord_t list_h = list_fit_h; if(list_h > ext->max_height) list_h = ext->max_height; lv_dropdown_dir_t dir = ext->dir; /*No place on the bottom? See if top is better.*/ if(ext->dir == LV_DROPDOWN_DIR_DOWN) { if(ddlist->coords.y2 + list_h > LV_VER_RES) { if(ddlist->coords.y1 > LV_VER_RES - ddlist->coords.y2) { /*There is more space on the top, so make it drop up*/ dir = LV_DROPDOWN_DIR_UP; list_h = ddlist->coords.y1; } else { list_h = LV_VER_RES - ddlist->coords.y2; } } } /*No place on the top? See if bottom is better.*/ else if(ext->dir == LV_DROPDOWN_DIR_UP) { if(ddlist->coords.y1 - list_h < 0) { if(ddlist->coords.y1 < LV_VER_RES - ddlist->coords.y2) { /*There is more space on the top, so make it drop up*/ dir = LV_DROPDOWN_DIR_DOWN; list_h = LV_VER_RES - ddlist->coords.y2; } else { list_h = ddlist->coords.y1; } } } if(list_h > list_fit_h) list_h = list_fit_h; if(list_h > ext->max_height) list_h = ext->max_height; lv_obj_set_height(ext->page, list_h); position_to_selected(ddlist); if(dir == LV_DROPDOWN_DIR_DOWN) lv_obj_align(ext->page, ddlist, LV_ALIGN_OUT_BOTTOM_LEFT, 0, 0); else if(dir == LV_DROPDOWN_DIR_UP) lv_obj_align(ext->page, ddlist, LV_ALIGN_OUT_TOP_LEFT, 0, 0); else if(dir == LV_DROPDOWN_DIR_LEFT) lv_obj_align(ext->page, ddlist, LV_ALIGN_OUT_LEFT_TOP, 0, 0); else if(dir == LV_DROPDOWN_DIR_RIGHT)lv_obj_align(ext->page, ddlist, LV_ALIGN_OUT_RIGHT_TOP, 0, 0); if(ext->dir == LV_DROPDOWN_DIR_LEFT || ext->dir == LV_DROPDOWN_DIR_RIGHT) { if(ext->page->coords.y2 > LV_VER_RES) { lv_obj_set_y(ext->page, lv_obj_get_y(ext->page) - (ext->page->coords.y2 - LV_VER_RES)); } } if(lv_label_get_align(label) == LV_LABEL_ALIGN_RIGHT) { lv_obj_set_x(label, lv_obj_get_width_fit(ext->page) - lv_obj_get_width(label)); } } /** * Close (Collapse) the drop down list * @param ddlist pointer to drop down list object */ void lv_dropdown_close(lv_obj_t * ddlist) { lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(ext->page == NULL) return; ext->pr_opt_id = LV_DROPDOWN_PR_NONE; lv_obj_del(ext->page); ext->page = NULL; } /********************** * STATIC FUNCTIONS **********************/ /** * Handle the drawing related tasks of the drop down list * @param ddlist pointer to an object * @param clip_area the object will be drawn only in this area * @param mode LV_DESIGN_COVER_CHK: only check if the object fully covers the 'mask_p' area * (return 'true' if yes) * LV_DESIGN_DRAW: draw the object (always return 'true') * LV_DESIGN_DRAW_POST: drawing after every children are drawn * @param return an element of `lv_design_res_t` */ static lv_design_res_t lv_dropdown_design(lv_obj_t * ddlist, const lv_area_t * clip_area, lv_design_mode_t mode) { /*Return false if the object is not covers the mask_p area*/ if(mode == LV_DESIGN_COVER_CHK) { return ancestor_design(ddlist, clip_area, mode); } /*Draw the object*/ else if(mode == LV_DESIGN_DRAW_MAIN) { ancestor_design(ddlist, clip_area, mode); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); lv_style_int_t left = lv_obj_get_style_pad_left(ddlist, LV_DROPDOWN_PART_MAIN); lv_style_int_t right = lv_obj_get_style_pad_right(ddlist, LV_DROPDOWN_PART_MAIN); lv_style_int_t top = lv_obj_get_style_pad_top(ddlist, LV_DROPDOWN_PART_MAIN); lv_draw_label_dsc_t label_dsc; lv_draw_label_dsc_init(&label_dsc); lv_obj_init_draw_label_dsc(ddlist, LV_DROPDOWN_PART_MAIN, &label_dsc); lv_area_t txt_area; lv_point_t txt_size; const char * opt_txt = ext->text; if(ext->show_selected) { char * buf = _lv_mem_buf_get(128); lv_dropdown_get_selected_str(ddlist, buf, 128); opt_txt = buf; } const char * txt; bool rev = false; if(ext->dir == LV_DROPDOWN_DIR_LEFT) rev = true; if(lv_obj_get_base_dir(ddlist) == LV_BIDI_DIR_RTL) rev = true; txt = rev ? ext->symbol : opt_txt; if(txt) { _lv_txt_get_size(&txt_size, txt, label_dsc.font, label_dsc.letter_space, label_dsc.line_space, LV_COORD_MAX, label_dsc.flag); txt_area.y1 = ddlist->coords.y1 + top; txt_area.y2 = txt_area.y1 + txt_size.y; /*Center align the text if no symbol*/ if(ext->symbol == NULL && txt == opt_txt) { txt_area.x1 = ddlist->coords.x1 + (lv_obj_get_width(ddlist) - txt_size.x) / 2; txt_area.x2 = txt_area.x1 + txt_size.x; } else { txt_area.x1 = ddlist->coords.x1 + left; txt_area.x2 = txt_area.x1 + txt_size.x; } lv_draw_label(&txt_area, clip_area, &label_dsc, txt, NULL); } txt = rev ? opt_txt : ext->symbol; if(txt) { _lv_txt_get_size(&txt_size, txt, label_dsc.font, label_dsc.letter_space, label_dsc.line_space, LV_COORD_MAX, label_dsc.flag); txt_area.y1 = ddlist->coords.y1 + top; txt_area.y2 = txt_area.y1 + txt_size.y; /*Center align the text if no symbol*/ if(ext->symbol == NULL && txt == opt_txt) { txt_area.x1 = ddlist->coords.x1 + (lv_obj_get_width(ddlist) - txt_size.x) / 2; txt_area.x2 = txt_area.x1 + txt_size.x; } else { txt_area.x1 = ddlist->coords.x2 - right - txt_size.x; txt_area.x2 = txt_area.x1 + txt_size.x; } lv_draw_label(&txt_area, clip_area, &label_dsc, txt, NULL); } if(ext->show_selected) { _lv_mem_buf_release((char *)opt_txt); } } else if(mode == LV_DESIGN_DRAW_POST) { ancestor_design(ddlist, clip_area, mode); } return LV_DESIGN_RES_OK; } /** * Handle the drawing related tasks of the drop down list's page * @param page pointer to an object * @param clip_area the object will be drawn only in this area * @param mode LV_DESIGN_COVER_CHK: only check if the object fully covers the 'mask_p' area * (return 'true' if yes) * LV_DESIGN_DRAW: draw the object (always return 'true') * LV_DESIGN_DRAW_POST: drawing after every children are drawn * @param return an element of `lv_design_res_t` */ static lv_design_res_t lv_dropdown_page_design(lv_obj_t * page, const lv_area_t * clip_area, lv_design_mode_t mode) { /*Return false if the object is not covers the mask_p area*/ if(mode == LV_DESIGN_COVER_CHK) { return ancestor_page_design(page, clip_area, mode); } /*Draw the object*/ else if(mode == LV_DESIGN_DRAW_MAIN) { ancestor_page_design(page, clip_area, mode); lv_dropdown_page_ext_t * page_ext = lv_obj_get_ext_attr(page); lv_obj_t * ddlist = page_ext->ddlist; lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); /*Draw the boxes if the page is not being deleted*/ if(ext->page) { /* Clip area might be too large too to shadow but * the selected option can be drawn on only the background*/ lv_area_t clip_area_core; bool has_common; has_common = _lv_area_intersect(&clip_area_core, clip_area, &ext->page->coords); if(has_common) { if(ext->pr_opt_id != LV_DROPDOWN_PR_NONE) { draw_box(ddlist, &clip_area_core, ext->pr_opt_id, LV_STATE_PRESSED); } draw_box(ddlist, &clip_area_core, ext->sel_opt_id, LV_STATE_DEFAULT); } } } /*Post draw when the children are drawn*/ else if(mode == LV_DESIGN_DRAW_POST) { /*Draw the scrollbar in the ancestor page design function*/ ancestor_page_design(page, clip_area, mode); /*Redraw the text on the selected area with a different color*/ lv_dropdown_page_ext_t * page_ext = lv_obj_get_ext_attr(page); lv_obj_t * ddlist = page_ext->ddlist; lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); /*Draw the box labels if the page is not being deleted*/ if(ext->page) { /* Clip area might be too large too to shadow but * the selected option can be drawn on only the background*/ lv_area_t clip_area_core; bool has_common; has_common = _lv_area_intersect(&clip_area_core, clip_area, &ext->page->coords); if(has_common) { if(ext->pr_opt_id != LV_DROPDOWN_PR_NONE) { draw_box_label(ddlist, &clip_area_core, ext->pr_opt_id, LV_STATE_PRESSED); } draw_box_label(ddlist, &clip_area_core, ext->sel_opt_id, LV_STATE_DEFAULT); } } } return LV_DESIGN_RES_OK; } /** * Signal function of the drop down list * @param ddlist pointer to a drop down list object * @param sign a signal type from lv_signal_t enum * @param param pointer to a signal specific variable * @return LV_RES_OK: the object is not deleted in the function; LV_RES_INV: the object is deleted */ static lv_res_t lv_dropdown_signal(lv_obj_t * ddlist, lv_signal_t sign, void * param) { lv_res_t res; /* Include the ancient signal function */ res = ancestor_signal(ddlist, sign, param); if(res != LV_RES_OK) return res; if(sign == LV_SIGNAL_GET_TYPE) return lv_obj_handle_get_type_signal(param, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(sign == LV_SIGNAL_GET_STYLE) { lv_get_style_info_t * info = param; info->result = lv_dropdown_get_style(ddlist, info->part); if(info->result != NULL) return LV_RES_OK; return LV_RES_OK; } else if(sign == LV_SIGNAL_GET_STATE_DSC) { lv_get_state_info_t * info = param; if(info->part == LV_DROPDOWN_PART_LIST || info->part == LV_DROPDOWN_PART_SCROLLBAR || info->part == LV_DROPDOWN_PART_SELECTED) { info->result = lv_obj_get_state(ext->page, LV_PAGE_PART_BG); } } else if(sign == LV_SIGNAL_CLEANUP) { lv_dropdown_close(ddlist); if(ext->static_txt == 0) { lv_mem_free(ext->options); ext->options = NULL; } /*`lv_obj_clean_style_list` is not required because these styles are only copied to the page * so they can have transitions or other object related things. */ _lv_style_list_reset(&ext->style_page); _lv_style_list_reset(&ext->style_scrlbar); _lv_style_list_reset(&ext->style_selected); } else if(sign == LV_SIGNAL_FOCUS) { #if LV_USE_GROUP lv_group_t * g = lv_obj_get_group(ddlist); bool editing = lv_group_get_editing(g); lv_indev_type_t indev_type = lv_indev_get_type(lv_indev_get_act()); /*Encoders need special handling*/ if(indev_type == LV_INDEV_TYPE_ENCODER) { /*Open the list if editing*/ if(editing) lv_dropdown_open(ddlist); /*Close the list if navigating*/ else lv_dropdown_close(ddlist); } #endif } else if(sign == LV_SIGNAL_DEFOCUS || sign == LV_SIGNAL_LEAVE) { lv_dropdown_close(ddlist); } else if(sign == LV_SIGNAL_RELEASED) { lv_indev_t * indev = lv_indev_get_act(); if(lv_indev_is_dragging(indev) == false) { if(ext->page) { lv_dropdown_close(ddlist); if(ext->sel_opt_id_orig != ext->sel_opt_id) { ext->sel_opt_id_orig = ext->sel_opt_id; uint32_t id = ext->sel_opt_id; /*Just to use uint32_t in event data*/ res = lv_event_send(ddlist, LV_EVENT_VALUE_CHANGED, &id); if(res != LV_RES_OK) return res; lv_obj_invalidate(ddlist); } #if LV_USE_GROUP lv_indev_type_t indev_type = lv_indev_get_type(indev); if(indev_type == LV_INDEV_TYPE_ENCODER) { lv_group_set_editing(lv_obj_get_group(ddlist), false); } #endif } else { lv_dropdown_open(ddlist); } } else { ext->sel_opt_id = ext->sel_opt_id_orig; lv_obj_invalidate(ddlist); } } else if(sign == LV_SIGNAL_COORD_CHG) { if(ext->page) lv_dropdown_close(ddlist); } else if(sign == LV_SIGNAL_STYLE_CHG) { lv_style_int_t top = lv_obj_get_style_pad_top(ddlist, LV_DROPDOWN_PART_MAIN); lv_style_int_t bottom = lv_obj_get_style_pad_bottom(ddlist, LV_DROPDOWN_PART_MAIN); const lv_font_t * font = lv_obj_get_style_text_font(ddlist, LV_DROPDOWN_PART_MAIN); lv_obj_set_height(ddlist, top + bottom + lv_font_get_line_height(font)); if(ext->page) lv_obj_refresh_style(ext->page, LV_OBJ_PART_ALL, LV_STYLE_PROP_ALL); } else if(sign == LV_SIGNAL_CONTROL) { #if LV_USE_GROUP char c = *((char *)param); if(c == LV_KEY_RIGHT || c == LV_KEY_DOWN) { if(ext->page == NULL) { lv_dropdown_open(ddlist); } else if(ext->sel_opt_id + 1 < ext->option_cnt) { ext->sel_opt_id++; position_to_selected(ddlist); } } else if(c == LV_KEY_LEFT || c == LV_KEY_UP) { if(ext->page == NULL) { lv_dropdown_open(ddlist); } else if(ext->sel_opt_id > 0) { ext->sel_opt_id--; position_to_selected(ddlist); } } else if(c == LV_KEY_ESC) { ext->sel_opt_id = ext->sel_opt_id_orig; lv_dropdown_close(ddlist); } #endif } else if(sign == LV_SIGNAL_GET_EDITABLE) { #if LV_USE_GROUP bool * editable = (bool *)param; *editable = true; #endif } return res; } /** * Signal function of the drop down list's scrollable part * @param scrl pointer to a drop down list's scrollable part * @param sign a signal type from lv_signal_t enum * @param param pointer to a signal specific variable * @return LV_RES_OK: the object is not deleted in the function; LV_RES_INV: the object is deleted */ static lv_res_t lv_dropdown_page_signal(lv_obj_t * page, lv_signal_t sign, void * param) { lv_res_t res; /* Include the ancient signal function */ res = ancestor_page_signal(page, sign, param); if(res != LV_RES_OK) return res; if(sign == LV_SIGNAL_GET_TYPE) return lv_obj_handle_get_type_signal(param, ""); lv_dropdown_page_ext_t * page_ext = lv_obj_get_ext_attr(page); lv_obj_t * ddlist = page_ext->ddlist; if(sign == LV_SIGNAL_REFR_EXT_DRAW_PAD) { /* Make possible to draw on the full width of the background to redraw the selected rectangle * when the ddlist is scrolled in fix height mode. * (The scrollable is scrolled then "select rectangle" is drawn on the bg too)*/ lv_style_int_t left = lv_obj_get_style_pad_left(ddlist, LV_DROPDOWN_PART_LIST); lv_style_int_t right = lv_obj_get_style_pad_right(ddlist, LV_DROPDOWN_PART_LIST); lv_obj_t * scrl = lv_page_get_scrollable(page); scrl->ext_draw_pad = LV_MATH_MAX3(scrl->ext_draw_pad, left, right); } else if(sign == LV_SIGNAL_RELEASED) { if(lv_indev_is_dragging(lv_indev_get_act()) == false) { page_release_handler(page); } } else if(sign == LV_SIGNAL_PRESSED) { page_press_handler(page); } else if(sign == LV_SIGNAL_CLEANUP) { lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); ext->page = NULL; /*The page is just being deleted*/ } return res; } /** * Signal function of the drop down list's scrollable part * @param scrl pointer to a drop down list's scrollable part * @param sign a signal type from lv_signal_t enum * @param param pointer to a signal specific variable * @return LV_RES_OK: the object is not deleted in the function; LV_RES_INV: the object is deleted */ static lv_res_t lv_dropdown_page_scrl_signal(lv_obj_t * scrl, lv_signal_t sign, void * param) { lv_res_t res; /* Include the ancient signal function */ res = ancestor_page_scrl_signal(scrl, sign, param); if(res != LV_RES_OK) return res; if(sign == LV_SIGNAL_GET_TYPE) return lv_obj_handle_get_type_signal(param, ""); lv_obj_t * page = lv_obj_get_parent(scrl); lv_dropdown_page_ext_t * page_ext = lv_obj_get_ext_attr(page); lv_obj_t * ddlist = page_ext->ddlist; lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(sign == LV_SIGNAL_RELEASED) { if(lv_indev_is_dragging(lv_indev_get_act()) == false) { page_release_handler(page); } } else if(sign == LV_SIGNAL_PRESSED) { page_press_handler(page); } else if(sign == LV_SIGNAL_DRAG_BEGIN) { ext->pr_opt_id = LV_DROPDOWN_PR_NONE; lv_obj_invalidate(page); } else if(sign == LV_SIGNAL_REFR_EXT_DRAW_PAD) { /* Make possible to draw on the full width of the background to redraw the selected rectangle * when the ddlist is scrolled in fix height mode. * (The scrollable is scrolled then "select rectangle" is drawn on the bg too)*/ lv_style_int_t left = lv_obj_get_style_pad_left(ddlist, LV_DROPDOWN_PART_LIST); lv_style_int_t right = lv_obj_get_style_pad_right(ddlist, LV_DROPDOWN_PART_LIST); scrl->ext_draw_pad = LV_MATH_MAX3(scrl->ext_draw_pad, left, right); } return res; } /** * Get the style descriptor of a part of the object * @param page pointer the object * @param part the part from `lv_dropdown_part_t`. (LV_DROPDOWN_PART_...) * @return pointer to the style descriptor of the specified part */ static lv_style_list_t * lv_dropdown_get_style(lv_obj_t * ddlist, uint8_t part) { LV_ASSERT_OBJ(ddlist, LV_OBJX_NAME); lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); lv_style_list_t * style_dsc_p; switch(part) { case LV_DROPDOWN_PART_MAIN: style_dsc_p = &ddlist->style_list; break; case LV_DROPDOWN_PART_LIST: style_dsc_p = &ext->style_page; break; case LV_DROPDOWN_PART_SCROLLBAR: style_dsc_p = &ext->style_scrlbar; break; case LV_DROPDOWN_PART_SELECTED: style_dsc_p = &ext->style_selected; break; default: style_dsc_p = NULL; } return style_dsc_p; } static void draw_box(lv_obj_t * ddlist, const lv_area_t * clip_area, uint16_t id, lv_state_t state) { lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); lv_obj_t * page = ext->page; lv_state_t state_orig = page->state; if(state != page->state) { _lv_obj_disable_style_caching(ddlist, true); page->state = state; } /*Draw a rectangle under the selected item*/ const lv_font_t * font = lv_obj_get_style_text_font(ddlist, LV_DROPDOWN_PART_LIST); lv_style_int_t line_space = lv_obj_get_style_text_line_space(ddlist, LV_DROPDOWN_PART_LIST); lv_coord_t font_h = lv_font_get_line_height(font); /*Draw the selected*/ lv_obj_t * label = get_label(ddlist); lv_area_t rect_area; rect_area.y1 = label->coords.y1; rect_area.y1 += id * (font_h + line_space); rect_area.y1 -= line_space / 2; rect_area.y2 = rect_area.y1 + font_h + line_space - 1; rect_area.x1 = ext->page->coords.x1; rect_area.x2 = ext->page->coords.x2; lv_draw_rect_dsc_t sel_rect; lv_draw_rect_dsc_init(&sel_rect); lv_obj_init_draw_rect_dsc(ddlist, LV_DROPDOWN_PART_SELECTED, &sel_rect); lv_draw_rect(&rect_area, clip_area, &sel_rect); page->state = state_orig; _lv_obj_disable_style_caching(ddlist, false); } static void draw_box_label(lv_obj_t * ddlist, const lv_area_t * clip_area, uint16_t id, lv_state_t state) { lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); lv_obj_t * page = ext->page; lv_state_t state_orig = page->state; if(state != page->state) { page->state = state; _lv_obj_disable_style_caching(ddlist, true); } lv_draw_label_dsc_t label_dsc; lv_draw_label_dsc_init(&label_dsc); lv_obj_init_draw_label_dsc(ddlist, LV_DROPDOWN_PART_SELECTED, &label_dsc); label_dsc.line_space = lv_obj_get_style_text_line_space(ddlist, LV_DROPDOWN_PART_LIST); /*Line space should come from the page*/ lv_obj_t * label = get_label(ddlist); if(label == NULL) return; lv_label_align_t align = lv_label_get_align(label); if(align == LV_LABEL_ALIGN_CENTER) label_dsc.flag |= LV_TXT_FLAG_CENTER; else if(align == LV_LABEL_ALIGN_RIGHT) label_dsc.flag |= LV_TXT_FLAG_RIGHT; lv_coord_t font_h = lv_font_get_line_height(label_dsc.font); lv_area_t area_sel; area_sel.y1 = label->coords.y1; area_sel.y1 += id * (font_h + label_dsc.line_space); area_sel.y1 -= label_dsc.line_space / 2; area_sel.y2 = area_sel.y1 + font_h + label_dsc.line_space - 1; area_sel.x1 = page->coords.x1; area_sel.x2 = page->coords.x2; lv_area_t mask_sel; bool area_ok; area_ok = _lv_area_intersect(&mask_sel, clip_area, &area_sel); if(area_ok) { lv_draw_label(&label->coords, &mask_sel, &label_dsc, lv_label_get_text(label), NULL); } page->state = state_orig; _lv_obj_disable_style_caching(ddlist, false); } /** * Called when a drop down list is released to open it or set new option * @param page pointer to the drop down list's page * @return LV_RES_INV if the page is not being deleted in the user callback. Else LV_RES_OK */ static lv_res_t page_release_handler(lv_obj_t * page) { lv_dropdown_page_ext_t * page_ext = lv_obj_get_ext_attr(page); lv_obj_t * ddlist = page_ext->ddlist; lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); lv_indev_t * indev = lv_indev_get_act(); #if LV_USE_GROUP /*Leave edit mode once a new item is selected*/ if(lv_indev_get_type(indev) == LV_INDEV_TYPE_ENCODER) { ext->sel_opt_id_orig = ext->sel_opt_id; lv_group_t * g = lv_obj_get_group(ddlist); if(lv_group_get_editing(g)) { lv_group_set_editing(g, false); } } #endif /*Search the clicked option (For KEYPAD and ENCODER the new value should be already set)*/ if(lv_indev_get_type(indev) == LV_INDEV_TYPE_POINTER || lv_indev_get_type(indev) == LV_INDEV_TYPE_BUTTON) { lv_point_t p; lv_indev_get_point(indev, &p); ext->sel_opt_id = get_id_on_point(ddlist, p.x, p.y); ext->sel_opt_id_orig = ext->sel_opt_id; } lv_dropdown_close(ddlist); /*Invalidate to refresh the text*/ if(ext->show_selected) lv_obj_invalidate(ddlist); uint32_t id = ext->sel_opt_id; /*Just to use uint32_t in event data*/ lv_res_t res = lv_event_send(ddlist, LV_EVENT_VALUE_CHANGED, &id); if(res != LV_RES_OK) return res; if(ext->page == NULL) return LV_RES_INV; return LV_RES_OK; } static void page_press_handler(lv_obj_t * page) { lv_dropdown_page_ext_t * page_ext = lv_obj_get_ext_attr(page); lv_obj_t * ddlist = page_ext->ddlist; lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); lv_indev_t * indev = lv_indev_get_act(); if(indev && (lv_indev_get_type(indev) == LV_INDEV_TYPE_POINTER || lv_indev_get_type(indev) == LV_INDEV_TYPE_BUTTON)) { lv_point_t p; lv_indev_get_point(indev, &p); ext->pr_opt_id = get_id_on_point(ddlist, p.x, p.y); lv_obj_invalidate(page); } } static uint16_t get_id_on_point(lv_obj_t * ddlist, lv_coord_t x, lv_coord_t y) { lv_obj_t * label = get_label(ddlist); if(label == NULL) return 0; x -= label->coords.x1; y -= label->coords.y1; uint32_t letter_i; const char * txt = lv_label_get_text(label); lv_point_t p = {x, y}; letter_i = lv_label_get_letter_on(label, &p); uint32_t letter_i_byte_pos = _lv_txt_encoded_get_byte_id(txt, letter_i); uint16_t opt = 0; uint32_t i = 0; uint32_t i_prev = 0; uint32_t letter_cnt = 0; for(letter_cnt = 0; letter_cnt < letter_i; letter_cnt++) { uint32_t letter = _lv_txt_encoded_next(txt, &i); /*Count the lines to reach the clicked letter. But ignore the last '\n' because it * still belongs to the clicked line*/ if(letter == '\n' && i_prev != letter_i_byte_pos) opt++; i_prev = i; } return opt; } /** * Set the position of list when it is closed to show the selected item * @param ddlist pointer to a drop down list */ static void position_to_selected(lv_obj_t * ddlist) { lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); const lv_font_t * font = lv_obj_get_style_text_font(ddlist, LV_DROPDOWN_PART_LIST); lv_coord_t font_h = lv_font_get_line_height(font); lv_obj_t * scrl = lv_page_get_scrollable(ext->page); lv_obj_t * label = get_label(ddlist); if(label == NULL) return; lv_coord_t h = lv_obj_get_height(ext->page); lv_style_int_t line_space = lv_obj_get_style_text_line_space(ddlist, LV_DROPDOWN_PART_LIST); lv_coord_t line_y1 = ext->sel_opt_id * (font_h + line_space) + label->coords.y1 - scrl->coords.y1; lv_obj_set_y(scrl, -line_y1 + (h - font_h) / 2); lv_obj_invalidate(ext->page); } static lv_obj_t * get_label(const lv_obj_t * ddlist) { lv_dropdown_ext_t * ext = lv_obj_get_ext_attr(ddlist); if(ext->page == NULL) return NULL; return lv_obj_get_child(lv_page_get_scrollable(ext->page), NULL); } #endif