test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-12-02 20:18:22 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
9bf3df6472
awtk/docs/manual/combo_box_t.md

418 lines
11 KiB
Markdown
Raw Normal View History

update docs
2018-12-20 17:33:31 +08:00
## combo\_box\_t
### 概述
![image](images/combo_box_t_0.png)
update docs
2018-12-23 18:21:58 +08:00
下拉列表控件。
点击右边的按钮，可弹出一个下拉列表，从中选择一项作为当前的值。
combo\_box\_t是[edit\_t](edit_t.md)的子类控件，edit\_t的函数均适用于combo\_box\_t控件。
在xml中使用"combo_box"标签创建下拉列表控件。
列表选项可以直接写在"options"属性中。如：
```xml
update docs
2018-12-24 12:24:46 +08:00
<combo_box readonly="true" x="10" y="bottom:5" w="200" h="30" tr_text="ok"
options="1:ok;2:cancel;"/>
update docs
2018-12-23 18:21:58 +08:00
```
列表选项也可以放在独立的窗口中，用属性"open_window"指定窗口的名称。如：
```xml
update docs
2018-12-24 12:24:46 +08:00
<combo_box open_window="language" readonly="true" x="10" y="bottom:50" w="200" h="30"
tr_text="english"/>
update docs
2018-12-23 18:21:58 +08:00
```
language.xml:
```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](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/combo_box.xml)
在c代码中使用函数combo\_box\_create创建下拉列表控件。如：
```c
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设置缺省项。
update docs
2018-12-24 12:24:46 +08:00
> 完整示例请参考：[combo_box
demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/combo_box.c)
update docs
2018-12-23 18:21:58 +08:00
可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：
```xml
<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>
```
update docs
2018-12-24 12:24:46 +08:00
> 更多用法请参考：[theme
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L422)
update docs
2018-12-23 18:21:58 +08:00
update docs
2018-12-20 17:33:31 +08:00
### 函数
<p id="combo_box_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
update docs
2018-12-21 12:11:40 +08:00
| <a href="#combo_box_t_combo_box_append_option">combo\_box\_append\_option</a> | 追加一个选项。 |
| <a href="#combo_box_t_combo_box_cast">combo\_box\_cast</a> | 转换combo_box对象(供脚本语言使用)。 |
| <a href="#combo_box_t_combo_box_count_options">combo\_box\_count\_options</a> | 获取选项个数。 |
| <a href="#combo_box_t_combo_box_create">combo\_box\_create</a> | 创建combo_box对象 |
| <a href="#combo_box_t_combo_box_get_option">combo\_box\_get\_option</a> | 获取第index个选项。 |
| <a href="#combo_box_t_combo_box_get_text">combo\_box\_get\_text</a> | 获取combo_box的文本。 |
| <a href="#combo_box_t_combo_box_get_value">combo\_box\_get\_value</a> | 获取combo_box的值。 |
| <a href="#combo_box_t_combo_box_reset_options">combo\_box\_reset\_options</a> | 重置所有选项。 |
| <a href="#combo_box_t_combo_box_set_open_window">combo\_box\_set\_open\_window</a> | 点击按钮时可以打开popup窗口，本函数可设置窗口的名称。 |
| <a href="#combo_box_t_combo_box_set_options">combo\_box\_set\_options</a> | 设置选项。 |
| <a href="#combo_box_t_combo_box_set_selected_index">combo\_box\_set\_selected\_index</a> | 设置第index个选项为当前选中的选项。 |
update docs
2018-12-20 17:33:31 +08:00
### 属性
<p id="combo_box_t_properties">
| 名属性称 | 类型 | 说明 |
| -------- | ----- | ------------ |
update docs
2018-12-21 12:11:40 +08:00
| <a href="#combo_box_t_open_window">open\_window</a> | char* | 为点击按钮时，要打开窗口的名称。 |
| <a href="#combo_box_t_options">options</a> | char* | 设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。 |
update docs
2018-12-21 18:29:29 +08:00
| <a href="#combo_box_t_selected_index">selected\_index</a> | int32\_t | 当前选中的选项。 |
| <a href="#combo_box_t_value">value</a> | int32\_t | 值。 |
update docs
2018-12-20 17:33:31 +08:00
### 事件
<p id="combo_box_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值改变事件。 |
#### combo\_box\_append\_option 函数
update docs
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能：
> <p id="combo_box_t_combo_box_append_option"> 追加一个选项。
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
update docs
2018-12-24 12:24:46 +08:00
ret_t combo_box_append_option (widget_t* widget, int32_t value, const char* text);
update docs
2018-12-21 11:39:05 +08:00
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box对象。 |
| value | int32\_t | 值。 |
update docs
2018-12-24 12:24:46 +08:00
| text | const char* | 文本。 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_cast 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_cast"> 转换combo_box对象(供脚本语言使用)。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
widget_t* combo_box_cast (widget_t* widget);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | combo\_box对象。 |
| widget | widget\_t* | combo\_box对象。 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_count\_options 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_count_options"> 获取选项个数。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
int32_t combo_box_count_options (widget_t* widget);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回选项个数。 |
| widget | widget\_t* | combo\_box对象。 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_create 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_create"> 创建combo_box对象
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
widget_t* combo_box_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | 对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_get\_option 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_get_option"> 获取第index个选项。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
combo_box_option_t* combo_box_get_option (widget_t* widget, uint32_t index);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | combo\_box\_option\_t* | 返回index个选项。 |
| widget | widget\_t* | combo\_box对象。 |
| index | uint32\_t | 选项的索引。 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_get\_text 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_get_text"> 获取combo_box的文本。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
update docs
2018-12-24 12:24:46 +08:00
const char* combo_box_get_text (widget_t* widget);
update docs
2018-12-21 11:39:05 +08:00
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
update docs
2018-12-24 12:24:46 +08:00
| 返回值 | const char* | 返回文本。 |
update docs
2018-12-20 17:33:31 +08:00
| widget | widget\_t* | combo\_box对象。 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_get\_value 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_get_value"> 获取combo_box的值。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
int32_t combo_box_get_value (widget_t* widget);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回值。 |
| widget | widget\_t* | combo\_box对象。 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_reset\_options 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_reset_options"> 重置所有选项。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t combo_box_reset_options (widget_t* widget);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box对象。 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_set\_open\_window 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_set_open_window"> 点击按钮时可以打开popup窗口，本函数可设置窗口的名称。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
update docs
2018-12-24 12:24:46 +08:00
ret_t combo_box_set_open_window (widget_t* widget, const char* open_window);
update docs
2018-12-21 11:39:05 +08:00
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box对象。 |
update docs
2018-12-24 12:24:46 +08:00
| open\_window | const char* | 弹出窗口的名称。 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_set\_options 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_set_options"> 设置选项。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
update docs
2018-12-24 12:24:46 +08:00
ret_t combo_box_set_options (widget_t* widget, const char* options);
update docs
2018-12-21 11:39:05 +08:00
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box对象。 |
update docs
2018-12-24 12:24:46 +08:00
| options | const char* | 选项。 |
update docs
2018-12-21 18:29:29 +08:00
#### combo\_box\_set\_selected\_index 函数
-----------------------
update docs
2018-12-21 11:39:05 +08:00
* 函数功能：
update docs
2018-12-21 18:29:29 +08:00
> <p id="combo_box_t_combo_box_set_selected_index"> 设置第index个选项为当前选中的选项。
update docs
2018-12-20 17:33:31 +08:00
update docs
2018-12-21 11:39:05 +08:00
* 函数原型：
```
ret_t combo_box_set_selected_index (widget_t* widget, uint32_t index);
```
* 参数说明：
update docs
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box对象。 |
| index | uint32\_t | 选项的索引。 |
#### open\_window 属性
-----------------------
update docs
2018-12-21 11:39:05 +08:00
> <p id="combo_box_t_open_window"> 为点击按钮时，要打开窗口的名称。
update docs
2018-12-20 17:33:31 +08:00
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
update docs
2018-12-26 15:51:37 +08:00
| 支通过widget\_get\_prop读取 | 是 |
| 支通过widget\_set\_prop修改 | 是 |
update docs
2018-12-20 17:33:31 +08:00
#### options 属性
-----------------------
update docs
2018-12-21 11:39:05 +08:00
> <p id="combo_box_t_options"> 设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。
update docs
2018-12-20 17:33:31 +08:00
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
update docs
2018-12-26 15:51:37 +08:00
| 支通过widget\_get\_prop读取 | 是 |
| 支通过widget\_set\_prop修改 | 是 |
update docs
2018-12-20 17:33:31 +08:00
#### selected\_index 属性
-----------------------
update docs
2018-12-21 11:39:05 +08:00
> <p id="combo_box_t_selected_index"> 当前选中的选项。
update docs
2018-12-20 17:33:31 +08:00
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
update docs
2018-12-26 15:51:37 +08:00
| 支通过widget\_get\_prop读取 | 是 |
| 支通过widget\_set\_prop修改 | 是 |
update docs
2018-12-20 17:33:31 +08:00
#### value 属性
-----------------------
update docs
2018-12-21 11:39:05 +08:00
> <p id="combo_box_t_value"> 值。
update docs
2018-12-20 17:33:31 +08:00
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
update docs
2018-12-26 15:51:37 +08:00
| 支通过widget\_get\_prop读取 | 是 |
| 支通过widget\_set\_prop修改 | 是 |
Reference in New Issue Copy Permalink