test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-12-03 20:48:02 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
472f0d0a4e
awtk/docs/manual/button_t.md

302 lines
8.8 KiB
Markdown
Raw Normal View History

update docs
2019-10-17 14:23:01 +08:00
## button\_t
### 概述
![image](images/button_t_0.png)
update docs
2019-12-14 13:25:56 +08:00
按钮控件。
点击按钮之后会触发EVT\_CLICK事件，注册EVT\_CLICK事件以执行特定操作。
按钮控件也可以作为容器使用，使用图片和文本作为其子控件，可以实现很多有趣的效果。
button\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于button\_t控件。
在xml中使用"button"标签创建按钮控件。如：
```xml
<button x="c" y="m" w="80" h="30" text="OK"/>
```
> 更多用法请参考：
update docs
2020-08-16 09:10:01 +08:00
[button.xml](https://github.com/zlgopen/awtk/blob/master/design/default/ui/button.xml)
update docs
2019-12-14 13:25:56 +08:00
在c代码中使用函数button\_create创建按钮控件。如：
```c
widget_t* button = button_create(win, 10, 10, 128, 30);
widget_set_text(button, L"OK");
widget_on(button, EVT_CLICK, on_click, NULL);
```
> 创建之后，需要用widget\_set\_text或widget\_set\_text\_utf8设置文本内容。
> 完整示例请参考：
[button demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/button.c)
可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：
```xml
<style name="default" border_color="#a0a0a0" text_color="black">
<normal bg_color="#f0f0f0" />
<pressed bg_color="#c0c0c0" x_offset="1" y_offset="1"/>
<over bg_color="#e0e0e0" />
<disable bg_color="gray" text_color="#d0d0d0" />
</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#L31)
update docs
2019-10-17 14:23:01 +08:00
----------------------------------
### 函数
<p id="button_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#button_t_button_cast">button\_cast</a> | 转换为button对象(供脚本语言使用)。 |
| <a href="#button_t_button_create">button\_create</a> | 创建button对象 |
regen docs
2022-12-05 12:10:53 +08:00
| <a href="#button_t_button_get_widget_vtable">button\_get\_widget\_vtable</a> | 获取 button 虚表。 |
update docs
2019-10-17 14:23:01 +08:00
| <a href="#button_t_button_set_enable_long_press">button\_set\_enable\_long\_press</a> | 设置是否启用长按事件。 |
regen docs
2022-12-05 12:10:53 +08:00
| <a href="#button_t_button_set_enable_preview">button\_set\_enable\_preview</a> | 设置是否启用预览。 |
update docs
2020-08-20 11:21:16 +08:00
| <a href="#button_t_button_set_long_press_time">button\_set\_long\_press\_time</a> | 设置触发长按事件的时间。 |
update docs
2019-10-17 14:23:01 +08:00
| <a href="#button_t_button_set_repeat">button\_set\_repeat</a> | 设置触发EVT\_CLICK事件的时间间隔。为0则不重复触发EVT\_CLICK事件。 |
### 属性
<p id="button_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
update docs
2019-12-14 13:25:56 +08:00
| <a href="#button_t_enable_long_press">enable\_long\_press</a> | bool\_t | 是否启用长按事件，为true时才触发长按事件。 |
regen docs
2022-12-05 12:10:53 +08:00
| <a href="#button_t_enable_preview">enable\_preview</a> | bool\_t | 是否启用预览(主要用于软键盘)。 |
update docs
2020-08-20 11:21:16 +08:00
| <a href="#button_t_long_press_time">long\_press\_time</a> | uint32\_t | 触发长按事件的时间(ms) |
regen docs
2022-12-05 12:10:53 +08:00
| <a href="#button_t_pressed">pressed</a> | bool\_t | 当前是否按下。 |
update docs
2019-12-14 13:25:56 +08:00
| <a href="#button_t_repeat">repeat</a> | int32\_t | 重复触发EVT\_CLICK事件的时间间隔。 |
update docs
2019-10-17 14:23:01 +08:00
### 事件
<p id="button_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_CLICK | pointer\_event\_t | 点击事件。 |
| EVT\_LONG\_PRESS | pointer\_event\_t | 长按事件。 |
#### button\_cast 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="button_t_button_cast">转换为button对象(供脚本语言使用)。
update docs
2019-10-17 14:23:01 +08:00
* 函数原型：
```
widget_t* button_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | button对象。 |
| widget | widget\_t* | button对象。 |
#### button\_create 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="button_t_button_create">创建button对象
update docs
2019-10-17 14:23:01 +08:00
* 函数原型：
```
widget_t* button_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 | 高度 |
regen docs
2022-12-05 12:10:53 +08:00
#### button\_get\_widget\_vtable 函数
-----------------------
* 函数功能：
> <p id="button_t_button_get_widget_vtable">获取 button 虚表。
* 函数原型：
```
const widget_vtable_t* button_get_widget_vtable ();
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const widget\_vtable\_t* | 成功返回 button 虚表。 |
update docs
2019-10-17 14:23:01 +08:00
#### button\_set\_enable\_long\_press 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="button_t_button_set_enable_long_press">设置是否启用长按事件。
update docs
2019-10-17 14:23:01 +08:00
* 函数原型：
```
ret_t button_set_enable_long_press (widget_t* widget, bool_t enable_long_press);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| enable\_long\_press | bool\_t | 是否启用长按事件。 |
regen docs
2022-12-05 12:10:53 +08:00
#### button\_set\_enable\_preview 函数
-----------------------
* 函数功能：
> <p id="button_t_button_set_enable_preview">设置是否启用预览。
* 函数原型：
```
ret_t button_set_enable_preview (widget_t* widget, bool_t enable_preview);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| enable\_preview | bool\_t | 是否启用预览。 |
update docs
2020-08-20 11:21:16 +08:00
#### button\_set\_long\_press\_time 函数
-----------------------
* 函数功能：
> <p id="button_t_button_set_long_press_time">设置触发长按事件的时间。
* 函数原型：
```
ret_t button_set_long_press_time (widget_t* widget, uint32_t long_press_time);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| long\_press\_time | uint32\_t | 触发长按事件的时间(毫秒)。 |
update docs
2019-10-17 14:23:01 +08:00
#### button\_set\_repeat 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="button_t_button_set_repeat">设置触发EVT\_CLICK事件的时间间隔。为0则不重复触发EVT\_CLICK事件。
update docs
2019-10-17 14:23:01 +08:00
* 函数原型：
```
ret_t button_set_repeat (widget_t* widget, int32_t repeat);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| repeat | int32\_t | 触发EVT\_CLICK事件的时间间隔(毫秒)。 |
#### enable\_long\_press 属性
-----------------------
update docs
2019-12-14 13:25:56 +08:00
> <p id="button_t_enable_long_press">是否启用长按事件，为true时才触发长按事件。
触发长按事件后不再触发点击事件。
缺省不启用。
update docs
2019-10-17 14:23:01 +08:00
* 类型：bool\_t
regen docs
2022-12-05 12:10:53 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### enable\_preview 属性
-----------------------
> <p id="button_t_enable_preview">是否启用预览(主要用于软键盘)。
* 类型：bool\_t
update docs
2020-08-20 11:21:16 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### long\_press\_time 属性
-----------------------
> <p id="button_t_long_press_time">触发长按事件的时间(ms)
* 类型：uint32\_t
update docs
2019-10-17 14:23:01 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
regen docs
2022-12-05 12:10:53 +08:00
#### pressed 属性
-----------------------
> <p id="button_t_pressed">当前是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
update docs
2019-10-17 14:23:01 +08:00
#### repeat 属性
-----------------------
update docs
2019-12-14 13:25:56 +08:00
> <p id="button_t_repeat">重复触发EVT\_CLICK事件的时间间隔。
为0则不重复触发EVT\_CLICK事件。
update docs
2019-10-17 14:23:01 +08:00
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
Reference in New Issue Copy Permalink