# combo_box_t
# 概述
image
下拉列表控件。
点击右边的按钮，可弹出一个下拉列表，从中选择一项作为当前的值。
combo_box_t是edit_t的子类控件，edit_t的函数均适用于combo_box_t控件。
在xml中使用"combo_box"标签创建下拉列表控件。
列表选项可以直接写在"options"属性中。如：
<combo_box readonly="true" x="10" y="bottom:5" w="200" h="30" tr_text="ok"
options="1:ok;2:cancel;"/>
列表选项也可以放在独立的窗口中，用属性"open_window"指定窗口的名称。如：
<combo_box open_window="language" readonly="true" x="10" y="bottom:50" w="200" h="30"
tr_text="english"/>
language.xml:
<popup close_when_click_outside="true" h="80" >
<list_view x="0" y="0" w="100%" h="100%" item_height="30">
<scroll_view name="view" x="0" y="0" w="-12" h="100%">
<combo_box_item tr_text="english"/>
<combo_box_item tr_text="chinese" />
</scroll_view>
<scroll_bar_d name="bar" x="right" y="0" w="12" h="100%" value="0"/>
</list_view>
</popup>
更多用法请参考：combo_box.xml (opens new window)
如果在文本比较长时，希望在获得焦点时文本自动滚动，可以放入一个hscroll_label为子控件，并命名为"value"。如：
<combo_box left_margin="6" readonly="true" x="10" y="50" w="80" h="30" options="leftttttttttt;centerrrrrrrrrrrrrrrr;rightttttttttt;"
selected_index="1">
<hscroll_label x="0" y="0" w="-30" h="100%"
name="value"
lull="1000"
loop="true"
yoyo="true"
ellipses="true"
only_parent_focus="true"/>
<button style="combobox_down" x="right:5" y="middle" w="20" h="20"/>
</combo_box>
在c代码中使用函数combo_box_create创建下拉列表控件。如：
widget_t* combo_box = combo_box_create(win, 10, 10, 128, 30);
combo_box_set_options(combo_box, "left;center;right;");
combo_box_set_selected_index(combo_box, 1);
创建之后：
- 用combo_box_set_options设置可选项目。
- 用combo_box_set_selected_index设置缺省项。
可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：
<combo_box>
<style name="default" border_color="#a0a0a0" text_color="black" text_align_h="left">
<normal bg_color="#f0f0f0" />
<focused bg_color="#f0f0f0" border_color="black"/>
<empty bg_color="#f0f0f0" text_color="#a0a0a0" />
</style>
</combo_box>
- 1.combobox的下拉按钮的style名称为combobox_down，可以在窗体样式文件中设置。
<button>
<style name="combobox_down" border_color="#a0a0a0">
<normal bg_color="#f0f0f0" icon="arrow_down_n"/>
<pressed bg_color="#c0c0c0" icon="arrow_down_p"/>
<over bg_color="#e0e0e0" icon="arrow_down_o"/>
</style>
</button>
- 2.combobox的弹出popup窗口的style名称为combobox_popup，可以在窗体样式文件中设置。
<popup>
<style name="combobox_popup" border_color="red">
<normal bg_color="#808080"/>
</style>
</popup>
- 3.combobox的下拉框中的列表项的样式，可以设置combo_box_item的style来改变。
<combo_box_item>
<style name="default" icon_at="left" text_color="black" bg_color="#f0f0f0">
<normal icon="empty"/>
<focused icon="empty" bg_color="#1296db" text_color="gold" />
<pressed icon="empty" bg_color="#1296db" text_color="white" />
<over icon="empty" bg_color="#1296db" text_color="white" />
<normal_of_checked icon="check"/>
<focused_of_checked icon="check" bg_color="#1296db" text_color="gold"/>
<pressed_of_checked icon="check" bg_color="#1296db" text_color="white" />
<over_of_checked icon="check" bg_color="#1296db" text_color="white" />
</style>
</combo_box_item>
更多用法请参考：theme default (opens new window)
# 函数
| 函数名称 | 说明 |
|---|---|
| combo_box_append_option | 追加一个选项。 |
| combo_box_cast | 转换combo_box对象(供脚本语言使用)。 |
| combo_box_count_options | 获取选项个数。 |
| combo_box_create | 创建combo_box对象 |
| combo_box_get_option | 获取第index个选项。 |
| combo_box_get_text | 获取combo_box的文本(可能是翻译后的文本)。 |
| combo_box_get_text_of_selected | 获取combo_box当前选中项目的文本(原生非翻译的文本)。 |
| combo_box_get_value | 获取combo_box的值。 |
| combo_box_get_widget_vtable | 获取 combo_box 虚表。 |
| combo_box_has_option_text | 检查选项中是否存在指定的文本。 |
| combo_box_remove_option | 删除第一个值为value的选项。 |
| combo_box_remove_option_by_index | 删除指定序数的选项。 |
| combo_box_reset_options | 重置所有选项。 |
| combo_box_set_custom_open_popup | 设置自定义的打开弹出窗口的函数。 |
| combo_box_set_item_height | 设置item高度。 |
| combo_box_set_localize_options | 设置是否本地化(翻译)选项。 |
| combo_box_set_on_item_click | 设置弹出窗口的item被点击的回调函数，回调函数返回非RET_OK，继续默认处理。 |
| combo_box_set_open_window | 点击按钮时可以打开popup窗口，本函数可设置窗口的名称。 |
| combo_box_set_options | 设置选项。 |
| combo_box_set_selected_index | 设置第index个选项为当前选中的选项。 |
| combo_box_set_selected_index_by_text | 根据文本设置当前选中的选项。 |
| combo_box_set_theme_of_popup | 设置弹出窗口的主题。 |
| combo_box_set_value | 设置值。 |
# 属性
| 属性名称 | 类型 | 说明 |
|---|---|---|
| item_height | int32_t | 下拉选项的高度。如果open_window为空，则使用缺省高度。 |
| localize_options | bool_t | 是否本地化(翻译)选项(缺省为TRUE)。 |
| open_window | char* | 为点击按钮时，要打开窗口的名称。 |
| options | char* | 设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。 |
| selected_index | int32_t | 当前选中的选项。 |
| theme_of_popup | char* | 弹出窗口的主题(对应的style文件必须存在)，方便为不同combo box的弹出窗口指定不同的样式。 |
| value | int32_t | 值。 |
# 事件
| 事件名称 | 类型 | 说明 |
|---|---|---|
| EVT_VALUE_WILL_CHANGE | value_change_event_t | 值即将改变事件。 |
| EVT_VALUE_CHANGED | value_change_event_t | 值改变事件。 |
# combo_box_append_option 函数
- 函数功能：
追加一个选项。
- 函数原型：
ret_t combo_box_append_option (widget_t* widget, int32_t value, const char* text);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| value | int32_t | 值。 |
| text | const char* | 文本。 |
# combo_box_cast 函数
- 函数功能：
转换combo_box对象(供脚本语言使用)。
- 函数原型：
widget_t* combo_box_cast (widget_t* widget);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | widget_t* | combo_box对象。 |
| widget | widget_t* | combo_box对象。 |
# combo_box_count_options 函数
- 函数功能：
获取选项个数。
- 函数原型：
int32_t combo_box_count_options (widget_t* widget);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | int32_t | 返回选项个数。 |
| widget | widget_t* | combo_box对象。 |
# combo_box_create 函数
- 函数功能：
创建combo_box对象
- 函数原型：
widget_t* combo_box_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | widget_t* | 对象。 |
| parent | widget_t* | 父控件 |
| x | xy_t | x坐标 |
| y | xy_t | y坐标 |
| w | wh_t | 宽度 |
| h | wh_t | 高度 |
# combo_box_get_option 函数
- 函数功能：
获取第index个选项。
- 函数原型：
combo_box_option_t* combo_box_get_option (widget_t* widget, uint32_t index);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | combo_box_option_t* | 返回index个选项。 |
| widget | widget_t* | combo_box对象。 |
| index | uint32_t | 选项的索引。 |
# combo_box_get_text 函数
- 函数功能：
获取combo_box的文本(可能是翻译后的文本)。
- 函数原型：
const char* combo_box_get_text (widget_t* widget);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | const char* | 返回文本。 |
| widget | widget_t* | combo_box对象。 |
# combo_box_get_text_of_selected 函数
- 函数功能：
获取combo_box当前选中项目的文本(原生非翻译的文本)。
- 函数原型：
const char* combo_box_get_text_of_selected (widget_t* widget);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | const char* | 返回文本。 |
| widget | widget_t* | combo_box对象。 |
# combo_box_get_value 函数
- 函数功能：
获取combo_box的值。
- 函数原型：
int32_t combo_box_get_value (widget_t* widget);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | int32_t | 返回值。 |
| widget | widget_t* | combo_box对象。 |
# combo_box_get_widget_vtable 函数
- 函数功能：
获取 combo_box 虚表。
- 函数原型：
const widget_vtable_t* combo_box_get_widget_vtable ();
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | const widget_vtable_t* | 成功返回 combo_box 虚表。 |
# combo_box_has_option_text 函数
- 函数功能：
检查选项中是否存在指定的文本。
- 函数原型：
bool_t combo_box_has_option_text (widget_t* widget, const char* text);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | bool_t | 返回TRUE表示存在，否则表示不存在。 |
| widget | widget_t* | combo_box对象。 |
| text | const char* | option text |
# combo_box_remove_option 函数
- 函数功能：
删除第一个值为value的选项。
- 函数原型：
ret_t combo_box_remove_option (widget_t* widget, int32_t value);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| value | int32_t | 选项的值。 |
# combo_box_remove_option_by_index 函数
- 函数功能：
删除指定序数的选项。
- 函数原型：
ret_t combo_box_remove_option_by_index (widget_t* widget, uint32_t index);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| index | uint32_t | 选项的序数(0表示第一个)。 |
# combo_box_reset_options 函数
- 函数功能：
重置所有选项。
- 函数原型：
ret_t combo_box_reset_options (widget_t* widget);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
# combo_box_set_custom_open_popup 函数
- 函数功能：
设置自定义的打开弹出窗口的函数。
- 函数原型：
ret_t combo_box_set_custom_open_popup (widget_t* widget, combo_box_custom_open_popup_t open_popup, combo_box_custom_on_layout_combobox_popup_t on_layout_combobox_popup);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| open_popup | combo_box_custom_open_popup_t | 回调函数。 |
| on_layout_combobox_popup | combo_box_custom_on_layout_combobox_popup_t | layout 的回调函数。 |
# combo_box_set_item_height 函数
- 函数功能：
设置item高度。
- 函数原型：
ret_t combo_box_set_item_height (widget_t* widget, uint32_t item_height);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| item_height | uint32_t | item的高度。 |
# combo_box_set_localize_options 函数
- 函数功能：
设置是否本地化(翻译)选项。
- 函数原型：
ret_t combo_box_set_localize_options (widget_t* widget, bool_t localize_options);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| localize_options | bool_t | 是否本地化(翻译)选项。 |
# combo_box_set_on_item_click 函数
- 函数功能：
设置弹出窗口的item被点击的回调函数，回调函数返回非RET_OK，继续默认处理。
- 函数原型：
ret_t combo_box_set_on_item_click (widget_t* widget, event_func_t on_item_click, void* ctx);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| on_item_click | event_func_t | 回调函数。 |
| ctx | void* | 回调函数上下文。 |
# combo_box_set_open_window 函数
- 函数功能：
点击按钮时可以打开popup窗口，本函数可设置窗口的名称。
- 函数原型：
ret_t combo_box_set_open_window (widget_t* widget, const char* open_window);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| open_window | const char* | 弹出窗口的名称。 |
# combo_box_set_options 函数
- 函数功能：
设置选项。
- 函数原型：
ret_t combo_box_set_options (widget_t* widget, const char* options);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| options | const char* | 选项。 |
# combo_box_set_selected_index 函数
- 函数功能：
设置第index个选项为当前选中的选项。
- 函数原型：
ret_t combo_box_set_selected_index (widget_t* widget, uint32_t index);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| index | uint32_t | 选项的索引。 |
# combo_box_set_selected_index_by_text 函数
- 函数功能：
根据文本设置当前选中的选项。
- 函数原型：
ret_t combo_box_set_selected_index_by_text (widget_t* widget, const char* text);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| text | const char* | 原生(非翻译的文本)。 |
# combo_box_set_theme_of_popup 函数
- 函数功能：
设置弹出窗口的主题。
- 函数原型：
ret_t combo_box_set_theme_of_popup (widget_t* widget, const char* theme_of_popup);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| theme_of_popup | const char* | 弹出的窗口主题。 |
# combo_box_set_value 函数
- 函数功能：
设置值。
- 函数原型：
ret_t combo_box_set_value (widget_t* widget, int32_t value);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| widget | widget_t* | combo_box对象。 |
| value | int32_t | 值。 |
# item_height 属性
下拉选项的高度。如果open_window为空，则使用缺省高度。
- 类型：int32_t
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget_get_prop读取 | 是 |
| 可通过widget_set_prop修改 | 是 |
# localize_options 属性
是否本地化(翻译)选项(缺省为TRUE)。
- 类型：bool_t
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget_get_prop读取 | 是 |
| 可通过widget_set_prop修改 | 是 |
# open_window 属性
为点击按钮时，要打开窗口的名称。
- 类型：char*
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget_get_prop读取 | 是 |
| 可通过widget_set_prop修改 | 是 |
# options 属性
设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。
如果数据本身中有英文冒号(:)和英文分号(😉，请用16进制转义。
- 英文冒号(:)写为\x3a
- 英文冒号(;)写为\x3b
- 类型：char*
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget_get_prop读取 | 是 |
| 可通过widget_set_prop修改 | 是 |
# selected_index 属性
当前选中的选项。
- 类型：int32_t
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget_get_prop读取 | 是 |
| 可通过widget_set_prop修改 | 是 |
# theme_of_popup 属性
弹出窗口的主题(对应的style文件必须存在)，方便为不同combo box的弹出窗口指定不同的样式。
- 类型：char*
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget_get_prop读取 | 是 |
| 可通过widget_set_prop修改 | 是 |
# value 属性
值。
- 类型：int32_t
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget_get_prop读取 | 是 |
| 可通过widget_set_prop修改 | 是 |