test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-12-02 03:58:33 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
42ed765c58
awtk/docs/manual/check_button_t.md

318 lines
9.6 KiB
Markdown
Raw Normal View History

update docs
2019-10-17 14:23:01 +08:00
## check\_button\_t
### 概述
![image](images/check_button_t_0.png)
update docs
2019-12-14 13:25:56 +08:00
勾选按钮控件(单选/多选)。
check\_button\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于check\_button\_t控件。
在xml中使用"check_button"标签创建多选按钮控件。如：
```xml
<check_button name="c1" text="Book"/>
```
在xml中使用"radio_button"标签创建单选按钮控件。如：
```xml
<radio_button name="r1" text="Book"/>
```
> 更多用法请参考：
update docs
2020-08-16 09:10:01 +08:00
[button.xml](https://github.com/zlgopen/awtk/blob/master/design/default/ui/basic.xml)
update docs
2019-12-14 13:25:56 +08:00
在c代码中使用函数check\_button\_create创建多选按钮控件。如：
```c
widget_t* button = check_button_create(win, x, y, w, h);
widget_set_text(button, L"OK");
widget_on(button, EVT_VALUE_CHANGED, on_changed, NULL);
```
在c代码中使用函数check\_button\_create\_radio创建单选按钮控件。如：
```c
widget_t* button = check_button_create_radio(win, x, y, w, h);
widget_set_text(button, L"OK");
widget_on(button, EVT_VALUE_CHANGED, on_changed, NULL);
```
> 完整示例请参考：
[button demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/check_button.c)
可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：
```xml
<style name="default" icon_at="left">
<normal icon="unchecked" />
<pressed icon="unchecked" />
<over icon="unchecked" text_color="green"/>
<normal_of_checked icon="checked" text_color="blue"/>
<pressed_of_checked icon="checked" text_color="blue"/>
<over_of_checked icon="checked" text_color="green"/>
</style>
```
> 更多用法请参考：
[theme
update docs
2020-08-16 09:10:01 +08:00
default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L227)
update docs
2019-10-17 14:23:01 +08:00
----------------------------------
### 函数
<p id="check_button_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#check_button_t_check_button_cast">check\_button\_cast</a> | 转换check_button对象(供脚本语言使用)。 |
| <a href="#check_button_t_check_button_create">check\_button\_create</a> | 创建多选按钮对象 |
regen docs
2022-12-05 12:10:53 +08:00
| <a href="#check_button_t_check_button_create_ex">check\_button\_create\_ex</a> | 创建check button对象 |
update docs
2019-10-17 14:23:01 +08:00
| <a href="#check_button_t_check_button_create_radio">check\_button\_create\_radio</a> | 创建单选按钮对象 |
update idl and docs
2020-06-18 21:54:25 +08:00
| <a href="#check_button_t_check_button_get_checked_button">check\_button\_get\_checked\_button</a> | 用于radio button获取同组中勾选的radio button。 |
update docs
2024-08-08 11:38:38 +08:00
| <a href="#check_button_t_check_button_get_indeterminate">check\_button\_get\_indeterminate</a> | 获取控件的是否存于不确定状态。 |
regen docs
2022-12-05 12:10:53 +08:00
| <a href="#check_button_t_check_button_get_widget_vtable">check\_button\_get\_widget\_vtable</a> | 获取 check_button 虚表。 |
update docs
2024-08-08 11:38:38 +08:00
| <a href="#check_button_t_check_button_set_indeterminate">check\_button\_set\_indeterminate</a> | 设置控件的不确定状态。 |
update docs
2019-10-17 14:23:01 +08:00
| <a href="#check_button_t_check_button_set_value">check\_button\_set\_value</a> | 设置控件的值。 |
### 属性
<p id="check_button_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
update docs
2024-08-08 11:38:38 +08:00
| <a href="#check_button_t_indeterminate">indeterminate</a> | bool\_t | 复选框是否是为不确定状态。（该值为TRUE的话，value 值存于不确定状态，该值为FALSE的话，value 值存于确定状态） |
update docs
2021-10-13 09:51:38 +08:00
| <a href="#check_button_t_radio">radio</a> | bool\_t | 是否是单选按钮。 |
update docs
2020-06-01 17:42:24 +08:00
| <a href="#check_button_t_value">value</a> | bool\_t | 值(勾选为TRUE，非勾选为FALSE)。 |
update docs
2019-10-17 14:23:01 +08:00
### 事件
<p id="check_button_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
update docs
2021-08-03 07:53:37 +08:00
| EVT\_VALUE\_WILL\_CHANGE | value\_change\_event\_t | 值(勾选状态)即将改变事件。 |
| EVT\_VALUE\_CHANGED | value\_change\_event\_t | 值(勾选状态)改变事件。 |
update docs
2021-05-11 15:53:22 +08:00
| EVT\_CLICK | pointer\_event\_t | 点击事件。 |
update docs
2019-10-17 14:23:01 +08:00
#### check\_button\_cast 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="check_button_t_check_button_cast">转换check_button对象(供脚本语言使用)。
update docs
2019-10-17 14:23:01 +08:00
* 函数原型：
```
widget_t* check_button_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | check\_button对象。 |
| widget | widget\_t* | check\_button对象。 |
#### check\_button\_create 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="check_button_t_check_button_create">创建多选按钮对象
update docs
2019-10-17 14:23:01 +08:00
* 函数原型：
```
widget_t* check_button_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
update idl and docs
2020-06-18 21:54:25 +08:00
| 返回值 | widget\_t* | widget对象。 |
update docs
2019-10-17 14:23:01 +08:00
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
regen docs
2022-12-05 12:10:53 +08:00
#### check\_button\_create\_ex 函数
-----------------------
* 函数功能：
> <p id="check_button_t_check_button_create_ex">创建check button对象
* 函数原型：
```
widget_t* check_button_create_ex (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h, const char* type, bool_t radio);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | widget对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
| type | const char* | 类型。 |
| radio | bool\_t | 是否单选。 |
update docs
2019-10-17 14:23:01 +08:00
#### check\_button\_create\_radio 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="check_button_t_check_button_create_radio">创建单选按钮对象
update docs
2019-10-17 14:23:01 +08:00
* 函数原型：
```
widget_t* check_button_create_radio (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
update idl and docs
2020-06-18 21:54:25 +08:00
| 返回值 | widget\_t* | widget对象。 |
update docs
2019-10-17 14:23:01 +08:00
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
update idl and docs
2020-06-18 21:54:25 +08:00
#### check\_button\_get\_checked\_button 函数
-----------------------
* 函数功能：
> <p id="check_button_t_check_button_get_checked_button">用于radio button获取同组中勾选的radio button。
* 函数原型：
```
widget_t* check_button_get_checked_button (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | 同组中勾选的radio button对象。 |
| widget | widget\_t* | radio\_button对象。 |
update docs
2024-08-08 11:38:38 +08:00
#### check\_button\_get\_indeterminate 函数
-----------------------
* 函数功能：
> <p id="check_button_t_check_button_get_indeterminate">获取控件的是否存于不确定状态。
* 函数原型：
```
bool_t check_button_get_indeterminate (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | bool\_t | 返回控件的是否存于不确定状态。 |
| widget | widget\_t* | check\_button对象。 |
regen docs
2022-12-05 12:10:53 +08:00
#### check\_button\_get\_widget\_vtable 函数
-----------------------
* 函数功能：
> <p id="check_button_t_check_button_get_widget_vtable">获取 check_button 虚表。
* 函数原型：
```
const widget_vtable_t* check_button_get_widget_vtable ();
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const widget\_vtable\_t* | 成功返回 check\_button 虚表。 |
update docs
2024-08-08 11:38:38 +08:00
#### check\_button\_set\_indeterminate 函数
-----------------------
* 函数功能：
> <p id="check_button_t_check_button_set_indeterminate">设置控件的不确定状态。
* 函数原型：
```
ret_t check_button_set_indeterminate (widget_t* widget, bool_t indeterminate);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | check\_button对象。 |
| indeterminate | bool\_t | 不确定状态。（该值为TRUE的话，value 值存于不确定状态，该值为FALSE的话，value 值存于确定状态） |
update docs
2019-10-17 14:23:01 +08:00
#### check\_button\_set\_value 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="check_button_t_check_button_set_value">设置控件的值。
update docs
2019-10-17 14:23:01 +08:00
* 函数原型：
```
ret_t check_button_set_value (widget_t* widget, bool_t value);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | check\_button对象。 |
update docs
2020-06-01 17:42:24 +08:00
| value | bool\_t | 值(勾选为TRUE，非勾选为FALSE)。 |
update docs
2024-08-08 11:38:38 +08:00
#### indeterminate 属性
-----------------------
> <p id="check_button_t_indeterminate">复选框是否是为不确定状态。（该值为TRUE的话，value 值存于不确定状态，该值为FALSE的话，value 值存于确定状态）
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 否 |
| 可直接修改 | 否 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
update docs
2021-10-13 09:51:38 +08:00
#### radio 属性
-----------------------
> <p id="check_button_t_radio">是否是单选按钮。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 否 |
| 可直接修改 | 否 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
update docs
2019-10-17 14:23:01 +08:00
#### value 属性
-----------------------
update docs
2020-06-01 17:42:24 +08:00
> <p id="check_button_t_value">值(勾选为TRUE，非勾选为FALSE)。
update docs
2019-10-17 14:23:01 +08:00
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
Reference in New Issue Copy Permalink