test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-11-29 18:48:09 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
lixianjing 2019-10-16 17:12:55 +08:00
parent 84fe038548
commit f35e688aa9
275 changed files with 13180 additions and 14608 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/changes.md
View File

@ -2,6 +2,7 @@
* 2019/10/16
* 更新文档。
* 修改文档中的错误（感谢俊杰提供补丁）。
* 2019/10/15
* 增加fs\_file\_eof。

22
docs/manual/align_h_t.md
View File

@ -1,12 +1,12 @@
## align\_h\_t
### 概述
## align\_h\_t
### 概述
水平对齐的常量定义。
### 常量
<p id="align_h_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| ALIGN\_H\_NONE | 无效对齐方式。 |
| ALIGN\_H\_CENTER | 居中对齐。 |
| ALIGN\_H\_LEFT | 左边对齐。 |
| ALIGN\_H\_RIGHT | 右边对齐。 |
### 常量
<p id="align_h_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| ALIGN\_H\_NONE | 无效对齐方式。 |
| ALIGN\_H\_CENTER | 居中对齐。 |
| ALIGN\_H\_LEFT | 左边对齐。 |
| ALIGN\_H\_RIGHT | 右边对齐。 |

22
docs/manual/align_v_t.md
View File

@ -1,12 +1,12 @@
## align\_v\_t
### 概述
## align\_v\_t
### 概述
垂直对齐的常量定义。
### 常量
<p id="align_v_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| ALIGN\_V\_NONE | 无效对齐方式。 |
| ALIGN\_V\_MIDDLE | 居中对齐。 |
| ALIGN\_V\_TOP | 顶部对齐。 |
| ALIGN\_V\_BOTTOM | 底部对齐。 |
### 常量
<p id="align_v_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| ALIGN\_V\_NONE | 无效对齐方式。 |
| ALIGN\_V\_MIDDLE | 居中对齐。 |
| ALIGN\_V\_TOP | 顶部对齐。 |
| ALIGN\_V\_BOTTOM | 底部对齐。 |

110
docs/manual/app_bar_t.md
View File

@ -1,7 +1,7 @@
## app\_bar\_t
### 概述
![image](images/app_bar_t_0.png)
## app\_bar\_t
### 概述
![image](images/app_bar_t_0.png)
app_bar控件。
一个简单的容器控件，一般在窗口的顶部，用于显示本窗口的状态和信息。
@ -34,58 +34,58 @@
</style>
```
----------------------------------
### 函数
<p id="app_bar_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#app_bar_t_app_bar_cast">app\_bar\_cast</a> | 转换为app_bar对象(供脚本语言使用)。 |
| <a href="#app_bar_t_app_bar_create">app\_bar\_create</a> | 创建app_bar对象 |
#### app\_bar\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="app_bar_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#app_bar_t_app_bar_cast">app\_bar\_cast</a> | 转换为app_bar对象(供脚本语言使用)。 |
| <a href="#app_bar_t_app_bar_create">app\_bar\_create</a> | 创建app_bar对象 |
#### app\_bar\_cast 函数
-----------------------
* 函数功能：
> <p id="app_bar_t_app_bar_cast"> 转换为app_bar对象(供脚本语言使用)。
* 函数原型：
```
widget_t* app_bar_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | app\_bar对象。 |
| widget | widget\_t* | app\_bar对象。 |
#### app\_bar\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* app_bar_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | app\_bar对象。 |
| widget | widget\_t* | app\_bar对象。 |
#### app\_bar\_create 函数
-----------------------
* 函数功能：
> <p id="app_bar_t_app_bar_create"> 创建app_bar对象
* 函数原型：
```
widget_t* app_bar_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 | 高度 |
* 函数原型：
```
widget_t* app_bar_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 | 高度 |

20
docs/manual/app_type_t.md
View File

@ -1,11 +1,11 @@
## app\_type\_t
### 概述
## app\_type\_t
### 概述
应用程序类型。
### 常量
<p id="app_type_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| APP\_MOBILE | 嵌入式或移动APP |
| APP\_SIMULATOR | 模拟器。 |
| APP\_DESKTOP | 桌面应用程序。 |
### 常量
<p id="app_type_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| APP\_MOBILE | 嵌入式或移动APP |
| APP\_SIMULATOR | 模拟器。 |
| APP\_DESKTOP | 桌面应用程序。 |

1
docs/manual/arg_desc_flags_t.md
View File

@ -1,7 +1,6 @@
## arg\_desc\_flags\_t
### 概述
参数描述范围常量定义。
### 常量
<p id="arg_desc_flags_t_consts">

1
docs/manual/asset_data_type_t.md
View File

@ -1,7 +1,6 @@
## asset\_data\_type\_t
### 概述
数据资源类型定义。
### 常量
<p id="asset_data_type_t_consts">

1
docs/manual/asset_font_type_t.md
View File

@ -1,7 +1,6 @@
## asset\_font\_type\_t
### 概述
字体资源类型定义。
### 常量
<p id="asset_font_type_t_consts">

1
docs/manual/asset_image_type_t.md
View File

@ -1,7 +1,6 @@
## asset\_image\_type\_t
### 概述
图片资源类型定义。
### 常量
<p id="asset_image_type_t_consts">

7
docs/manual/asset_info_t.md
View File

@ -2,7 +2,6 @@
### 概述
单个资源的描述信息。
----------------------------------
### 属性
<p id="asset_info_t_properties">
@ -20,7 +19,6 @@
> <p id="asset_info_t_is_in_rom"> 资源是否在ROM中。
* 类型：uint8\_t
| 特性 | 是否支持 |
@ -33,7 +31,6 @@
> <p id="asset_info_t_name"> 名称。
* 类型：char*
| 特性 | 是否支持 |
@ -47,7 +44,6 @@
is\_in\_rom == FALSE时才有效。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -60,7 +56,6 @@
> <p id="asset_info_t_size"> 大小。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -73,7 +68,6 @@
> <p id="asset_info_t_subtype"> 子类型。
* 类型：uint8\_t
| 特性 | 是否支持 |
@ -86,7 +80,6 @@
> <p id="asset_info_t_type"> 类型。
* 类型：uint16\_t
| 特性 | 是否支持 |

1
docs/manual/asset_script_type_t.md
View File

@ -1,7 +1,6 @@
## asset\_script\_type\_t
### 概述
脚本资源类型定义。
### 常量
<p id="asset_script_type_t_consts">

1
docs/manual/asset_type_t.md
View File

@ -1,7 +1,6 @@
## asset\_type\_t
### 概述
资源类型常量定义。
### 常量
<p id="asset_type_t_consts">

1
docs/manual/asset_ui_type_t.md
View File

@ -1,7 +1,6 @@
## asset\_ui\_type\_t
### 概述
UI资源类型定义。
### 常量
<p id="asset_ui_type_t_consts">

17
docs/manual/assets_manager_t.md
View File

@ -31,7 +31,6 @@
```
----------------------------------
### 函数
<p id="assets_manager_t_methods">
@ -63,7 +62,6 @@
* 函数原型：
```
@ -84,7 +82,6 @@ assets_manager_t* assets_manager ();
* 函数原型：
```
@ -107,7 +104,6 @@ ret_t assets_manager_add (assets_manager_t* am, asset_info_t info);
* 函数原型：
```
@ -130,7 +126,6 @@ ret_t assets_manager_clear_cache (assets_manager_t* am, asset_type_t type);
* 函数原型：
```
@ -152,7 +147,6 @@ assets_manager_t* assets_manager_create (uint32_t init_nr);
* 函数原型：
```
@ -174,7 +168,6 @@ ret_t assets_manager_deinit (assets_manager_t* am);
* 函数原型：
```
@ -196,7 +189,6 @@ ret_t assets_manager_destroy (assets_manager_t* am);
* 函数原型：
```
@ -220,7 +212,6 @@ asset_info_t* assets_manager_find_in_cache (assets_manager_t* am, asset_type_t t
* 函数原型：
```
@ -243,7 +234,6 @@ assets_manager_t* assets_manager_init (assets_manager_t* am, uint32_t init_nr);
* 函数原型：
```
@ -267,7 +257,6 @@ asset_info_t* assets_manager_load (assets_manager_t* am, asset_type_t type, char
* 函数原型：
```
@ -291,7 +280,6 @@ ret_t assets_manager_preload (assets_manager_t* am, asset_type_t type, char* nam
* 函数原型：
```
@ -315,7 +303,6 @@ asset_info_t* assets_manager_ref (assets_manager_t* am, asset_type_t type, char*
* 函数原型：
```
@ -337,7 +324,6 @@ ret_t assets_manager_set (assets_manager_t* am);
* 函数原型：
```
@ -360,7 +346,6 @@ ret_t assets_manager_set_locale_info (assets_manager_t* am, locale_info_t* local
* 函数原型：
```
@ -383,7 +368,6 @@ ret_t assets_manager_set_res_root (assets_manager_t* am, const char* res_root);
* 函数原型：
```
@ -406,7 +390,6 @@ ret_t assets_manager_set_system_info (assets_manager_t* am, system_info_t* syste
* 函数原型：
```

1
docs/manual/bitmap_flag_t.md
View File

@ -1,7 +1,6 @@
## bitmap\_flag\_t
### 概述
位图标志常量定义。
### 常量
<p id="bitmap_flag_t_consts">

1
docs/manual/bitmap_format_t.md
View File

@ -1,7 +1,6 @@
## bitmap\_format\_t
### 概述
位图格式常量定义。
### 常量
<p id="bitmap_format_t_consts">

17
docs/manual/bitmap_t.md
View File

@ -2,7 +2,6 @@
### 概述
位图。
----------------------------------
### 函数
<p id="bitmap_t_methods">
@ -38,7 +37,6 @@
> <p id="bitmap_t_bitmap_create"> 创建图片对象(一般供脚本语言中使用)。
* 函数原型：
```
@ -59,7 +57,6 @@ bitmap_t* bitmap_create ();
* 函数原型：
```
@ -83,7 +80,6 @@ bitmap_t* bitmap_create_ex (uint32_t w, uint32_t h, uint32_t line_length, bitmap
> <p id="bitmap_t_bitmap_destroy"> 销毁图片。
* 函数原型：
```
@ -105,7 +101,6 @@ ret_t bitmap_destroy (bitmap_t* bitmap);
* 函数原型：
```
@ -127,7 +122,6 @@ uint32_t bitmap_get_bpp (bitmap_t* bitmap);
* 函数原型：
```
@ -149,7 +143,6 @@ ret_t bitmap_get_line_length (bitmap_t* bitmap);
* 函数原型：
```
@ -174,7 +167,6 @@ ret_t bitmap_get_pixel (bitmap_t* bitmap, uint32_t x, uint32_t y, rgba_t* rgba);
* 函数原型：
```
@ -201,7 +193,6 @@ ret_t bitmap_init (bitmap_t* bitmap, uint32_t w, uint32_t h, bitmap_format_t for
* 函数原型：
```
@ -228,7 +219,6 @@ ret_t bitmap_init_from_rgba (bitmap_t* bitmap, uint32_t w, uint32_t h, bitmap_fo
* 函数原型：
```
@ -247,7 +237,6 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
> <p id="bitmap_t_data"> 图片数据。
* 类型：uint8\_t*
| 特性 | 是否支持 |
@ -259,7 +248,6 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
> <p id="bitmap_t_flags"> 标志。请参考{bitmap_flag_t}。
* 类型：uint16\_t
| 特性 | 是否支持 |
@ -272,7 +260,6 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
> <p id="bitmap_t_format"> 格式。请参考{bitmap_format_t}。
* 类型：uint16\_t
| 特性 | 是否支持 |
@ -285,7 +272,6 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
> <p id="bitmap_t_h"> 高度。
* 类型：wh\_t
| 特性 | 是否支持 |
@ -298,7 +284,6 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
> <p id="bitmap_t_line_length"> 每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -311,7 +296,6 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
> <p id="bitmap_t_name"> 名称。
* 类型：const char*
| 特性 | 是否支持 |
@ -324,7 +308,6 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
> <p id="bitmap_t_w"> 宽度。
* 类型：wh\_t
| 特性 | 是否支持 |

26
docs/manual/border_type_t.md
View File

@ -1,14 +1,14 @@
## border\_type\_t
### 概述
## border\_type\_t
### 概述
控件边框类型。
### 常量
<p id="border_type_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| BORDER\_NONE | 无边框。 |
| BORDER\_LEFT | 左边框线。 |
| BORDER\_RIGHT | 右边框线。 |
| BORDER\_TOP | 上边框线。 |
| BORDER\_BOTTOM | 下边框线。 |
| BORDER\_ALL | 全边框线。 |
### 常量
<p id="border_type_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| BORDER\_NONE | 无边框。 |
| BORDER\_LEFT | 左边框线。 |
| BORDER\_RIGHT | 右边框线。 |
| BORDER\_TOP | 上边框线。 |
| BORDER\_BOTTOM | 下边框线。 |
| BORDER\_ALL | 全边框线。 |

110
docs/manual/button_group_t.md
View File

@ -1,7 +1,7 @@
## button\_group\_t
### 概述
![image](images/button_group_t_0.png)
## button\_group\_t
### 概述
![image](images/button_group_t_0.png)
Button Group控件。一个简单的容器控件，用于容纳一组按钮控件。
它本身不提供布局功能，仅提供具有语义的标签，让xml更具有可读性。
@ -28,58 +28,58 @@
<normal bg_color="#f0f0f0" />
</style>
```
----------------------------------
### 函数
<p id="button_group_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#button_group_t_button_group_cast">button\_group\_cast</a> | 转换为button_group对象(供脚本语言使用)。 |
| <a href="#button_group_t_button_group_create">button\_group\_create</a> | 创建button_group对象 |
#### button\_group\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="button_group_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#button_group_t_button_group_cast">button\_group\_cast</a> | 转换为button_group对象(供脚本语言使用)。 |
| <a href="#button_group_t_button_group_create">button\_group\_create</a> | 创建button_group对象 |
#### button\_group\_cast 函数
-----------------------
* 函数功能：
> <p id="button_group_t_button_group_cast"> 转换为button_group对象(供脚本语言使用)。
* 函数原型：
```
widget_t* button_group_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | button\_group对象。 |
| widget | widget\_t* | button\_group对象。 |
#### button\_group\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* button_group_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | button\_group对象。 |
| widget | widget\_t* | button\_group对象。 |
#### button\_group\_create 函数
-----------------------
* 函数功能：
> <p id="button_group_t_button_group_create"> 创建button_group对象
* 函数原型：
```
widget_t* button_group_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 | 高度 |
* 函数原型：
```
widget_t* button_group_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 | 高度 |

286
docs/manual/button_t.md
View File

@ -1,7 +1,7 @@
## button\_t
### 概述
![image](images/button_t_0.png)
## button\_t
### 概述
![image](images/button_t_0.png)
按钮控件。
点击按钮之后会触发EVT\_CLICK事件，注册EVT\_CLICK事件以执行特定操作。
@ -47,158 +47,158 @@
[theme
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L31)
----------------------------------
### 函数
<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对象 |
| <a href="#button_t_button_set_enable_long_press">button\_set\_enable\_long\_press</a> | 设置是否启用长按事件。 |
| <a href="#button_t_button_set_repeat">button\_set\_repeat</a> | 设置触发EVT\_CLICK事件的时间间隔。为0则不重复触发EVT\_CLICK事件。 |
### 属性
<p id="button_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#button_t_enable_long_press">enable\_long\_press</a> | bool\_t | 是否启用长按事件，为true时才触发长按事件。 |
| <a href="#button_t_repeat">repeat</a> | int32\_t | 重复触发EVT\_CLICK事件的时间间隔。 |
### 事件
<p id="button_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_CLICK | pointer\_event\_t | 点击事件。 |
| EVT\_LONG\_PRESS | pointer\_event\_t | 长按事件。 |
#### button\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<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对象 |
| <a href="#button_t_button_set_enable_long_press">button\_set\_enable\_long\_press</a> | 设置是否启用长按事件。 |
| <a href="#button_t_button_set_repeat">button\_set\_repeat</a> | 设置触发EVT\_CLICK事件的时间间隔。为0则不重复触发EVT\_CLICK事件。 |
### 属性
<p id="button_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#button_t_enable_long_press">enable\_long\_press</a> | bool\_t | 是否启用长按事件，为true时才触发长按事件。 |
| <a href="#button_t_repeat">repeat</a> | int32\_t | 重复触发EVT\_CLICK事件的时间间隔。 |
### 事件
<p id="button_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_CLICK | pointer\_event\_t | 点击事件。 |
| EVT\_LONG\_PRESS | pointer\_event\_t | 长按事件。 |
#### button\_cast 函数
-----------------------
* 函数功能：
> <p id="button_t_button_cast"> 转换为button对象(供脚本语言使用)。
* 函数原型：
```
widget_t* button_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | button对象。 |
| widget | widget\_t* | button对象。 |
#### button\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* button_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | button对象。 |
| widget | widget\_t* | button对象。 |
#### button\_create 函数
-----------------------
* 函数功能：
> <p id="button_t_button_create"> 创建button对象
* 函数原型：
```
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 | 高度 |
#### button\_set\_enable\_long\_press 函数
-----------------------
* 函数功能：
* 函数原型：
```
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 | 高度 |
#### button\_set\_enable\_long\_press 函数
-----------------------
* 函数功能：
> <p id="button_t_button_set_enable_long_press"> 设置是否启用长按事件。
* 函数原型：
```
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 | 是否启用长按事件。 |
#### button\_set\_repeat 函数
-----------------------
* 函数功能：
* 函数原型：
```
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 | 是否启用长按事件。 |
#### button\_set\_repeat 函数
-----------------------
* 函数功能：
> <p id="button_t_button_set_repeat"> 设置触发EVT\_CLICK事件的时间间隔。为0则不重复触发EVT\_CLICK事件。
* 函数原型：
```
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 属性
-----------------------
* 函数原型：
```
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 属性
-----------------------
> <p id="button_t_enable_long_press"> 是否启用长按事件，为true时才触发长按事件。
触发长按事件后不再触发点击事件。
缺省不启用。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### repeat 属性
-----------------------
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### repeat 属性
-----------------------
> <p id="button_t_repeat"> 重复触发EVT\_CLICK事件的时间间隔。
为0则不重复触发EVT\_CLICK事件。
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

198
docs/manual/calibration_win_t.md
View File

@ -1,7 +1,7 @@
## calibration\_win\_t
### 概述
![image](images/calibration_win_t_0.png)
## calibration\_win\_t
### 概述
![image](images/calibration_win_t_0.png)
电阻屏校准窗口。
calibration\_win\_t是[window\_base\_t](window_base_t.md)的子类控件，
@ -25,106 +25,106 @@
通过calibration\_win\_set\_on\_done注册回调函数，用于保存校准数据。
----------------------------------
### 函数
<p id="calibration_win_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#calibration_win_t_calibration_win_cast">calibration\_win\_cast</a> | 转换为calibration_win对象(供脚本语言使用)。 |
| <a href="#calibration_win_t_calibration_win_create">calibration\_win\_create</a> | 创建calibration_win对象 |
| <a href="#calibration_win_t_calibration_win_set_on_click">calibration\_win\_set\_on\_click</a> | 设置校准点击事件的处理函数。 |
| <a href="#calibration_win_t_calibration_win_set_on_done">calibration\_win\_set\_on\_done</a> | 设置校准完成的处理函数。 |
#### calibration\_win\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="calibration_win_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#calibration_win_t_calibration_win_cast">calibration\_win\_cast</a> | 转换为calibration_win对象(供脚本语言使用)。 |
| <a href="#calibration_win_t_calibration_win_create">calibration\_win\_create</a> | 创建calibration_win对象 |
| <a href="#calibration_win_t_calibration_win_set_on_click">calibration\_win\_set\_on\_click</a> | 设置校准点击事件的处理函数。 |
| <a href="#calibration_win_t_calibration_win_set_on_done">calibration\_win\_set\_on\_done</a> | 设置校准完成的处理函数。 |
#### calibration\_win\_cast 函数
-----------------------
* 函数功能：
> <p id="calibration_win_t_calibration_win_cast"> 转换为calibration_win对象(供脚本语言使用)。
* 函数原型：
```
widget_t* calibration_win_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | calibration\_win对象。 |
| widget | widget\_t* | calibration\_win对象。 |
#### calibration\_win\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* calibration_win_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | calibration\_win对象。 |
| widget | widget\_t* | calibration\_win对象。 |
#### calibration\_win\_create 函数
-----------------------
* 函数功能：
> <p id="calibration_win_t_calibration_win_create"> 创建calibration_win对象
* 函数原型：
```
widget_t* calibration_win_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 | 高度 |
#### calibration\_win\_set\_on\_click 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* calibration_win_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 | 高度 |
#### calibration\_win\_set\_on\_click 函数
-----------------------
* 函数功能：
> <p id="calibration_win_t_calibration_win_set_on_click"> 设置校准点击事件的处理函数。
* 函数原型：
```
ret_t calibration_win_set_on_click (widget_t* widget, calibration_win_on_click_t on_click, void* ctx);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| on\_click | calibration\_win\_on\_click\_t | 回调函数。 |
| ctx | void* | 回调函数的上下文。 |
#### calibration\_win\_set\_on\_done 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t calibration_win_set_on_click (widget_t* widget, calibration_win_on_click_t on_click, void* ctx);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| on\_click | calibration\_win\_on\_click\_t | 回调函数。 |
| ctx | void* | 回调函数的上下文。 |
#### calibration\_win\_set\_on\_done 函数
-----------------------
* 函数功能：
> <p id="calibration_win_t_calibration_win_set_on_done"> 设置校准完成的处理函数。
* 函数原型：
```
ret_t calibration_win_set_on_done (widget_t* widget, calibration_win_on_done_t on_done, void* ctx);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| on\_done | calibration\_win\_on\_done\_t | 回调函数。 |
| ctx | void* | 回调函数的上下文。 |
* 函数原型：
```
ret_t calibration_win_set_on_done (widget_t* widget, calibration_win_on_done_t on_done, void* ctx);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| on\_done | calibration\_win\_on\_done\_t | 回调函数。 |
| ctx | void* | 回调函数的上下文。 |

110
docs/manual/candidates_t.md
View File

@ -1,60 +1,60 @@
## candidates\_t
### 概述
![image](images/candidates_t_0.png)
## candidates\_t
### 概述
![image](images/candidates_t_0.png)
输入法候选字词控件。
----------------------------------
### 函数
<p id="candidates_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#candidates_t_candidates_cast">candidates\_cast</a> | 转换为candidates对象(供脚本语言使用)。 |
| <a href="#candidates_t_candidates_create">candidates\_create</a> | 创建candidates对象 |
#### candidates\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="candidates_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#candidates_t_candidates_cast">candidates\_cast</a> | 转换为candidates对象(供脚本语言使用)。 |
| <a href="#candidates_t_candidates_create">candidates\_create</a> | 创建candidates对象 |
#### candidates\_cast 函数
-----------------------
* 函数功能：
> <p id="candidates_t_candidates_cast"> 转换为candidates对象(供脚本语言使用)。
* 函数原型：
```
widget_t* candidates_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | candidates对象。 |
| widget | widget\_t* | candidates对象。 |
#### candidates\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* candidates_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | candidates对象。 |
| widget | widget\_t* | candidates对象。 |
#### candidates\_create 函数
-----------------------
* 函数功能：
> <p id="candidates_t_candidates_create"> 创建candidates对象
* 函数原型：
```
widget_t* candidates_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 | 高度 |
* 函数原型：
```
widget_t* candidates_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 | 高度 |

1512
docs/manual/canvas_t.md
View File

File diff suppressed because it is too large Load Diff

110
docs/manual/canvas_widget_t.md
View File

@ -1,7 +1,7 @@
## canvas\_widget\_t
### 概述
![image](images/canvas_widget_t_0.png)
## canvas\_widget\_t
### 概述
![image](images/canvas_widget_t_0.png)
画布控件。
画布控件让开发者可以自己在控件上绘制需要的内容。
@ -62,58 +62,58 @@
* [canvas接口描述](canvas_t.md)
* [vgcanvas接口描述](vgcanvas_t.md)
----------------------------------
### 函数
<p id="canvas_widget_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#canvas_widget_t_canvas_widget_cast">canvas\_widget\_cast</a> | 转换为canvas_widget对象(供脚本语言使用)。 |
| <a href="#canvas_widget_t_canvas_widget_create">canvas\_widget\_create</a> | 创建canvas_widget对象 |
#### canvas\_widget\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="canvas_widget_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#canvas_widget_t_canvas_widget_cast">canvas\_widget\_cast</a> | 转换为canvas_widget对象(供脚本语言使用)。 |
| <a href="#canvas_widget_t_canvas_widget_create">canvas\_widget\_create</a> | 创建canvas_widget对象 |
#### canvas\_widget\_cast 函数
-----------------------
* 函数功能：
> <p id="canvas_widget_t_canvas_widget_cast"> 转换为canvas_widget对象(供脚本语言使用)。
* 函数原型：
```
widget_t* canvas_widget_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | canvas\_widget对象。 |
| widget | widget\_t* | canvas\_widget对象。 |
#### canvas\_widget\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* canvas_widget_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | canvas\_widget对象。 |
| widget | widget\_t* | canvas\_widget对象。 |
#### canvas\_widget\_create 函数
-----------------------
* 函数功能：
> <p id="canvas_widget_t_canvas_widget_create"> 创建canvas_widget对象
* 函数原型：
```
widget_t* canvas_widget_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 | 高度 |
* 函数原型：
```
widget_t* canvas_widget_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 | 高度 |

258
docs/manual/check_button_t.md
View File

@ -1,7 +1,7 @@
## check\_button\_t
### 概述
![image](images/check_button_t_0.png)
## check\_button\_t
### 概述
![image](images/check_button_t_0.png)
勾选按钮控件(单选/多选)。
check\_button\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于check\_button\_t控件。
@ -57,137 +57,137 @@
[theme
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L227)
----------------------------------
### 函数
<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> | 创建多选按钮对象 |
| <a href="#check_button_t_check_button_create_radio">check\_button\_create\_radio</a> | 创建单选按钮对象 |
| <a href="#check_button_t_check_button_set_value">check\_button\_set\_value</a> | 设置控件的值。 |
### 属性
<p id="check_button_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#check_button_t_value">value</a> | bool\_t | 值。 |
### 事件
<p id="check_button_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(勾选状态)即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值(勾选状态)改变事件。 |
#### check\_button\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<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> | 创建多选按钮对象 |
| <a href="#check_button_t_check_button_create_radio">check\_button\_create\_radio</a> | 创建单选按钮对象 |
| <a href="#check_button_t_check_button_set_value">check\_button\_set\_value</a> | 设置控件的值。 |
### 属性
<p id="check_button_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#check_button_t_value">value</a> | bool\_t | 值。 |
### 事件
<p id="check_button_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(勾选状态)即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值(勾选状态)改变事件。 |
#### check\_button\_cast 函数
-----------------------
* 函数功能：
> <p id="check_button_t_check_button_cast"> 转换check_button对象(供脚本语言使用)。
* 函数原型：
```
widget_t* check_button_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | check\_button对象。 |
| widget | widget\_t* | check\_button对象。 |
#### check\_button\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* check_button_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | check\_button对象。 |
| widget | widget\_t* | check\_button对象。 |
#### check\_button\_create 函数
-----------------------
* 函数功能：
> <p id="check_button_t_check_button_create"> 创建多选按钮对象
* 函数原型：
```
widget_t* check_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 | 高度 |
#### check\_button\_create\_radio 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* check_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 | 高度 |
#### check\_button\_create\_radio 函数
-----------------------
* 函数功能：
> <p id="check_button_t_check_button_create_radio"> 创建单选按钮对象
* 函数原型：
```
widget_t* check_button_create_radio (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 | 高度 |
#### check\_button\_set\_value 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* check_button_create_radio (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 | 高度 |
#### check\_button\_set\_value 函数
-----------------------
* 函数功能：
> <p id="check_button_t_check_button_set_value"> 设置控件的值。
* 函数原型：
```
ret_t check_button_set_value (widget_t* widget, bool_t value);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | check\_button对象。 |
| value | bool\_t | 值 |
#### value 属性
-----------------------
* 函数原型：
```
ret_t check_button_set_value (widget_t* widget, bool_t value);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | check\_button对象。 |
| value | bool\_t | 值 |
#### value 属性
-----------------------
> <p id="check_button_t_value"> 值。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

3
docs/manual/children_layouter_default_t.md
View File

@ -9,7 +9,6 @@
https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_default.md)
----------------------------------
### 函数
<p id="children_layouter_default_t_methods">
@ -29,7 +28,6 @@ https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_default.md)
* 函数原型：
```
@ -50,7 +48,6 @@ children_layouter_t* children_layouter_default_create ();
* 函数原型：
```

7
docs/manual/children_layouter_factory_t.md
View File

@ -3,7 +3,6 @@
子控件布局算法工厂。
----------------------------------
### 函数
<p id="children_layouter_factory_t_methods">
@ -24,7 +23,6 @@
> <p id="children_layouter_factory_t_children_layouter_factory"> 获取缺省的子控件布局算法工厂对象。
* 函数原型：
```
@ -45,7 +43,6 @@ children_layouter_factory_t* children_layouter_factory ();
* 函数原型：
```
@ -66,7 +63,6 @@ children_layouter_factory_t* children_layouter_factory_create ();
* 函数原型：
```
@ -89,7 +85,6 @@ children_layouter_t* children_layouter_factory_create_layouter (children_layoute
* 函数原型：
```
@ -111,7 +106,6 @@ ret_t children_layouter_factory_destroy (children_layouter_factory_t* factory);
* 函数原型：
```
@ -135,7 +129,6 @@ ret_t children_layouter_factory_register (children_layouter_factory_t* factory,
* 函数原型：
```

2
docs/manual/children_layouter_list_view_t.md
View File

@ -9,7 +9,6 @@
https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_list_view.md)
----------------------------------
### 函数
<p id="children_layouter_list_view_t_methods">
@ -28,7 +27,6 @@ https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_list_view.md)
* 函数原型：
```

11
docs/manual/children_layouter_t.md
View File

@ -5,7 +5,6 @@
按特定算法对子控件进行排版布局，子类需要实现vtable中的函数。
----------------------------------
### 函数
<p id="children_layouter_t_methods">
@ -31,7 +30,6 @@
* 函数原型：
```
@ -54,7 +52,6 @@ children_layouter_t* children_layouter_create (const char* params);
* 函数原型：
```
@ -77,7 +74,6 @@ ret_t children_layouter_destroy (children_layouter_t* layouter);
* 函数原型：
```
@ -102,7 +98,6 @@ ret_t children_layouter_get_param (children_layouter_t* layouter, const char* na
* 函数原型：
```
@ -127,7 +122,6 @@ ret_t children_layouter_get_param_float (children_layouter_t* layouter, const ch
* 函数原型：
```
@ -152,7 +146,6 @@ ret_t children_layouter_get_param_int (children_layouter_t* layouter, const char
* 函数原型：
```
@ -175,7 +168,6 @@ bool_t children_layouter_is_valid (children_layouter_t* layouter);
* 函数原型：
```
@ -199,7 +191,6 @@ ret_t children_layouter_layout (children_layouter_t* layouter, widget_t* widget)
* 函数原型：
```
@ -224,7 +215,6 @@ ret_t children_layouter_set_param (children_layouter_t* layouter, const char* na
* 函数原型：
```
@ -248,7 +238,6 @@ ret_t children_layouter_set_param_str (children_layouter_t* layouter, const char
* 函数原型：
```

1
docs/manual/clip_board_data_type_t.md
View File

@ -1,7 +1,6 @@
## clip\_board\_data\_type\_t
### 概述
剪切板数据类型定义。
### 常量
<p id="clip_board_data_type_t_consts">

9
docs/manual/clip_board_t.md
View File

@ -2,7 +2,6 @@
### 概述
剪切板接口。
----------------------------------
### 函数
<p id="clip_board_t_methods">
@ -26,7 +25,6 @@
* 函数原型：
```
@ -47,7 +45,6 @@ ret_t clip_board ();
* 函数原型：
```
@ -69,7 +66,6 @@ ret_t clip_board_clear (clip_board_t* cl);
* 函数原型：
```
@ -91,7 +87,6 @@ ret_t clip_board_destroy (clip_board_t* cl);
* 函数原型：
```
@ -116,7 +111,6 @@ ret_t clip_board_get_data (clip_board_t* cl, clip_board_data_type_t* type, void*
* 函数原型：
```
@ -137,7 +131,6 @@ const char* clip_board_get_text ();
* 函数原型：
```
@ -159,7 +152,6 @@ ret_t clip_board_set (clip_board_t* cl);
* 函数原型：
```
@ -184,7 +176,6 @@ ret_t clip_board_set_data (clip_board_t* cl, clip_board_data_type_t type, const
* 函数原型：
```

272
docs/manual/color_component_t.md
View File

@ -1,153 +1,153 @@
## color\_component\_t
### 概述
![image](images/color_component_t_0.png)
## color\_component\_t
### 概述
![image](images/color_component_t_0.png)
颜色选择器的颜色分量。
控件的名称有严格规定：
COLOR_PICKER_CHILD_SV: 水平为Value/Brightness(递增)，垂直为Saturation(递减)。
COLOR_PICKER_CHILD_H: 水平为同色，垂直为Hue(递减)。
----------------------------------
### 函数
<p id="color_component_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#color_component_t_color_component_cast">color\_component\_cast</a> | 转换为color_component对象(供脚本语言使用)。 |
| <a href="#color_component_t_color_component_create">color\_component\_create</a> | 创建color_component对象 |
| <a href="#color_component_t_color_component_get_h">color\_component\_get\_h</a> | 获取h分量。 |
| <a href="#color_component_t_color_component_get_s">color\_component\_get\_s</a> | 获取s分量。 |
| <a href="#color_component_t_color_component_get_v">color\_component\_get\_v</a> | 获取v分量。 |
| <a href="#color_component_t_color_component_set_color">color\_component\_set\_color</a> | 设置颜色。 |
#### color\_component\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="color_component_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#color_component_t_color_component_cast">color\_component\_cast</a> | 转换为color_component对象(供脚本语言使用)。 |
| <a href="#color_component_t_color_component_create">color\_component\_create</a> | 创建color_component对象 |
| <a href="#color_component_t_color_component_get_h">color\_component\_get\_h</a> | 获取h分量。 |
| <a href="#color_component_t_color_component_get_s">color\_component\_get\_s</a> | 获取s分量。 |
| <a href="#color_component_t_color_component_get_v">color\_component\_get\_v</a> | 获取v分量。 |
| <a href="#color_component_t_color_component_set_color">color\_component\_set\_color</a> | 设置颜色。 |
#### color\_component\_cast 函数
-----------------------
* 函数功能：
> <p id="color_component_t_color_component_cast"> 转换为color_component对象(供脚本语言使用)。
* 函数原型：
```
widget_t* color_component_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | color\_component对象。 |
| widget | widget\_t* | color\_component对象。 |
#### color\_component\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* color_component_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | color\_component对象。 |
| widget | widget\_t* | color\_component对象。 |
#### color\_component\_create 函数
-----------------------
* 函数功能：
> <p id="color_component_t_color_component_create"> 创建color_component对象
* 函数原型：
```
widget_t* color_component_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 | 高度 |
#### color\_component\_get\_h 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* color_component_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 | 高度 |
#### color\_component\_get\_h 函数
-----------------------
* 函数功能：
> <p id="color_component_t_color_component_get_h"> 获取h分量。
* 函数原型：
```
float color_component_get_h (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | float | 返回h分量。 |
| widget | widget\_t* | color\_component对象。 |
#### color\_component\_get\_s 函数
-----------------------
* 函数功能：
* 函数原型：
```
float color_component_get_h (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | float | 返回h分量。 |
| widget | widget\_t* | color\_component对象。 |
#### color\_component\_get\_s 函数
-----------------------
* 函数功能：
> <p id="color_component_t_color_component_get_s"> 获取s分量。
* 函数原型：
```
float color_component_get_s (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | float | 返回s分量。 |
| widget | widget\_t* | color\_component对象。 |
#### color\_component\_get\_v 函数
-----------------------
* 函数功能：
* 函数原型：
```
float color_component_get_s (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | float | 返回s分量。 |
| widget | widget\_t* | color\_component对象。 |
#### color\_component\_get\_v 函数
-----------------------
* 函数功能：
> <p id="color_component_t_color_component_get_v"> 获取v分量。
* 函数原型：
```
float color_component_get_v (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | float | 返回v分量。 |
| widget | widget\_t* | color\_component对象。 |
#### color\_component\_set\_color 函数
-----------------------
* 函数功能：
* 函数原型：
```
float color_component_get_v (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | float | 返回v分量。 |
| widget | widget\_t* | color\_component对象。 |
#### color\_component\_set\_color 函数
-----------------------
* 函数功能：
> <p id="color_component_t_color_component_set_color"> 设置颜色。
* 函数原型：
```
ret_t color_component_set_color (widget_t* widget, color_t c);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| c | color\_t | 颜色。 |
* 函数原型：
```
ret_t color_component_set_color (widget_t* widget, color_t c);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| c | color\_t | 颜色。 |

2
docs/manual/color_parser_t.md
View File

@ -13,7 +13,6 @@
```
----------------------------------
### 函数
<p id="color_parser_t_methods">
@ -38,7 +37,6 @@
* 函数原型：
```

210
docs/manual/color_picker_t.md
View File

@ -1,7 +1,7 @@
## color\_picker\_t
### 概述
![image](images/color_picker_t_0.png)
## color\_picker\_t
### 概述
![image](images/color_picker_t_0.png)
颜色选择器。
color\_picker\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于color\_picker\_t控件。
@ -32,113 +32,113 @@
* old 旧的值。可以是spin_box、edit和color_tile。
* new 新的值。可以是spin_box、edit和color_tile。
----------------------------------
### 函数
<p id="color_picker_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#color_picker_t_color_picker_cast">color\_picker\_cast</a> | 转换为color_picker对象(供脚本语言使用)。 |
| <a href="#color_picker_t_color_picker_create">color\_picker\_create</a> | 创建color_picker对象 |
| <a href="#color_picker_t_color_picker_set_color">color\_picker\_set\_color</a> | 设置颜色。 |
### 属性
<p id="color_picker_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#color_picker_t_value">value</a> | const char* | 颜色。 |
### 事件
<p id="color_picker_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(颜色)即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值(颜色)改变事件。 |
#### color\_picker\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="color_picker_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#color_picker_t_color_picker_cast">color\_picker\_cast</a> | 转换为color_picker对象(供脚本语言使用)。 |
| <a href="#color_picker_t_color_picker_create">color\_picker\_create</a> | 创建color_picker对象 |
| <a href="#color_picker_t_color_picker_set_color">color\_picker\_set\_color</a> | 设置颜色。 |
### 属性
<p id="color_picker_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#color_picker_t_value">value</a> | const char* | 颜色。 |
### 事件
<p id="color_picker_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(颜色)即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值(颜色)改变事件。 |
#### color\_picker\_cast 函数
-----------------------
* 函数功能：
> <p id="color_picker_t_color_picker_cast"> 转换为color_picker对象(供脚本语言使用)。
* 函数原型：
```
widget_t* color_picker_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | color\_picker对象。 |
| widget | widget\_t* | color\_picker对象。 |
#### color\_picker\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* color_picker_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | color\_picker对象。 |
| widget | widget\_t* | color\_picker对象。 |
#### color\_picker\_create 函数
-----------------------
* 函数功能：
> <p id="color_picker_t_color_picker_create"> 创建color_picker对象
* 函数原型：
```
widget_t* color_picker_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 | 高度 |
#### color\_picker\_set\_color 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* color_picker_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 | 高度 |
#### color\_picker\_set\_color 函数
-----------------------
* 函数功能：
> <p id="color_picker_t_color_picker_set_color"> 设置颜色。
* 函数原型：
```
ret_t color_picker_set_color (widget_t* widget, const char* color);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| color | const char* | 颜色。 |
#### value 属性
-----------------------
* 函数原型：
```
ret_t color_picker_set_color (widget_t* widget, const char* color);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| color | const char* | 颜色。 |
#### value 属性
-----------------------
> <p id="color_picker_t_value"> 颜色。
* 类型：const char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
* 类型：const char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

12
docs/manual/color_t.md
View File

@ -3,7 +3,6 @@
颜色。
----------------------------------
### 函数
<p id="color_t_methods">
@ -40,7 +39,6 @@
* 函数原型：
```
@ -67,7 +65,6 @@ uint8_t color_a (color_t* c);
* 函数原型：
```
@ -91,7 +88,6 @@ uint8_t color_b (color_t* c);
* 函数原型：
```
@ -116,7 +112,6 @@ color_t* color_cast (color_t* color);
* 函数原型：
```
@ -144,7 +139,6 @@ color_t* color_create (uint8_t r, uint8_t b, uint8_t g, uint8_t a);
* 函数原型：
```
@ -169,7 +163,6 @@ ret_t color_destroy (color_t* c);
* 函数原型：
```
@ -197,7 +190,6 @@ color_t* color_from_str (color_t* c, const char* str);
* 函数原型：
```
@ -219,7 +211,6 @@ uint8_t color_g (color_t* c);
* 函数原型：
```
@ -249,7 +240,6 @@ color_t color_init (uint8_t r, uint8_t g, uint8_t b, uint8_t a);
* 函数原型：
```
@ -267,7 +257,6 @@ uint8_t color_r (color_t* c);
> <p id="color_t_color"> 颜色的数值。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -280,7 +269,6 @@ uint8_t color_r (color_t* c);
> <p id="color_t_rgba"> 颜色的RGBA值。
* 类型：rgba\_t
| 特性 | 是否支持 |

314
docs/manual/color_tile_t.md
View File

@ -1,7 +1,7 @@
## color\_tile\_t
### 概述
![image](images/color_tile_t_0.png)
## color\_tile\_t
### 概述
![image](images/color_tile_t_0.png)
色块控件。
用来显示一个颜色块，它通过属性而不是主题来设置颜色，方便在运行时动态改变颜色。
@ -27,168 +27,168 @@
```
> 创建之后，用color\_tile\_set\_bg\_color设置背景颜色。
----------------------------------
### 函数
<p id="color_tile_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#color_tile_t_color_tile_cast">color\_tile\_cast</a> | 转换为color_tile对象(供脚本语言使用)。 |
| <a href="#color_tile_t_color_tile_create">color\_tile\_create</a> | 创建color_tile对象 |
| <a href="#color_tile_t_color_tile_set_bg_color">color\_tile\_set\_bg\_color</a> | 设置背景颜色。 |
| <a href="#color_tile_t_color_tile_set_border_color">color\_tile\_set\_border\_color</a> | 设置边框颜色。 |
| <a href="#color_tile_t_color_tile_set_value">color\_tile\_set\_value</a> | 设置背景颜色。 |
### 属性
<p id="color_tile_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#color_tile_t_bg_color">bg\_color</a> | const char* | 背景颜色。 |
| <a href="#color_tile_t_border_color">border\_color</a> | const char* | 边框颜色。 |
#### color\_tile\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="color_tile_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#color_tile_t_color_tile_cast">color\_tile\_cast</a> | 转换为color_tile对象(供脚本语言使用)。 |
| <a href="#color_tile_t_color_tile_create">color\_tile\_create</a> | 创建color_tile对象 |
| <a href="#color_tile_t_color_tile_set_bg_color">color\_tile\_set\_bg\_color</a> | 设置背景颜色。 |
| <a href="#color_tile_t_color_tile_set_border_color">color\_tile\_set\_border\_color</a> | 设置边框颜色。 |
| <a href="#color_tile_t_color_tile_set_value">color\_tile\_set\_value</a> | 设置背景颜色。 |
### 属性
<p id="color_tile_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#color_tile_t_bg_color">bg\_color</a> | const char* | 背景颜色。 |
| <a href="#color_tile_t_border_color">border\_color</a> | const char* | 边框颜色。 |
#### color\_tile\_cast 函数
-----------------------
* 函数功能：
> <p id="color_tile_t_color_tile_cast"> 转换为color_tile对象(供脚本语言使用)。
* 函数原型：
```
widget_t* color_tile_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | color\_tile对象。 |
| widget | widget\_t* | color\_tile对象。 |
#### color\_tile\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* color_tile_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | color\_tile对象。 |
| widget | widget\_t* | color\_tile对象。 |
#### color\_tile\_create 函数
-----------------------
* 函数功能：
> <p id="color_tile_t_color_tile_create"> 创建color_tile对象
* 函数原型：
```
widget_t* color_tile_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 | 高度 |
#### color\_tile\_set\_bg\_color 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* color_tile_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 | 高度 |
#### color\_tile\_set\_bg\_color 函数
-----------------------
* 函数功能：
> <p id="color_tile_t_color_tile_set_bg_color"> 设置背景颜色。
* 函数原型：
```
ret_t color_tile_set_bg_color (widget_t* widget, const char* color);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| color | const char* | 背景颜色。 |
#### color\_tile\_set\_border\_color 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t color_tile_set_bg_color (widget_t* widget, const char* color);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| color | const char* | 背景颜色。 |
#### color\_tile\_set\_border\_color 函数
-----------------------
* 函数功能：
> <p id="color_tile_t_color_tile_set_border_color"> 设置边框颜色。
* 函数原型：
```
ret_t color_tile_set_border_color (widget_t* widget, const char* color);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| color | const char* | 边框颜色。 |
#### color\_tile\_set\_value 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t color_tile_set_border_color (widget_t* widget, const char* color);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| color | const char* | 边框颜色。 |
#### color\_tile\_set\_value 函数
-----------------------
* 函数功能：
> <p id="color_tile_t_color_tile_set_value"> 设置背景颜色。
* 函数原型：
```
ret_t color_tile_set_value (widget_t* widget, color_t color);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| color | color\_t | 背景颜色。 |
#### bg\_color 属性
-----------------------
* 函数原型：
```
ret_t color_tile_set_value (widget_t* widget, color_t color);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| color | color\_t | 背景颜色。 |
#### bg\_color 属性
-----------------------
> <p id="color_tile_t_bg_color"> 背景颜色。
* 类型：const char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### border\_color 属性
-----------------------
* 类型：const char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### border\_color 属性
-----------------------
> <p id="color_tile_t_border_color"> 边框颜色。
* 类型：const char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
* 类型：const char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

110
docs/manual/column_t.md
View File

@ -1,7 +1,7 @@
## column\_t
### 概述
![image](images/column_t_0.png)
## column\_t
### 概述
![image](images/column_t_0.png)
column。一个简单的容器控件，垂直排列其子控件。
它本身不提供布局功能，仅提供具有语义的标签，让xml更具有可读性。
@ -28,58 +28,58 @@
<normal bg_color="#f0f0f0" />
</style>
```
----------------------------------
### 函数
<p id="column_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#column_t_column_cast">column\_cast</a> | 转换为column对象(供脚本语言使用)。 |
| <a href="#column_t_column_create">column\_create</a> | 创建column对象 |
#### column\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="column_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#column_t_column_cast">column\_cast</a> | 转换为column对象(供脚本语言使用)。 |
| <a href="#column_t_column_create">column\_create</a> | 创建column对象 |
#### column\_cast 函数
-----------------------
* 函数功能：
> <p id="column_t_column_cast"> 转换为column对象(供脚本语言使用)。
* 函数原型：
```
widget_t* column_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | column对象。 |
| widget | widget\_t* | column对象。 |
#### column\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* column_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | column对象。 |
| widget | widget\_t* | column对象。 |
#### column\_create 函数
-----------------------
* 函数功能：
> <p id="column_t_column_create"> 创建column对象
* 函数原型：
```
widget_t* column_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 | 高度 |
* 函数原型：
```
widget_t* column_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 | 高度 |

2
docs/manual/combo_box_ex_t.md
View File

@ -5,7 +5,6 @@
可滚动的combo_box控件。
----------------------------------
### 函数
<p id="combo_box_ex_t_methods">
@ -22,7 +21,6 @@
* 函数原型：
```

286
docs/manual/combo_box_item_t.md
View File

@ -1,157 +1,157 @@
## combo\_box\_item\_t
### 概述
![image](images/combo_box_item_t_0.png)
## combo\_box\_item\_t
### 概述
![image](images/combo_box_item_t_0.png)
ComboBox Item控件。
本类仅供combo\_box控件内部使用。
----------------------------------
### 函数
<p id="combo_box_item_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#combo_box_item_t_combo_box_item_cast">combo\_box\_item\_cast</a> | 转换combo_box_item对象(供脚本语言使用)。 |
| <a href="#combo_box_item_t_combo_box_item_create">combo\_box\_item\_create</a> | 创建combo_box_item对象 |
| <a href="#combo_box_item_t_combo_box_item_set_checked">combo\_box\_item\_set\_checked</a> | 设置控件是否被选中。 |
| <a href="#combo_box_item_t_combo_box_item_set_value">combo\_box\_item\_set\_value</a> | 设置控件的值。 |
### 属性
<p id="combo_box_item_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#combo_box_item_t_checked">checked</a> | bool\_t | 是否被选中。 |
| <a href="#combo_box_item_t_value">value</a> | int32\_t | 值。 |
### 事件
<p id="combo_box_item_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(勾选状态)即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值(勾选状态)改变事件。 |
#### combo\_box\_item\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="combo_box_item_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#combo_box_item_t_combo_box_item_cast">combo\_box\_item\_cast</a> | 转换combo_box_item对象(供脚本语言使用)。 |
| <a href="#combo_box_item_t_combo_box_item_create">combo\_box\_item\_create</a> | 创建combo_box_item对象 |
| <a href="#combo_box_item_t_combo_box_item_set_checked">combo\_box\_item\_set\_checked</a> | 设置控件是否被选中。 |
| <a href="#combo_box_item_t_combo_box_item_set_value">combo\_box\_item\_set\_value</a> | 设置控件的值。 |
### 属性
<p id="combo_box_item_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#combo_box_item_t_checked">checked</a> | bool\_t | 是否被选中。 |
| <a href="#combo_box_item_t_value">value</a> | int32\_t | 值。 |
### 事件
<p id="combo_box_item_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(勾选状态)即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值(勾选状态)改变事件。 |
#### combo\_box\_item\_cast 函数
-----------------------
* 函数功能：
> <p id="combo_box_item_t_combo_box_item_cast"> 转换combo_box_item对象(供脚本语言使用)。
* 函数原型：
```
widget_t* combo_box_item_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | combo\_box\_item对象。 |
| widget | widget\_t* | combo\_box\_item对象。 |
#### combo\_box\_item\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* combo_box_item_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | combo\_box\_item对象。 |
| widget | widget\_t* | combo\_box\_item对象。 |
#### combo\_box\_item\_create 函数
-----------------------
* 函数功能：
> <p id="combo_box_item_t_combo_box_item_create"> 创建combo_box_item对象
* 函数原型：
```
widget_t* combo_box_item_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\_item\_set\_checked 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* combo_box_item_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\_item\_set\_checked 函数
-----------------------
* 函数功能：
> <p id="combo_box_item_t_combo_box_item_set_checked"> 设置控件是否被选中。
* 函数原型：
```
ret_t combo_box_item_set_checked (widget_t* widget, bool_t checked);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box\_item对象。 |
| checked | bool\_t | 是否被选中。 |
#### combo\_box\_item\_set\_value 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t combo_box_item_set_checked (widget_t* widget, bool_t checked);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box\_item对象。 |
| checked | bool\_t | 是否被选中。 |
#### combo\_box\_item\_set\_value 函数
-----------------------
* 函数功能：
> <p id="combo_box_item_t_combo_box_item_set_value"> 设置控件的值。
* 函数原型：
```
ret_t combo_box_item_set_value (widget_t* widget, int32_t value);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box\_item对象。 |
| value | int32\_t | 值 |
#### checked 属性
-----------------------
* 函数原型：
```
ret_t combo_box_item_set_value (widget_t* widget, int32_t value);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box\_item对象。 |
| value | int32\_t | 值 |
#### checked 属性
-----------------------
> <p id="combo_box_item_t_checked"> 是否被选中。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### value 属性
-----------------------
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### value 属性
-----------------------
> <p id="combo_box_item_t_value"> 值。
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

878
docs/manual/combo_box_t.md
View File

@ -1,7 +1,7 @@
## combo\_box\_t
### 概述
![image](images/combo_box_t_0.png)
## combo\_box\_t
### 概述
![image](images/combo_box_t_0.png)
下拉列表控件。
点击右边的按钮，可弹出一个下拉列表，从中选择一项作为当前的值。
@ -74,474 +74,474 @@ demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/combo_box.c)
> 更多用法请参考：[theme
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L422)
----------------------------------
### 函数
<p id="combo_box_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <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_custom_open_popup">combo\_box\_set\_custom\_open\_popup</a> | 设置自定义的打开弹出窗口的函数。 |
| <a href="#combo_box_t_combo_box_set_item_height">combo\_box\_set\_item\_height</a> | 设置item高度。 |
| <a href="#combo_box_t_combo_box_set_localize_options">combo\_box\_set\_localize\_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个选项为当前选中的选项。 |
| <a href="#combo_box_t_combo_box_set_value">combo\_box\_set\_value</a> | 设置值。 |
### 属性
<p id="combo_box_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#combo_box_t_item_height">item\_height</a> | int32\_t | 下拉选项的高度。如果open_window为空，则使用缺省高度。 |
| <a href="#combo_box_t_localize_options">localize\_options</a> | bool\_t | 是否本地化(翻译)选项(缺省为TRUE)。 |
| <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)。 |
| <a href="#combo_box_t_selected_index">selected\_index</a> | int32\_t | 当前选中的选项。 |
| <a href="#combo_box_t_value">value</a> | int32\_t | 值。 |
### 事件
<p id="combo_box_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值改变事件。 |
#### combo\_box\_append\_option 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="combo_box_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <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_custom_open_popup">combo\_box\_set\_custom\_open\_popup</a> | 设置自定义的打开弹出窗口的函数。 |
| <a href="#combo_box_t_combo_box_set_item_height">combo\_box\_set\_item\_height</a> | 设置item高度。 |
| <a href="#combo_box_t_combo_box_set_localize_options">combo\_box\_set\_localize\_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个选项为当前选中的选项。 |
| <a href="#combo_box_t_combo_box_set_value">combo\_box\_set\_value</a> | 设置值。 |
### 属性
<p id="combo_box_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#combo_box_t_item_height">item\_height</a> | int32\_t | 下拉选项的高度。如果open_window为空，则使用缺省高度。 |
| <a href="#combo_box_t_localize_options">localize\_options</a> | bool\_t | 是否本地化(翻译)选项(缺省为TRUE)。 |
| <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)。 |
| <a href="#combo_box_t_selected_index">selected\_index</a> | int32\_t | 当前选中的选项。 |
| <a href="#combo_box_t_value">value</a> | int32\_t | 值。 |
### 事件
<p id="combo_box_t_events">
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值即将改变事件。 |
| EVT\_VALUE\_CHANGED | event\_t | 值改变事件。 |
#### combo\_box\_append\_option 函数
-----------------------
* 函数功能：
> <p id="combo_box_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 函数
-----------------------
* 函数功能：
* 函数原型：
```
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 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* combo_box_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | combo\_box对象。 |
| widget | widget\_t* | combo\_box对象。 |
#### combo\_box\_count\_options 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_combo_box_count_options"> 获取选项个数。
* 函数原型：
```
int32_t combo_box_count_options (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回选项个数。 |
| widget | widget\_t* | combo\_box对象。 |
#### combo\_box\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
int32_t combo_box_count_options (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回选项个数。 |
| widget | widget\_t* | combo\_box对象。 |
#### combo\_box\_create 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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 函数
-----------------------
* 函数功能：
* 函数原型：
```
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 函数
-----------------------
* 函数功能：
> <p id="combo_box_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_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 函数
-----------------------
* 函数功能：
> <p id="combo_box_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\_value 函数
-----------------------
* 函数功能：
* 函数原型：
```
const char* combo_box_get_text (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | const char* | 返回文本。 |
| widget | widget\_t* | combo\_box对象。 |
#### combo\_box\_get\_value 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_combo_box_get_value"> 获取combo_box的值。
* 函数原型：
```
int32_t combo_box_get_value (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回值。 |
| widget | widget\_t* | combo\_box对象。 |
#### combo\_box\_reset\_options 函数
-----------------------
* 函数功能：
* 函数原型：
```
int32_t combo_box_get_value (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回值。 |
| widget | widget\_t* | combo\_box对象。 |
#### combo\_box\_reset\_options 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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_reset_options (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box对象。 |
#### combo\_box\_set\_custom\_open\_popup 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box对象。 |
| open\_popup | combo\_box\_custom\_open\_popup\_t | 回调函数。 |
#### combo\_box\_set\_item\_height 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t combo_box_set_custom_open_popup (widget_t* widget, combo_box_custom_open_popup_t open_popup);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | combo\_box对象。 |
| open\_popup | combo\_box\_custom\_open\_popup\_t | 回调函数。 |
#### combo\_box\_set\_item\_height 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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_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 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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\_open\_window 函数
-----------------------
* 函数功能：
* 函数原型：
```
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\_open\_window 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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_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 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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 函数
-----------------------
* 函数功能：
* 函数原型：
```
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 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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\_value 函数
-----------------------
* 函数功能：
* 函数原型：
```
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\_value 函数
-----------------------
* 函数功能：
> <p id="combo_box_t_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 属性
-----------------------
* 函数原型：
```
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 属性
-----------------------
> <p id="combo_box_t_item_height"> 下拉选项的高度。如果open_window为空，则使用缺省高度。
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### localize\_options 属性
-----------------------
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### localize\_options 属性
-----------------------
> <p id="combo_box_t_localize_options"> 是否本地化(翻译)选项(缺省为TRUE)。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### open\_window 属性
-----------------------
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### open\_window 属性
-----------------------
> <p id="combo_box_t_open_window"> 为点击按钮时，要打开窗口的名称。
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### options 属性
-----------------------
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### options 属性
-----------------------
> <p id="combo_box_t_options"> 设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### selected\_index 属性
-----------------------
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### selected\_index 属性
-----------------------
> <p id="combo_box_t_selected_index"> 当前选中的选项。
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### value 属性
-----------------------
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### value 属性
-----------------------
> <p id="combo_box_t_value"> 值。
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
* 类型：int32\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

4
docs/manual/compressor_t.md
View File

@ -4,7 +4,6 @@
compressor interface
----------------------------------
### 函数
<p id="compressor_t_methods">
@ -26,7 +25,6 @@
* 函数原型：
```
@ -54,7 +52,6 @@ ret_t compressor_compress (compressor_t* compressor, const void* data, uint32_t
* 函数原型：
```
@ -79,7 +76,6 @@ ret_t compressor_destroy (compressor_t* compressor);
* 函数原型：
```

8
docs/manual/custom_prop_t.md
View File

@ -1,5 +1,5 @@
## custom\_prop\_t
### 概述
## custom\_prop\_t
### 概述
widget自定义属性。
----------------------------------
----------------------------------

186
docs/manual/custom_props_t.md
View File

@ -1,102 +1,102 @@
## custom\_props\_t
### 概述
## custom\_props\_t
### 概述
widget自定义属性集合。
----------------------------------
### 函数
<p id="custom_props_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#custom_props_t_custom_props_create">custom\_props\_create</a> | 创建custom_props对象 |
| <a href="#custom_props_t_custom_props_destroy">custom\_props\_destroy</a> | 销毁属性集合。 |
| <a href="#custom_props_t_custom_props_get">custom\_props\_get</a> | 获取属性的值。 |
| <a href="#custom_props_t_custom_props_set">custom\_props\_set</a> | 设置属性的值。 |
#### custom\_props\_create 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="custom_props_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#custom_props_t_custom_props_create">custom\_props\_create</a> | 创建custom_props对象 |
| <a href="#custom_props_t_custom_props_destroy">custom\_props\_destroy</a> | 销毁属性集合。 |
| <a href="#custom_props_t_custom_props_get">custom\_props\_get</a> | 获取属性的值。 |
| <a href="#custom_props_t_custom_props_set">custom\_props\_set</a> | 设置属性的值。 |
#### custom\_props\_create 函数
-----------------------
* 函数功能：
> <p id="custom_props_t_custom_props_create"> 创建custom_props对象
* 函数原型：
```
custom_props_t* custom_props_create (uint32_t capacity);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | custom\_props\_t* | custom\_props对象。 |
| capacity | uint32\_t | 初始容量。 |
#### custom\_props\_destroy 函数
-----------------------
* 函数功能：
* 函数原型：
```
custom_props_t* custom_props_create (uint32_t capacity);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | custom\_props\_t* | custom\_props对象。 |
| capacity | uint32\_t | 初始容量。 |
#### custom\_props\_destroy 函数
-----------------------
* 函数功能：
> <p id="custom_props_t_custom_props_destroy"> 销毁属性集合。
* 函数原型：
```
ret_t custom_props_destroy (custom_props_t props);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| props | custom\_props\_t | 属性集合对象。 |
#### custom\_props\_get 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t custom_props_destroy (custom_props_t props);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| props | custom\_props\_t | 属性集合对象。 |
#### custom\_props\_get 函数
-----------------------
* 函数功能：
> <p id="custom_props_t_custom_props_get"> 获取属性的值。
* 函数原型：
```
ret_t custom_props_get (custom_props_t props, char* name, value_t* v);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| props | custom\_props\_t | 属性集合对象。 |
| name | char* | 属性的名称。 |
| v | value\_t* | 用于返回属性的值。 |
#### custom\_props\_set 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t custom_props_get (custom_props_t props, char* name, value_t* v);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| props | custom\_props\_t | 属性集合对象。 |
| name | char* | 属性的名称。 |
| v | value\_t* | 用于返回属性的值。 |
#### custom\_props\_set 函数
-----------------------
* 函数功能：
> <p id="custom_props_t_custom_props_set"> 设置属性的值。
* 函数原型：
```
ret_t custom_props_set (custom_props_t props, char* name, value_t* v);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| props | custom\_props\_t | 属性集合对象。 |
| name | char* | 属性的名称。 |
| v | value\_t* | 属性的值。 |
* 函数原型：
```
ret_t custom_props_set (custom_props_t props, char* name, value_t* v);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| props | custom\_props\_t | 属性集合对象。 |
| name | char* | 属性的名称。 |
| v | value\_t* | 属性的值。 |

22
docs/manual/darray_t.md
View File

@ -20,7 +20,6 @@
```
----------------------------------
### 函数
<p id="darray_t_methods">
@ -62,7 +61,6 @@
* 函数原型：
```
@ -84,7 +82,6 @@ ret_t darray_clear (darray_t* darray);
* 函数原型：
```
@ -108,7 +105,6 @@ int32_t darray_count (darray_t* darray, void* ctx);
* 函数原型：
```
@ -132,7 +128,6 @@ darray_t* darray_create (uint32_t capacity, tk_destroy_t destroy, tk_compare_t c
* 函数原型：
```
@ -154,7 +149,6 @@ ret_t darray_deinit (darray_t* darray);
* 函数原型：
```
@ -176,7 +170,6 @@ ret_t darray_destroy (darray_t* darray);
* 函数原型：
```
@ -199,7 +192,6 @@ void* darray_find (darray_t* darray, void* ctx);
* 函数原型：
```
@ -222,7 +214,6 @@ int darray_find_index (darray_t* darray, void* ctx);
* 函数原型：
```
@ -246,7 +237,6 @@ ret_t darray_foreach (darray_t* darray, tk_visit_t visit, void* ctx);
* 函数原型：
```
@ -269,7 +259,6 @@ void* darray_head (darray_t* darray);
* 函数原型：
```
@ -294,7 +283,6 @@ darray_t* darray_init (darray_t* darray, uint32_t* capacity, tk_destroy_t destro
* 函数原型：
```
@ -316,7 +304,6 @@ void* darray_pop (darray_t* darray);
* 函数原型：
```
@ -339,7 +326,6 @@ ret_t darray_push (darray_t* darray, void* data);
* 函数原型：
```
@ -362,7 +348,6 @@ ret_t darray_remove (darray_t* darray, void* ctx);
* 函数原型：
```
@ -385,7 +370,6 @@ ret_t darray_remove_all (darray_t* darray, void* ctx);
* 函数原型：
```
@ -408,7 +392,6 @@ ret_t darray_remove_index (darray_t* darray, uint32_t index);
* 函数原型：
```
@ -426,7 +409,6 @@ void* darray_tail (darray_t* darray);
> <p id="darray_t_capacity"> 数组的容量大小。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -438,7 +420,6 @@ void* darray_tail (darray_t* darray);
> <p id="darray_t_compare"> 元素比较函数。
* 类型：tk\_compare\_t
| 特性 | 是否支持 |
@ -450,7 +431,6 @@ void* darray_tail (darray_t* darray);
> <p id="darray_t_destroy"> 元素销毁函数。
* 类型：tk\_destroy\_t
| 特性 | 是否支持 |
@ -462,7 +442,6 @@ void* darray_tail (darray_t* darray);
> <p id="darray_t_elms"> 数组中的元素。
* 类型：void**
| 特性 | 是否支持 |
@ -474,7 +453,6 @@ void* darray_tail (darray_t* darray);
> <p id="darray_t_size"> 数组中元素的个数。
* 类型：uint32\_t
| 特性 | 是否支持 |

12
docs/manual/date_time_t.md
View File

@ -5,7 +5,6 @@
> 在嵌入式平台中，在系统初始时，需要调用date\_time\_set\_impl设置实际获取系统时间的函数。
----------------------------------
### 函数
<p id="date_time_t_methods">
@ -37,7 +36,6 @@
* 函数原型：
```
@ -59,7 +57,6 @@ date_time_t* date_time_create ();
* 函数原型：
```
@ -81,7 +78,6 @@ ret_t date_time_destroy (date_time_t* dt);
* 函数原型：
```
@ -106,7 +102,6 @@ date_time_t* date_time_init (date_time_t* dt);
* 函数原型：
```
@ -124,7 +119,6 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
> <p id="date_time_t_day"> 日(1-31)。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -137,7 +131,6 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
> <p id="date_time_t_hour"> 时(0 - 23)。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -150,7 +143,6 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
> <p id="date_time_t_minute"> 分(0 - 59)。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -163,7 +155,6 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
> <p id="date_time_t_month"> 月(1-12)。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -176,7 +167,6 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
> <p id="date_time_t_second"> 秒(0 - 59)。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -189,7 +179,6 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
> <p id="date_time_t_wday"> 星期几(0-6, Sunday = 0)。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -202,7 +191,6 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
> <p id="date_time_t_year"> 年。
* 类型：int32\_t
| 特性 | 是否支持 |

110
docs/manual/dialog_client_t.md
View File

@ -1,7 +1,7 @@
## dialog\_client\_t
### 概述
![image](images/dialog_client_t_0.png)
## dialog\_client\_t
### 概述
![image](images/dialog_client_t_0.png)
对话框客户区控件。
它本身不提供布局功能，仅提供具有语义的标签，让xml更具有可读性。
@ -25,58 +25,58 @@
在c代码中，用dialog\_create\_simple创建对话框时，自动创建dialog客户区对象。
----------------------------------
### 函数
<p id="dialog_client_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#dialog_client_t_dialog_client_cast">dialog\_client\_cast</a> | 转换为dialog_client对象(供脚本语言使用)。 |
| <a href="#dialog_client_t_dialog_client_create">dialog\_client\_create</a> | 创建dialog客户区对象。 |
#### dialog\_client\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="dialog_client_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#dialog_client_t_dialog_client_cast">dialog\_client\_cast</a> | 转换为dialog_client对象(供脚本语言使用)。 |
| <a href="#dialog_client_t_dialog_client_create">dialog\_client\_create</a> | 创建dialog客户区对象。 |
#### dialog\_client\_cast 函数
-----------------------
* 函数功能：
> <p id="dialog_client_t_dialog_client_cast"> 转换为dialog_client对象(供脚本语言使用)。
* 函数原型：
```
widget_t* dialog_client_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dialog\_client对象。 |
| widget | widget\_t* | dialog\_client对象。 |
#### dialog\_client\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* dialog_client_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dialog\_client对象。 |
| widget | widget\_t* | dialog\_client对象。 |
#### dialog\_client\_create 函数
-----------------------
* 函数功能：
> <p id="dialog_client_t_dialog_client_create"> 创建dialog客户区对象。
* 函数原型：
```
widget_t* dialog_client_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dialog对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
* 函数原型：
```
widget_t* dialog_client_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dialog对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |

4
docs/manual/dialog_highlighter_default_t.md
View File

@ -6,7 +6,6 @@
>对于性能不高的平台，建议将start\_alpha和end\_alpha设为相同。
----------------------------------
### 函数
<p id="dialog_highlighter_default_t_methods">
@ -30,7 +29,6 @@
* 函数原型：
```
@ -48,7 +46,6 @@ dialog_highlighter_t* dialog_highlighter_default_create (object_t* args);
> <p id="dialog_highlighter_default_t_end_alpha"> 结束alpha，打开对话框的动画结束(直到对话框被关闭)时的alpha值。
* 类型：uint8\_t
#### start\_alpha 属性
@ -56,6 +53,5 @@ dialog_highlighter_t* dialog_highlighter_default_create (object_t* args);
> <p id="dialog_highlighter_default_t_start_alpha"> 起始alpha，打开对话框的动画开始时的alpha值。
* 类型：uint8\_t

7
docs/manual/dialog_highlighter_factory_t.md
View File

@ -3,7 +3,6 @@
对话框高亮策略工厂。
----------------------------------
### 函数
<p id="dialog_highlighter_factory_t_methods">
@ -24,7 +23,6 @@
> <p id="dialog_highlighter_factory_t_dialog_highlighter_factory"> 获取缺省的对话框高亮策略工厂对象。
* 函数原型：
```
@ -45,7 +43,6 @@ dialog_highlighter_factory_t* dialog_highlighter_factory ();
* 函数原型：
```
@ -66,7 +63,6 @@ dialog_highlighter_factory_t* dialog_highlighter_factory_create ();
* 函数原型：
```
@ -90,7 +86,6 @@ dialog_highlighter_t* dialog_highlighter_factory_create_highlighter (dialog_high
* 函数原型：
```
@ -112,7 +107,6 @@ ret_t dialog_highlighter_factory_destroy (dialog_highlighter_factory_t* factory)
* 函数原型：
```
@ -136,7 +130,6 @@ ret_t dialog_highlighter_factory_register (dialog_highlighter_factory_t* factory
* 函数原型：
```

10
docs/manual/dialog_highlighter_t.md
View File

@ -5,7 +5,6 @@
> 高亮策略的基本思路是对背景进行处理，比如将背景变暗或变模糊。
----------------------------------
### 函数
<p id="dialog_highlighter_t_methods">
@ -37,7 +36,6 @@
* 函数原型：
```
@ -59,7 +57,6 @@ dialog_highlighter_t* dialog_highlighter_create (const dialog_highlighter_vtable
* 函数原型：
```
@ -81,7 +78,6 @@ ret_t dialog_highlighter_destroy (dialog_highlighter_t* h);
* 函数原型：
```
@ -104,7 +100,6 @@ ret_t dialog_highlighter_draw (dialog_highlighter_t* h, float_t percent);
* 函数原型：
```
@ -126,7 +121,6 @@ bool_t dialog_highlighter_is_dynamic (dialog_highlighter_t* h);
* 函数原型：
```
@ -149,7 +143,6 @@ ret_t dialog_highlighter_prepare (dialog_highlighter_t* h, canvas_t* c);
* 函数原型：
```
@ -169,7 +162,6 @@ ret_t dialog_highlighter_set_bg (dialog_highlighter_t* h, bitmap_t* img, framebu
> <p id="dialog_highlighter_t_canvas"> 画布。
* 类型：canvas\_t*
#### dialog 属性
@ -177,7 +169,6 @@ ret_t dialog_highlighter_set_bg (dialog_highlighter_t* h, bitmap_t* img, framebu
> <p id="dialog_highlighter_t_dialog"> 对应的对话框。
* 类型：widget\_t*
#### img 属性
@ -185,6 +176,5 @@ ret_t dialog_highlighter_set_bg (dialog_highlighter_t* h, bitmap_t* img, framebu
> <p id="dialog_highlighter_t_img"> 底层窗口的截图。
* 类型：bitmap\_t

1
docs/manual/dialog_highlighter_type_t.md
View File

@ -2,7 +2,6 @@
### 概述
@type string
内置的对话框高亮策略。
### 常量
<p id="dialog_highlighter_type_t_consts">

17
docs/manual/dialog_t.md
View File

@ -99,7 +99,6 @@
(https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L324)
----------------------------------
### 函数
<p id="dialog_t_methods">
@ -136,7 +135,6 @@
* 函数原型：
```
@ -161,7 +159,6 @@ widget_t* dialog_cast (widget_t* widget);
* 函数原型：
```
@ -184,7 +181,6 @@ ret_t dialog_confirm (const char* title, const char* text);
* 函数原型：
```
@ -210,7 +206,6 @@ widget_t* dialog_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
* 函数原型：
```
@ -236,7 +231,6 @@ widget_t* dialog_create_simple (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h
* 函数原型：
```
@ -258,7 +252,6 @@ widget_t* dialog_get_client (widget_t* widget);
* 函数原型：
```
@ -283,7 +276,6 @@ widget_t* dialog_get_title (widget_t* widget);
* 函数原型：
```
@ -307,7 +299,6 @@ ret_t dialog_info (const char* title, const char* text);
* 函数原型：
```
@ -330,7 +321,6 @@ bool_t dialog_is_modal (widget_t* widget);
* 函数原型：
```
@ -354,7 +344,6 @@ bool_t dialog_is_quited (widget_t* widget);
* 函数原型：
```
@ -378,7 +367,6 @@ ret_t dialog_modal (widget_t* widget);
* 函数原型：
```
@ -403,7 +391,6 @@ widget_t* dialog_open (const char* name);
* 函数原型：
```
@ -426,7 +413,6 @@ ret_t dialog_quit (widget_t* widget, uint32_t code);
* 函数原型：
```
@ -452,7 +438,6 @@ ret_t dialog_set_title (widget_t* widget, char* title);
* 函数原型：
```
@ -478,7 +463,6 @@ ret_t dialog_toast (const char* text, uint32_t duration);
* 函数原型：
```
@ -497,7 +481,6 @@ ret_t dialog_warn (const char* title, const char* text);
> <p id="dialog_t_highlight"> 对话框高亮策略。
* 类型：const char*
| 特性 | 是否支持 |

110
docs/manual/dialog_title_t.md
View File

@ -1,7 +1,7 @@
## dialog\_title\_t
### 概述
![image](images/dialog_title_t_0.png)
## dialog\_title\_t
### 概述
![image](images/dialog_title_t_0.png)
对话框标题控件。
它本身不提供布局功能，仅提供具有语义的标签，让xml更具有可读性。
@ -25,58 +25,58 @@
在c代码中，用dialog\_create\_simple创建对话框时，自动创建dialog标题对象。
----------------------------------
### 函数
<p id="dialog_title_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#dialog_title_t_dialog_title_cast">dialog\_title\_cast</a> | 转换为dialog_title对象(供脚本语言使用)。 |
| <a href="#dialog_title_t_dialog_title_create">dialog\_title\_create</a> | 创建dialog对象。 |
#### dialog\_title\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="dialog_title_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#dialog_title_t_dialog_title_cast">dialog\_title\_cast</a> | 转换为dialog_title对象(供脚本语言使用)。 |
| <a href="#dialog_title_t_dialog_title_create">dialog\_title\_create</a> | 创建dialog对象。 |
#### dialog\_title\_cast 函数
-----------------------
* 函数功能：
> <p id="dialog_title_t_dialog_title_cast"> 转换为dialog_title对象(供脚本语言使用)。
* 函数原型：
```
widget_t* dialog_title_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dialog\_title对象。 |
| widget | widget\_t* | dialog\_title对象。 |
#### dialog\_title\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* dialog_title_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dialog\_title对象。 |
| widget | widget\_t* | dialog\_title对象。 |
#### dialog\_title\_create 函数
-----------------------
* 函数功能：
> <p id="dialog_title_t_dialog_title_create"> 创建dialog对象。
* 函数原型：
```
widget_t* dialog_title_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dialog对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
* 函数原型：
```
widget_t* dialog_title_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dialog对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |

196
docs/manual/digit_clock_t.md
View File

@ -1,7 +1,7 @@
## digit\_clock\_t
### 概述
![image](images/digit_clock_t_0.png)
## digit\_clock\_t
### 概述
![image](images/digit_clock_t_0.png)
数字时钟控件。
digit\_clock\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于digit\_clock\_t控件。
@ -36,92 +36,92 @@
> 更多用法请参考：[theme default](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L138)
----------------------------------
### 函数
<p id="digit_clock_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#digit_clock_t_digit_clock_cast">digit\_clock\_cast</a> | 转换为digit_clock对象(供脚本语言使用)。 |
| <a href="#digit_clock_t_digit_clock_create">digit\_clock\_create</a> | 创建digit_clock对象 |
| <a href="#digit_clock_t_digit_clock_set_format">digit\_clock\_set\_format</a> | 设置显示格式。 |
### 属性
<p id="digit_clock_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#digit_clock_t_format">format</a> | char* | 显示格式。 |
#### digit\_clock\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="digit_clock_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#digit_clock_t_digit_clock_cast">digit\_clock\_cast</a> | 转换为digit_clock对象(供脚本语言使用)。 |
| <a href="#digit_clock_t_digit_clock_create">digit\_clock\_create</a> | 创建digit_clock对象 |
| <a href="#digit_clock_t_digit_clock_set_format">digit\_clock\_set\_format</a> | 设置显示格式。 |
### 属性
<p id="digit_clock_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#digit_clock_t_format">format</a> | char* | 显示格式。 |
#### digit\_clock\_cast 函数
-----------------------
* 函数功能：
> <p id="digit_clock_t_digit_clock_cast"> 转换为digit_clock对象(供脚本语言使用)。
* 函数原型：
```
widget_t* digit_clock_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | digit\_clock对象。 |
| widget | widget\_t* | digit\_clock对象。 |
#### digit\_clock\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* digit_clock_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | digit\_clock对象。 |
| widget | widget\_t* | digit\_clock对象。 |
#### digit\_clock\_create 函数
-----------------------
* 函数功能：
> <p id="digit_clock_t_digit_clock_create"> 创建digit_clock对象
* 函数原型：
```
widget_t* digit_clock_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 | 高度 |
#### digit\_clock\_set\_format 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* digit_clock_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 | 高度 |
#### digit\_clock\_set\_format 函数
-----------------------
* 函数功能：
> <p id="digit_clock_t_digit_clock_set_format"> 设置显示格式。
* 函数原型：
```
ret_t digit_clock_set_format (widget_t* widget, const char* format);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| format | const char* | 格式。 |
#### format 属性
-----------------------
* 函数原型：
```
ret_t digit_clock_set_format (widget_t* widget, const char* format);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| format | const char* | 格式。 |
#### format 属性
-----------------------
> <p id="digit_clock_t_format"> 显示格式。
* Y 代表年(完整显示)
@ -145,17 +145,17 @@ ret_t digit_clock_set_format (widget_t* widget, const char* format);
* "Y-D-M"显示为"2018-11-12"
* "Y-D-M h:m:s"显示为"2018-11-12 9:10:20"
* "Y-D-M hh:mm:ss"显示为"2018-11-12 09:10:20"
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

304
docs/manual/dragger_t.md
View File

@ -1,166 +1,166 @@
## dragger\_t
### 概述
![image](images/dragger_t_0.png)
## dragger\_t
### 概述
![image](images/dragger_t_0.png)
dragger控件。
目前主要用于scrollbar里的滑块。
----------------------------------
### 函数
<p id="dragger_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#dragger_t_dragger_cast">dragger\_cast</a> | 转换为dragger对象(供脚本语言使用)。 |
| <a href="#dragger_t_dragger_create">dragger\_create</a> | 创建dragger对象。 |
| <a href="#dragger_t_dragger_set_range">dragger\_set\_range</a> | 设置拖动的范围。 |
### 属性
<p id="dragger_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#dragger_t_x_max">x\_max</a> | xy\_t | x坐标的最大值。 |
| <a href="#dragger_t_x_min">x\_min</a> | xy\_t | x坐标的最小值。 |
| <a href="#dragger_t_y_max">y\_max</a> | xy\_t | y坐标的最大值。 |
| <a href="#dragger_t_y_min">y\_min</a> | xy\_t | y坐标的最小值。 |
#### dragger\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="dragger_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#dragger_t_dragger_cast">dragger\_cast</a> | 转换为dragger对象(供脚本语言使用)。 |
| <a href="#dragger_t_dragger_create">dragger\_create</a> | 创建dragger对象。 |
| <a href="#dragger_t_dragger_set_range">dragger\_set\_range</a> | 设置拖动的范围。 |
### 属性
<p id="dragger_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#dragger_t_x_max">x\_max</a> | xy\_t | x坐标的最大值。 |
| <a href="#dragger_t_x_min">x\_min</a> | xy\_t | x坐标的最小值。 |
| <a href="#dragger_t_y_max">y\_max</a> | xy\_t | y坐标的最大值。 |
| <a href="#dragger_t_y_min">y\_min</a> | xy\_t | y坐标的最小值。 |
#### dragger\_cast 函数
-----------------------
* 函数功能：
> <p id="dragger_t_dragger_cast"> 转换为dragger对象(供脚本语言使用)。
* 函数原型：
```
widget_t* dragger_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dragger对象。 |
| widget | widget\_t* | dragger对象。 |
#### dragger\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* dragger_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | dragger对象。 |
| widget | widget\_t* | dragger对象。 |
#### dragger\_create 函数
-----------------------
* 函数功能：
> <p id="dragger_t_dragger_create"> 创建dragger对象。
* 函数原型：
```
widget_t* dragger_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 | 高度 |
#### dragger\_set\_range 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* dragger_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 | 高度 |
#### dragger\_set\_range 函数
-----------------------
* 函数功能：
> <p id="dragger_t_dragger_set_range"> 设置拖动的范围。
* 函数原型：
```
widget_t* dragger_set_range (widget_t* widget, xy_t x_min, xy_t y_min, xy_t x_max, xy_t y_max);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | 对象。 |
| widget | widget\_t* | dragger控件。 |
| x\_min | xy\_t | x坐标最小值。 |
| y\_min | xy\_t | y坐标最小值。 |
| x\_max | xy\_t | x坐标最大值。 |
| y\_max | xy\_t | y坐标最大值。 |
#### x\_max 属性
-----------------------
* 函数原型：
```
widget_t* dragger_set_range (widget_t* widget, xy_t x_min, xy_t y_min, xy_t x_max, xy_t y_max);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | 对象。 |
| widget | widget\_t* | dragger控件。 |
| x\_min | xy\_t | x坐标最小值。 |
| y\_min | xy\_t | y坐标最小值。 |
| x\_max | xy\_t | x坐标最大值。 |
| y\_max | xy\_t | y坐标最大值。 |
#### x\_max 属性
-----------------------
> <p id="dragger_t_x_max"> x坐标的最大值。
* 类型：xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### x\_min 属性
-----------------------
* 类型：xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### x\_min 属性
-----------------------
> <p id="dragger_t_x_min"> x坐标的最小值。
* 类型：xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### y\_max 属性
-----------------------
* 类型：xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### y\_max 属性
-----------------------
> <p id="dragger_t_y_max"> y坐标的最大值。
* 类型：xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### y\_min 属性
-----------------------
* 类型：xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### y\_min 属性
-----------------------
> <p id="dragger_t_y_min"> y坐标的最小值。
* 类型：xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
* 类型：xy\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

1
docs/manual/easing_type_t.md
View File

@ -1,7 +1,6 @@
## easing\_type\_t
### 概述
缓动作动画常量定义。
### 常量
<p id="easing_type_t_consts">

1112
docs/manual/edit_t.md
View File

File diff suppressed because it is too large Load Diff

18
docs/manual/emitter_t.md
View File

@ -3,7 +3,6 @@
事件分发器, 用于实现观察者模式。
----------------------------------
### 函数
<p id="emitter_t_methods">
@ -43,7 +42,6 @@
* 函数原型：
```
@ -65,7 +63,6 @@ emitter_t* emitter_cast (emitter_t* emitter);
* 函数原型：
```
@ -87,7 +84,6 @@ emitter_t* emitter_create ();
* 函数原型：
```
@ -110,7 +106,6 @@ ret_t emitter_deinit (emitter_t* emitter);
* 函数原型：
```
@ -135,7 +130,6 @@ ret_t emitter_destroy (emitter_t* emitter);
* 函数原型：
```
@ -158,7 +152,6 @@ ret_t emitter_disable (emitter_t* emitter);
如果当前分发的回调函数返回RET_STOP，dispatch中断分发，并返回RET_STOP，否则返回RET_OK。
* 函数原型：
```
@ -182,7 +175,6 @@ ret_t emitter_dispatch (emitter_t* emitter, event_t* e);
如果当前分发的回调函数返回RET_STOP，dispatch中断分发，并返回RET_STOP，否则返回RET_OK。
* 函数原型：
```
@ -205,7 +197,6 @@ ret_t emitter_dispatch_simple_event (emitter_t* emitter, uint32_t type);
* 函数原型：
```
@ -227,7 +218,6 @@ ret_t emitter_enable (emitter_t* emitter);
* 函数原型：
```
@ -250,7 +240,6 @@ ret_t emitter_find (emitter_t* emitter, uint32_t id);
* 函数原型：
```
@ -272,7 +261,6 @@ emitter_t* emitter_init (emitter_t* emitter);
* 函数原型：
```
@ -295,7 +283,6 @@ ret_t emitter_off (emitter_t* emitter, uint32_t id);
* 函数原型：
```
@ -318,7 +305,6 @@ ret_t emitter_off_by_ctx (emitter_t* emitter, void* ctx);
* 函数原型：
```
@ -343,7 +329,6 @@ ret_t emitter_off_by_func (emitter_t* emitter, uint32_t type, event_func_t on_ev
* 函数原型：
```
@ -368,7 +353,6 @@ uint32_t emitter_on (emitter_t* emitter, uint32_t type, event_func_t on_event, v
* 函数原型：
```
@ -393,7 +377,6 @@ ret_t emitter_set_on_destroy (emitter_t* emitter, uint32_t id, tk_destroy_t on_d
* 函数原型：
```
@ -411,7 +394,6 @@ uint32_t emitter_size (emitter_t* emitter);
> <p id="emitter_t_enable"> 禁用标志。禁用时dispatch无效。
* 类型：bool\_t
| 特性 | 是否支持 |

1
docs/manual/event_base_type_t.md
View File

@ -1,7 +1,6 @@
## event\_base\_type\_t
### 概述
类型常量定义。
### 常量
<p id="event_base_type_t_consts">

2
docs/manual/event_source_fd_t.md
View File

@ -6,7 +6,6 @@
fd事件源。
----------------------------------
### 函数
<p id="event_source_fd_t_methods">
@ -26,7 +25,6 @@
* 函数原型：
```

3
docs/manual/event_source_idle_t.md
View File

@ -6,7 +6,6 @@
idle事件源。
----------------------------------
### 函数
<p id="event_source_idle_t_methods">
@ -27,7 +26,6 @@
* 函数原型：
```
@ -52,7 +50,6 @@ event_source_t* event_source_idle_create (idle_manager_t* idle_manager);
* 函数原型：
```

8
docs/manual/event_source_manager_t.md
View File

@ -4,7 +4,6 @@
事件源管理器。
----------------------------------
### 函数
<p id="event_source_manager_t_methods">
@ -30,7 +29,6 @@
* 函数原型：
```
@ -56,7 +54,6 @@ ret_t event_source_manager_add (event_source_manager_t* manager, event_source_t*
* 函数原型：
```
@ -81,7 +78,6 @@ ret_t event_source_manager_deinit (event_source_manager_t* manager);
* 函数原型：
```
@ -106,7 +102,6 @@ ret_t event_source_manager_destroy (event_source_manager_t* manager);
* 函数原型：
```
@ -131,7 +126,6 @@ ret_t event_source_manager_dispatch (event_source_manager_t* manager);
* 函数原型：
```
@ -156,7 +150,6 @@ uint32_t event_source_manager_get_wakeup_time (event_source_manager_t* manager);
* 函数原型：
```
@ -181,7 +174,6 @@ ret_t event_source_manager_init (event_source_manager_t* manager);
* 函数原型：
```

5
docs/manual/event_source_t.md
View File

@ -11,7 +11,6 @@
* 对于定时器，则get_wakeup_time返回下次唤醒的时间。
----------------------------------
### 函数
<p id="event_source_t_methods">
@ -34,7 +33,6 @@
* 函数原型：
```
@ -59,7 +57,6 @@ ret_t event_source_check (event_source_t* source);
* 函数原型：
```
@ -84,7 +81,6 @@ ret_t event_source_dispatch (event_source_t* source);
* 函数原型：
```
@ -109,7 +105,6 @@ int32_t event_source_get_fd (event_source_t* source);
* 函数原型：
```

2
docs/manual/event_source_timer_t.md
View File

@ -6,7 +6,6 @@
timer事件源。
----------------------------------
### 函数
<p id="event_source_timer_t_methods">
@ -26,7 +25,6 @@
* 函数原型：
```

8
docs/manual/event_t.md
View File

@ -2,7 +2,6 @@
### 概述
事件基类。
----------------------------------
### 函数
<p id="event_t_methods">
@ -32,7 +31,6 @@
* 函数原型：
```
@ -56,7 +54,6 @@ event_t* event_cast (event_t* event);
* 函数原型：
```
@ -81,7 +78,6 @@ event_t* event_create (uint32_t type, void* target);
* 函数原型：
```
@ -103,7 +99,6 @@ ret_t event_destroy (event_t* event);
* 函数原型：
```
@ -122,7 +117,6 @@ event_t event_init (uint32_t type, void* target);
> <p id="event_t_target"> 事件发生的目标对象。
* 类型：void*
| 特性 | 是否支持 |
@ -135,7 +129,6 @@ event_t event_init (uint32_t type, void* target);
> <p id="event_t_time"> 事件发生的时间。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -148,7 +141,6 @@ event_t event_init (uint32_t type, void* target);
> <p id="event_t_type"> 类型。
* 类型：int32\_t
| 特性 | 是否支持 |

1
docs/manual/event_type_t.md
View File

@ -1,7 +1,6 @@
## event\_type\_t
### 概述
类型常量定义。
### 常量
<p id="event_type_t_consts">

2
docs/manual/font_loader_bitmap_t.md
View File

@ -11,7 +11,6 @@
----------------------------------
### 函数
<p id="font_loader_bitmap_t_methods">
@ -29,7 +28,6 @@
* 函数原型：
```

60
docs/manual/font_loader_ft_t.md
View File

@ -1,38 +1,38 @@
## font\_loader\_ft\_t
### 概述
![image](images/font_loader_ft_t_0.png)
## font\_loader\_ft\_t
### 概述
![image](images/font_loader_ft_t_0.png)
freetype字体加载器。
freetype主要用于加载矢量字体(如truetype)，它功能强大，效果优异，与stb字体加载器相比，缺点是代码量比较大。
如果flash空间够大，优先使用freetype，否则使用stb。
----------------------------------
### 函数
<p id="font_loader_ft_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#font_loader_ft_t_font_loader_ft">font\_loader\_ft</a> | |
#### font\_loader\_ft 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="font_loader_ft_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#font_loader_ft_t_font_loader_ft">font\_loader\_ft</a> | |
#### font\_loader\_ft 函数
-----------------------
* 函数功能：
> <p id="font_loader_ft_t_font_loader_ft">
获取freetype字体加载器对象。
* 函数原型：
```
font_loader_t* font_loader_ft ();
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | font\_loader\_t* | 返回字体加载器对象。 |
* 函数原型：
```
font_loader_t* font_loader_ft ();
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | font\_loader\_t* | 返回字体加载器对象。 |

2
docs/manual/font_loader_stb_t.md
View File

@ -8,7 +8,6 @@
----------------------------------
### 函数
<p id="font_loader_stb_t_methods">
@ -26,7 +25,6 @@
* 函数原型：
```

2
docs/manual/font_loader_t.md
View File

@ -2,7 +2,6 @@
### 概述
字体加载接口。
----------------------------------
### 函数
<p id="font_loader_t_methods">
@ -20,7 +19,6 @@
* 函数原型：
```

11
docs/manual/font_manager_t.md
View File

@ -3,7 +3,6 @@
字体管理器，负责字体的加载和缓存管理。
(如果使用nanovg，字体由nanovg内部管理)
----------------------------------
### 函数
<p id="font_manager_t_methods">
@ -33,7 +32,6 @@
> <p id="font_manager_t_font_manager"> 获取缺省的字体管理器。
* 函数原型：
```
@ -54,7 +52,6 @@ font_manager_t* font_manager ();
* 函数原型：
```
@ -78,7 +75,6 @@ ret_t font_manager_add_font (font_manager_t* fm, char* name, font_t* font);
* 函数原型：
```
@ -100,7 +96,6 @@ font_manager_t* font_manager_create (font_loader_t* loader);
* 函数原型：
```
@ -122,7 +117,6 @@ ret_t font_manager_deinit (font_manager_t* fm);
* 函数原型：
```
@ -144,7 +138,6 @@ ret_t font_manager_destroy (font_manager_t* fm);
* 函数原型：
```
@ -168,7 +161,6 @@ font_t* font_manager_get_font (font_manager_t* fm, char* name, font_size_t size)
* 函数原型：
```
@ -191,7 +183,6 @@ font_manager_t* font_manager_init (font_manager_t* fm, font_loader_t* loader);
* 函数原型：
```
@ -221,7 +212,6 @@ ret_t font_manager_set (font_manager_t* fm);
* 函数原型：
```
@ -244,7 +234,6 @@ ret_t font_manager_set_assets_manager (font_manager_t* imm, assets_manager_t* as
* 函数原型：
```

5
docs/manual/font_t.md
View File

@ -3,7 +3,6 @@
代表一种字体。
----------------------------------
### 函数
<p id="font_t_methods">
@ -23,7 +22,6 @@
* 函数原型：
```
@ -45,7 +43,6 @@ ret_t font_destroy (font_t* font);
* 函数原型：
```
@ -69,7 +66,6 @@ int32_t font_get_baseline (font_t* font, font_size_t font_size);
* 函数原型：
```
@ -95,7 +91,6 @@ ret_t font_get_glyph (font_t* font, wchar_t chr, font_size_t font_size, glyph_t*
* 函数原型：
```

4
docs/manual/fs_dir_t.md
View File

@ -4,7 +4,6 @@
文件夹接口。
----------------------------------
### 函数
<p id="fs_dir_t_methods">
@ -26,7 +25,6 @@
* 函数原型：
```
@ -51,7 +49,6 @@ ret_t fs_dir_close (fs_dir_t* dir);
* 函数原型：
```
@ -77,7 +74,6 @@ ret_t fs_dir_read (fs_dir_t* dir, fs_item_t* item);
* 函数原型：
```

7
docs/manual/fs_file_t.md
View File

@ -4,7 +4,6 @@
文件接口。
----------------------------------
### 函数
<p id="fs_file_t_methods">
@ -29,7 +28,6 @@
* 函数原型：
```
@ -54,7 +52,6 @@ ret_t fs_file_close (fs_file_t* file);
* 函数原型：
```
@ -79,7 +76,6 @@ bool_t fs_file_eof (fs_file_t* file);
* 函数原型：
```
@ -106,7 +102,6 @@ int32_t fs_file_read (fs_file_t* file, void* buffer, uint32_t size);
* 函数原型：
```
@ -132,7 +127,6 @@ ret_t fs_file_seek (fs_file_t* file, uint32_t offset);
* 函数原型：
```
@ -157,7 +151,6 @@ ret_t fs_file_truncate (fs_file_t* file);
* 函数原型：
```

1
docs/manual/fs_t.md
View File

@ -4,5 +4,4 @@
文件系统接口。
----------------------------------

5
docs/manual/func_call_parser_t.md
View File

@ -11,7 +11,6 @@
如:move(x=10, y=20)
如:rename(old_name=aa, new_name=bb)
----------------------------------
### 函数
<p id="func_call_parser_t_methods">
@ -31,7 +30,6 @@
* 函数原型：
```
@ -53,7 +51,6 @@ ret_t func_call_parser_deinit (func_call_parser_t* parser);
* 函数原型：
```
@ -77,7 +74,6 @@ func_call_parser_t* func_call_parser_init (func_call_parser_t* parser, const cha
* 函数原型：
```
@ -101,7 +97,6 @@ ret_t func_call_parser_parse (func_call_parser_t* parser);
* 函数原型：
```

6
docs/manual/func_desc_t.md
View File

@ -2,7 +2,6 @@
### 概述
函数描述。
----------------------------------
### 属性
<p id="func_desc_t_properties">
@ -19,7 +18,6 @@
> <p id="func_desc_t_args"> 函数参数描述。
* 类型：arg\_desc\_t**
| 特性 | 是否支持 |
@ -31,7 +29,6 @@
> <p id="func_desc_t_desc"> 描述。
* 类型：const char*
| 特性 | 是否支持 |
@ -43,7 +40,6 @@
> <p id="func_desc_t_exec"> 函数指针。
* 类型：func\_exec\_t
| 特性 | 是否支持 |
@ -55,7 +51,6 @@
> <p id="func_desc_t_name"> 名称。
* 类型：const char*
| 特性 | 是否支持 |
@ -67,7 +62,6 @@
> <p id="func_desc_t_return_value"> 函数返回值描述。
* 类型：value\_desc\_t*
| 特性 | 是否支持 |

204
docs/manual/g2d_t.md
View File

@ -1,115 +1,115 @@
## g2d\_t
### 概述
## g2d\_t
### 概述
2D加速接口。
----------------------------------
### 函数
<p id="g2d_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#g2d_t_g2d_blend_image">g2d\_blend\_image</a> | 把图片指定的区域渲染到framebuffer指定的区域，src的大小和dst的大小不一致则进行缩放。 |
| <a href="#g2d_t_g2d_copy_image">g2d\_copy\_image</a> | 把图片指定的区域拷贝到framebuffer中。 |
| <a href="#g2d_t_g2d_copy_image">g2d\_copy\_image</a> | 把图片指定的区域进行旋转并拷贝到framebuffer相应的区域，本函数主要用于辅助实现横屏和竖屏的切换，一般支持90度旋转即可。 |
| <a href="#g2d_t_g2d_fill_rect">g2d\_fill\_rect</a> | 用颜色填充指定的区域。 |
#### g2d\_blend\_image 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="g2d_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#g2d_t_g2d_blend_image">g2d\_blend\_image</a> | 把图片指定的区域渲染到framebuffer指定的区域，src的大小和dst的大小不一致则进行缩放。 |
| <a href="#g2d_t_g2d_copy_image">g2d\_copy\_image</a> | 把图片指定的区域拷贝到framebuffer中。 |
| <a href="#g2d_t_g2d_copy_image">g2d\_copy\_image</a> | 把图片指定的区域进行旋转并拷贝到framebuffer相应的区域，本函数主要用于辅助实现横屏和竖屏的切换，一般支持90度旋转即可。 |
| <a href="#g2d_t_g2d_fill_rect">g2d\_fill\_rect</a> | 用颜色填充指定的区域。 |
#### g2d\_blend\_image 函数
-----------------------
* 函数功能：
> <p id="g2d_t_g2d_blend_image"> 把图片指定的区域渲染到framebuffer指定的区域，src的大小和dst的大小不一致则进行缩放。
1.硬件不支持缩放，则返回NOT_IMPL。
2.硬件不支持全局alpha，global_alpha!=0xff时返回NOT_IMPL。
* 函数原型：
```
ret_t g2d_blend_image (bitmap_t* fb, bitmap_t* img, rect_t* dst, rect_t* src, uint8_t global_alpha);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
| fb | bitmap\_t* | framebuffer对象。 |
| img | bitmap\_t* | 图片对象。 |
| dst | rect\_t* | 目的区域。 |
| src | rect\_t* | 源区域。 |
| global\_alpha | uint8\_t | 全局alpha。 |
#### g2d\_copy\_image 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t g2d_blend_image (bitmap_t* fb, bitmap_t* img, rect_t* dst, rect_t* src, uint8_t global_alpha);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
| fb | bitmap\_t* | framebuffer对象。 |
| img | bitmap\_t* | 图片对象。 |
| dst | rect\_t* | 目的区域。 |
| src | rect\_t* | 源区域。 |
| global\_alpha | uint8\_t | 全局alpha。 |
#### g2d\_copy\_image 函数
-----------------------
* 函数功能：
> <p id="g2d_t_g2d_copy_image"> 把图片指定的区域拷贝到framebuffer中。
* 函数原型：
```
ret_t g2d_copy_image (bitmap_t* fb, bitmap_t* img, rect_t* src, xy_t dx, xy_t dy);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
| fb | bitmap\_t* | framebuffer对象。 |
| img | bitmap\_t* | 图片对象。 |
| src | rect\_t* | 要拷贝的区域。 |
| dx | xy\_t | 目标位置的x坐标。 |
| dy | xy\_t | 目标位置的y坐标。 |
#### g2d\_copy\_image 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t g2d_copy_image (bitmap_t* fb, bitmap_t* img, rect_t* src, xy_t dx, xy_t dy);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
| fb | bitmap\_t* | framebuffer对象。 |
| img | bitmap\_t* | 图片对象。 |
| src | rect\_t* | 要拷贝的区域。 |
| dx | xy\_t | 目标位置的x坐标。 |
| dy | xy\_t | 目标位置的y坐标。 |
#### g2d\_copy\_image 函数
-----------------------
* 函数功能：
> <p id="g2d_t_g2d_copy_image"> 把图片指定的区域进行旋转并拷贝到framebuffer相应的区域，本函数主要用于辅助实现横屏和竖屏的切换，一般支持90度旋转即可。
* 函数原型：
```
ret_t g2d_copy_image (bitmap_t* fb, bitmap_t* img, rect_t* src, lcd_orientation_t o);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
| fb | bitmap\_t* | framebuffer对象。 |
| img | bitmap\_t* | 图片对象。 |
| src | rect\_t* | 要旋转并拷贝的区域。 |
| o | lcd\_orientation\_t | 旋转角度(一般支持90度即可)。 |
#### g2d\_fill\_rect 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t g2d_copy_image (bitmap_t* fb, bitmap_t* img, rect_t* src, lcd_orientation_t o);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
| fb | bitmap\_t* | framebuffer对象。 |
| img | bitmap\_t* | 图片对象。 |
| src | rect\_t* | 要旋转并拷贝的区域。 |
| o | lcd\_orientation\_t | 旋转角度(一般支持90度即可)。 |
#### g2d\_fill\_rect 函数
-----------------------
* 函数功能：
> <p id="g2d_t_g2d_fill_rect"> 用颜色填充指定的区域。
* 函数原型：
```
ret_t g2d_fill_rect (bitmap_t* fb, rect_t* dst, color_t c);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
| fb | bitmap\_t* | framebuffer对象。 |
| dst | rect\_t* | 要填充的目标区域。 |
| c | color\_t | 颜色。 |
* 函数原型：
```
ret_t g2d_fill_rect (bitmap_t* fb, rect_t* dst, color_t c);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
| fb | bitmap\_t* | framebuffer对象。 |
| dst | rect\_t* | 要填充的目标区域。 |
| c | color\_t | 颜色。 |

110
docs/manual/gif_image_t.md
View File

@ -1,7 +1,7 @@
## gif\_image\_t
### 概述
![image](images/gif_image_t_0.png)
## gif\_image\_t
### 概述
![image](images/gif_image_t_0.png)
GIF图片控件。
> 注意：GIF图片的尺寸大于控件大小时会自动缩小图片，但一般的嵌入式系统的硬件加速都不支持图片缩放，
@ -45,58 +45,58 @@
> 更多用法请参考：[theme default](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml)
----------------------------------
### 函数
<p id="gif_image_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#gif_image_t_gif_image_cast">gif\_image\_cast</a> | 转换为gif_image对象(供脚本语言使用)。 |
| <a href="#gif_image_t_gif_image_create">gif\_image\_create</a> | 创建gif_image对象 |
#### gif\_image\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="gif_image_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#gif_image_t_gif_image_cast">gif\_image\_cast</a> | 转换为gif_image对象(供脚本语言使用)。 |
| <a href="#gif_image_t_gif_image_create">gif\_image\_create</a> | 创建gif_image对象 |
#### gif\_image\_cast 函数
-----------------------
* 函数功能：
> <p id="gif_image_t_gif_image_cast"> 转换为gif_image对象(供脚本语言使用)。
* 函数原型：
```
widget_t* gif_image_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | gif\_image对象。 |
| widget | widget\_t* | gif\_image对象。 |
#### gif\_image\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* gif_image_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | gif\_image对象。 |
| widget | widget\_t* | gif\_image对象。 |
#### gif\_image\_create 函数
-----------------------
* 函数功能：
> <p id="gif_image_t_gif_image_create"> 创建gif_image对象
* 函数原型：
```
widget_t* gif_image_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 | 高度 |
* 函数原型：
```
widget_t* gif_image_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 | 高度 |

8
docs/manual/global_t.md
View File

@ -2,7 +2,6 @@
### 概述
TK全局对象。
----------------------------------
### 函数
<p id="global_t_methods">
@ -25,7 +24,6 @@
* 函数原型：
```
@ -46,7 +44,6 @@ int32_t tk_get_pointer_x ();
* 函数原型：
```
@ -67,7 +64,6 @@ int32_t tk_get_pointer_y ();
* 函数原型：
```
@ -93,7 +89,6 @@ ret_t tk_init (wh_t w, wh_t h, app_type_t app_type, const char* app_name, const
* 函数原型：
```
@ -114,7 +109,6 @@ bool_t tk_is_pointer_pressed ();
* 函数原型：
```
@ -135,7 +129,6 @@ ret_t tk_quit ();
* 函数原型：
```
@ -156,7 +149,6 @@ ret_t tk_run ();
* 函数原型：
```

1
docs/manual/glyph_format_t.md
View File

@ -1,7 +1,6 @@
## glyph\_format\_t
### 概述
字模格式常量定义。
### 常量
<p id="glyph_format_t_consts">

12
docs/manual/glyph_t.md
View File

@ -3,7 +3,6 @@
代表一个字符的字模。
----------------------------------
### 函数
<p id="glyph_t_methods">
@ -35,7 +34,6 @@
* 函数原型：
```
@ -56,7 +54,6 @@ glyph_t* glyph_clone ();
* 函数原型：
```
@ -77,7 +74,6 @@ glyph_t* glyph_create ();
* 函数原型：
```
@ -95,7 +91,6 @@ ret_t glyph_destroy (glyph_t* glyph);
> <p id="glyph_t_advance"> 占位宽度。
* 类型：uint16\_t
| 特性 | 是否支持 |
@ -107,7 +102,6 @@ ret_t glyph_destroy (glyph_t* glyph);
> <p id="glyph_t_data"> 数据。
* 类型：const uint8\_t*
| 特性 | 是否支持 |
@ -119,7 +113,6 @@ ret_t glyph_destroy (glyph_t* glyph);
> <p id="glyph_t_format"> 格式。
* 类型：uint8\_t
| 特性 | 是否支持 |
@ -131,7 +124,6 @@ ret_t glyph_destroy (glyph_t* glyph);
> <p id="glyph_t_h"> 高度。
* 类型：uint16\_t
| 特性 | 是否支持 |
@ -143,7 +135,6 @@ ret_t glyph_destroy (glyph_t* glyph);
> <p id="glyph_t_pitch"> pitch。
* 类型：uint8\_t
| 特性 | 是否支持 |
@ -155,7 +146,6 @@ ret_t glyph_destroy (glyph_t* glyph);
> <p id="glyph_t_w"> 宽度。
* 类型：uint16\_t
| 特性 | 是否支持 |
@ -167,7 +157,6 @@ ret_t glyph_destroy (glyph_t* glyph);
> <p id="glyph_t_x"> x坐标。
* 类型：int16\_t
| 特性 | 是否支持 |
@ -179,7 +168,6 @@ ret_t glyph_destroy (glyph_t* glyph);
> <p id="glyph_t_y"> y坐标。
* 类型：int16\_t
| 特性 | 是否支持 |

110
docs/manual/grid_item_t.md
View File

@ -1,7 +1,7 @@
## grid\_item\_t
### 概述
![image](images/grid_item_t_0.png)
## grid\_item\_t
### 概述
![image](images/grid_item_t_0.png)
grid_item。一个简单的容器控件，一般作为grid的子控件。
它本身不提供布局功能，仅提供具有语义的标签，让xml更具有可读性。
@ -35,58 +35,58 @@
<normal bg_color="#f0f0f0" />
</style>
```
----------------------------------
### 函数
<p id="grid_item_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#grid_item_t_grid_item_cast">grid\_item\_cast</a> | 转换为grid_item对象(供脚本语言使用)。 |
| <a href="#grid_item_t_grid_item_create">grid\_item\_create</a> | 创建grid_item对象 |
#### grid\_item\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="grid_item_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#grid_item_t_grid_item_cast">grid\_item\_cast</a> | 转换为grid_item对象(供脚本语言使用)。 |
| <a href="#grid_item_t_grid_item_create">grid\_item\_create</a> | 创建grid_item对象 |
#### grid\_item\_cast 函数
-----------------------
* 函数功能：
> <p id="grid_item_t_grid_item_cast"> 转换为grid_item对象(供脚本语言使用)。
* 函数原型：
```
widget_t* grid_item_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | grid\_item对象。 |
| widget | widget\_t* | grid\_item对象。 |
#### grid\_item\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* grid_item_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | grid\_item对象。 |
| widget | widget\_t* | grid\_item对象。 |
#### grid\_item\_create 函数
-----------------------
* 函数功能：
> <p id="grid_item_t_grid_item_create"> 创建grid_item对象
* 函数原型：
```
widget_t* grid_item_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 | 高度 |
* 函数原型：
```
widget_t* grid_item_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 | 高度 |

110
docs/manual/grid_t.md
View File

@ -1,7 +1,7 @@
## grid\_t
### 概述
![image](images/grid_t_0.png)
## grid\_t
### 概述
![image](images/grid_t_0.png)
grid控件。一个简单的容器控件，用于网格排列一组控件。
它本身不提供布局功能，仅提供具有语义的标签，让xml更具有可读性。
@ -29,58 +29,58 @@
</style>
```
----------------------------------
### 函数
<p id="grid_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#grid_t_grid_cast">grid\_cast</a> | 转换为grid对象(供脚本语言使用)。 |
| <a href="#grid_t_grid_create">grid\_create</a> | 创建grid对象 |
#### grid\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="grid_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#grid_t_grid_cast">grid\_cast</a> | 转换为grid对象(供脚本语言使用)。 |
| <a href="#grid_t_grid_create">grid\_create</a> | 创建grid对象 |
#### grid\_cast 函数
-----------------------
* 函数功能：
> <p id="grid_t_grid_cast"> 转换为grid对象(供脚本语言使用)。
* 函数原型：
```
widget_t* grid_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | grid对象。 |
| widget | widget\_t* | grid对象。 |
#### grid\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* grid_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | grid对象。 |
| widget | widget\_t* | grid对象。 |
#### grid\_create 函数
-----------------------
* 函数功能：
> <p id="grid_t_grid_create"> 创建grid对象
* 函数原型：
```
widget_t* grid_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 | 高度 |
* 函数原型：
```
widget_t* grid_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 | 高度 |

110
docs/manual/group_box_t.md
View File

@ -1,7 +1,7 @@
## group\_box\_t
### 概述
![image](images/group_box_t_0.png)
## group\_box\_t
### 概述
![image](images/group_box_t_0.png)
分组控件。
单选按钮在同一个父控件中是互斥的，所以通常将相关的单选按钮放在一个group\_box中。
@ -29,58 +29,58 @@
<normal bg_color="#f0f0f0" />
</style>
```
----------------------------------
### 函数
<p id="group_box_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#group_box_t_group_box_cast">group\_box\_cast</a> | 转换为group_box对象(供脚本语言使用)。 |
| <a href="#group_box_t_group_box_create">group\_box\_create</a> | 创建group_box对象 |
#### group\_box\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="group_box_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#group_box_t_group_box_cast">group\_box\_cast</a> | 转换为group_box对象(供脚本语言使用)。 |
| <a href="#group_box_t_group_box_create">group\_box\_create</a> | 创建group_box对象 |
#### group\_box\_cast 函数
-----------------------
* 函数功能：
> <p id="group_box_t_group_box_cast"> 转换为group_box对象(供脚本语言使用)。
* 函数原型：
```
widget_t* group_box_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | group\_box对象。 |
| widget | widget\_t* | group\_box对象。 |
#### group\_box\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* group_box_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | group\_box对象。 |
| widget | widget\_t* | group\_box对象。 |
#### group\_box\_create 函数
-----------------------
* 函数功能：
> <p id="group_box_t_group_box_create"> 创建group_box对象
* 函数原型：
```
widget_t* group_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 | 高度 |
* 函数原型：
```
widget_t* group_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 | 高度 |

10
docs/manual/guage_pointer_t.md
View File

@ -30,7 +30,6 @@
----------------------------------
### 函数
<p id="guage_pointer_t_methods">
@ -60,7 +59,6 @@
* 函数原型：
```
@ -82,7 +80,6 @@ widget_t* guage_pointer_cast (widget_t* widget);
* 函数原型：
```
@ -108,7 +105,6 @@ widget_t* guage_pointer_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h
* 函数原型：
```
@ -132,7 +128,6 @@ ret_t guage_pointer_set_anchor (widget_t* widget, const char* anchor_x, const ch
* 函数原型：
```
@ -155,7 +150,6 @@ ret_t guage_pointer_set_angle (widget_t* widget, int32_t angle);
* 函数原型：
```
@ -174,7 +168,6 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
> <p id="guage_pointer_t_anchor_x"> 旋转锚点x坐标。
* 类型：float\_t
| 特性 | 是否支持 |
@ -192,7 +185,6 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
> <p id="guage_pointer_t_anchor_y"> 旋转锚点y坐标。
* 类型：float\_t
| 特性 | 是否支持 |
@ -210,7 +202,6 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
> <p id="guage_pointer_t_angle"> 指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -231,7 +222,6 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
* 类型：char*
| 特性 | 是否支持 |

272
docs/manual/guage_t.md
View File

@ -1,7 +1,7 @@
## guage\_t
### 概述
![image](images/guage_t_0.png)
## guage\_t
### 概述
![image](images/guage_t_0.png)
表盘控件。
表盘控件就是一张图片。
@ -37,149 +37,149 @@
> 更多用法请参考：
[theme default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml)
----------------------------------
### 函数
<p id="guage_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#guage_t_guage_cast">guage\_cast</a> | 转换为guage对象(供脚本语言使用)。 |
| <a href="#guage_t_guage_create">guage\_create</a> | 创建guage对象 |
| <a href="#guage_t_guage_set_draw_type">guage\_set\_draw\_type</a> | 设置图片的显示方式。 |
| <a href="#guage_t_guage_set_image">guage\_set\_image</a> | 设置背景图片的名称。 |
### 属性
<p id="guage_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#guage_t_draw_type">draw\_type</a> | image\_draw\_type\_t | 图片的绘制方式。 |
| <a href="#guage_t_image">image</a> | char* | 背景图片。 |
#### guage\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="guage_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#guage_t_guage_cast">guage\_cast</a> | 转换为guage对象(供脚本语言使用)。 |
| <a href="#guage_t_guage_create">guage\_create</a> | 创建guage对象 |
| <a href="#guage_t_guage_set_draw_type">guage\_set\_draw\_type</a> | 设置图片的显示方式。 |
| <a href="#guage_t_guage_set_image">guage\_set\_image</a> | 设置背景图片的名称。 |
### 属性
<p id="guage_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#guage_t_draw_type">draw\_type</a> | image\_draw\_type\_t | 图片的绘制方式。 |
| <a href="#guage_t_image">image</a> | char* | 背景图片。 |
#### guage\_cast 函数
-----------------------
* 函数功能：
> <p id="guage_t_guage_cast"> 转换为guage对象(供脚本语言使用)。
* 函数原型：
```
widget_t* guage_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | guage对象。 |
| widget | widget\_t* | guage对象。 |
#### guage\_create 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* guage_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | guage对象。 |
| widget | widget\_t* | guage对象。 |
#### guage\_create 函数
-----------------------
* 函数功能：
> <p id="guage_t_guage_create"> 创建guage对象
* 函数原型：
```
widget_t* guage_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 | 高度 |
#### guage\_set\_draw\_type 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* guage_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 | 高度 |
#### guage\_set\_draw\_type 函数
-----------------------
* 函数功能：
> <p id="guage_t_guage_set_draw_type"> 设置图片的显示方式。
> 绘制方式的属性值和枚举值:
[image\_draw\_type\_name\_value](https://github.com/zlgopen/awtk/blob/master/src/base/enums.c#L98)
* 函数原型：
```
ret_t guage_set_draw_type (widget_t* widget, image_draw_type_t draw_type);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image对象。 |
| draw\_type | image\_draw\_type\_t | 显示方式。 |
#### guage\_set\_image 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t guage_set_draw_type (widget_t* widget, image_draw_type_t draw_type);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image对象。 |
| draw\_type | image\_draw\_type\_t | 显示方式。 |
#### guage\_set\_image 函数
-----------------------
* 函数功能：
> <p id="guage_t_guage_set_image"> 设置背景图片的名称。
* 函数原型：
```
ret_t guage_set_image (widget_t* widget, char* name);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image对象。 |
| name | char* | 图片名称，该图片必须存在于资源管理器。 |
#### draw\_type 属性
-----------------------
* 函数原型：
```
ret_t guage_set_image (widget_t* widget, char* name);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image对象。 |
| name | char* | 图片名称，该图片必须存在于资源管理器。 |
#### draw\_type 属性
-----------------------
> <p id="guage_t_draw_type"> 图片的绘制方式。
* 类型：image\_draw\_type\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### image 属性
-----------------------
* 类型：image\_draw\_type\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### image 属性
-----------------------
> <p id="guage_t_image"> 背景图片。
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

45
docs/manual/hscroll_label_t.md
View File

@ -30,7 +30,6 @@ https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/mledit.xml)
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml)
----------------------------------
### 函数
<p id="hscroll_label_t_methods">
@ -54,13 +53,13 @@ https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml)
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#hscroll_label_t_duration">duration</a> | int32\_t | 完整的滚动一次需要的时间(ms)，缺省5000ms。 |
| <a href="#hscroll_label_t_ellipses">ellipses</a> | bool\_t | |
| <a href="#hscroll_label_t_loop">loop</a> | bool\_t | |
| <a href="#hscroll_label_t_lull">lull</a> | int32\_t | |
| <a href="#hscroll_label_t_only_focus">only\_focus</a> | bool\_t | |
| <a href="#hscroll_label_t_ellipses">ellipses</a> | bool\_t | 文本显示不下时，在行尾显示省略号(缺省FALSE)。 |
| <a href="#hscroll_label_t_loop">loop</a> | bool\_t | loop是否循环滚动(缺省FALSE)。 |
| <a href="#hscroll_label_t_lull">lull</a> | int32\_t | 滚动之间的间歇时间(ms)，缺省3000ms。 |
| <a href="#hscroll_label_t_only_focus">only\_focus</a> | bool\_t | 只有处于focus时才滚动(缺省否)。 |
| <a href="#hscroll_label_t_text_w">text\_w</a> | int32\_t | 文本的宽度。 |
| <a href="#hscroll_label_t_xoffset">xoffset</a> | int32\_t | 偏移量。 |
| <a href="#hscroll_label_t_yoyo">yoyo</a> | bool\_t | |
| <a href="#hscroll_label_t_yoyo">yoyo</a> | bool\_t | 是否往返滚动(缺省FALSE)。 |
#### hscroll\_label\_cast 函数
-----------------------
@ -70,7 +69,6 @@ https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml)
* 函数原型：
```
@ -92,7 +90,6 @@ widget_t* hscroll_label_cast (widget_t* widget);
* 函数原型：
```
@ -118,7 +115,6 @@ widget_t* hscroll_label_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h
* 函数原型：
```
@ -141,7 +137,6 @@ ret_t hscroll_label_set_duration (widget_t* widget, int32_t duration);
* 函数原型：
```
@ -164,7 +159,6 @@ ret_t hscroll_label_set_ellipses (widget_t* widget, bool_t ellipses);
* 函数原型：
```
@ -187,7 +181,6 @@ ret_t hscroll_label_set_loop (widget_t* widget, bool_t loop);
* 函数原型：
```
@ -210,7 +203,6 @@ ret_t hscroll_label_set_lull (widget_t* widget, int32_t lull);
* 函数原型：
```
@ -233,7 +225,6 @@ ret_t hscroll_label_set_only_focus (widget_t* widget, bool_t only_focus);
* 函数原型：
```
@ -256,7 +247,6 @@ ret_t hscroll_label_set_xoffset (widget_t* widget, int32_t xoffset);
* 函数原型：
```
@ -279,7 +269,6 @@ ret_t hscroll_label_set_yoyo (widget_t* widget, bool_t yoyo);
* 函数原型：
```
@ -301,7 +290,6 @@ ret_t hscroll_label_start (widget_t* widget);
* 函数原型：
```
@ -319,7 +307,6 @@ ret_t hscroll_label_stop (widget_t* widget);
> <p id="hscroll_label_t_duration"> 完整的滚动一次需要的时间(ms)，缺省5000ms。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -332,9 +319,7 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 |
#### ellipses 属性
-----------------------
> <p id="hscroll_label_t_ellipses">
文本显示不下时，在行尾显示ellipses(缺省FALSE)。
> <p id="hscroll_label_t_ellipses"> 文本显示不下时，在行尾显示省略号(缺省FALSE)。
* 类型：bool\_t
@ -351,9 +336,7 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 |
#### loop 属性
-----------------------
> <p id="hscroll_label_t_loop">
loop是否循环滚动(缺省FALSE)。
> <p id="hscroll_label_t_loop"> loop是否循环滚动(缺省FALSE)。
* 类型：bool\_t
@ -370,9 +353,7 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 |
#### lull 属性
-----------------------
> <p id="hscroll_label_t_lull">
滚动之间的间歇时间(ms)，缺省3000ms。
> <p id="hscroll_label_t_lull"> 滚动之间的间歇时间(ms)，缺省3000ms。
* 类型：int32\_t
@ -389,9 +370,7 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 |
#### only\_focus 属性
-----------------------
> <p id="hscroll_label_t_only_focus">
只有处于focus时才滚动(缺省否)。
> <p id="hscroll_label_t_only_focus"> 只有处于focus时才滚动(缺省否)。
* 类型：bool\_t
@ -411,7 +390,6 @@ ret_t hscroll_label_stop (widget_t* widget);
> <p id="hscroll_label_t_text_w"> 文本的宽度。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -427,7 +405,6 @@ ret_t hscroll_label_stop (widget_t* widget);
> <p id="hscroll_label_t_xoffset"> 偏移量。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -440,9 +417,7 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 |
#### yoyo 属性
-----------------------
> <p id="hscroll_label_t_yoyo">
是否往返滚动(缺省FALSE)。
> <p id="hscroll_label_t_yoyo"> 是否往返滚动(缺省FALSE)。
* 类型：bool\_t

1
docs/manual/hscrollable_t.md
View File

@ -2,5 +2,4 @@
### 概述
帮助实现控件左右滚动的效果。
----------------------------------

24
docs/manual/icon_at_type_t.md
View File

@ -1,13 +1,13 @@
## icon\_at\_type\_t
### 概述
## icon\_at\_type\_t
### 概述
图标所在的位置。
### 常量
<p id="icon_at_type_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| ICON\_AT\_AUTO | 自动选择位置。 |
| ICON\_AT\_LEFT | 水平左边，垂直居中。 |
| ICON\_AT\_RIGHT | 水平右边，垂直居中(not used now)。 |
| ICON\_AT\_TOP | 水平居中，垂直顶部(not used now)。 |
| ICON\_AT\_BOTTOM | 水平居中，垂直低部(not used now)。 |
### 常量
<p id="icon_at_type_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| ICON\_AT\_AUTO | 自动选择位置。 |
| ICON\_AT\_LEFT | 水平左边，垂直居中。 |
| ICON\_AT\_RIGHT | 水平右边，垂直居中(not used now)。 |
| ICON\_AT\_TOP | 水平居中，垂直顶部(not used now)。 |
| ICON\_AT\_BOTTOM | 水平居中，垂直低部(not used now)。 |

7
docs/manual/idle_info_t.md
View File

@ -5,7 +5,6 @@
单个idle的信息。
----------------------------------
### 函数
<p id="idle_info_t_methods">
@ -32,7 +31,6 @@
* 函数原型：
```
@ -50,7 +48,6 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
> <p id="idle_info_t_ctx"> idle回调函数上下文。
* 类型：void*
| 特性 | 是否支持 |
@ -65,7 +62,6 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
> 为TK\_INVALID\_ID时表示无效idle。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -78,7 +74,6 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
> <p id="idle_info_t_on_destroy"> idle销毁时的回调函数。
* 类型：tk\_destroy\_t
| 特性 | 是否支持 |
@ -90,7 +85,6 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
> <p id="idle_info_t_on_destroy_ctx"> idle销毁时的回调函数的上下文。
* 类型：tk\_destroy\_t
| 特性 | 是否支持 |
@ -102,7 +96,6 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
> <p id="idle_info_t_on_idle"> idle回调函数。
* 类型：idle\_func\_t
| 特性 | 是否支持 |

6
docs/manual/idle_t.md
View File

@ -24,7 +24,6 @@
> 在非GUI线程请用idle\_queue。
----------------------------------
### 函数
<p id="idle_t_methods">
@ -45,7 +44,6 @@
* 函数原型：
```
@ -68,7 +66,6 @@ uint32_t idle_add (idle_func_t on_idle, void* ctx);
* 函数原型：
```
@ -89,7 +86,6 @@ uint32_t idle_count ();
* 函数原型：
```
@ -112,7 +108,6 @@ ret_t idle_queue (idle_func_t on_idle, void* ctx);
* 函数原型：
```
@ -134,7 +129,6 @@ ret_t idle_remove (uint32_t idle_id);
* 函数原型：
```

3
docs/manual/im_action_button_info_event_t.md
View File

@ -4,7 +4,6 @@
设置软键盘上的action按钮的信息事件。
----------------------------------
### 属性
<p id="im_action_button_info_event_t_properties">
@ -18,7 +17,6 @@
> <p id="im_action_button_info_event_t_enable"> 软键盘上的action按钮启用。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -30,7 +28,6 @@
> <p id="im_action_button_info_event_t_text"> 软键盘上的action按钮显示的文本。
* 类型：char*
| 特性 | 是否支持 |

3
docs/manual/im_candidates_event_t.md
View File

@ -4,7 +4,6 @@
输入法请求显示候选字的事件。
----------------------------------
### 属性
<p id="im_candidates_event_t_properties">
@ -18,7 +17,6 @@
> <p id="im_candidates_event_t_candidates"> 可选的文本，多个文本以\0分隔。如：里\0李\0力\0离\0
* 类型：char*
| 特性 | 是否支持 |
@ -30,7 +28,6 @@
> <p id="im_candidates_event_t_candidates_nr"> 可选的文本的个数。
* 类型：uint32\_t
| 特性 | 是否支持 |

3
docs/manual/im_commit_event_t.md
View File

@ -4,7 +4,6 @@
输入法提交输入的文本事件。
----------------------------------
### 属性
<p id="im_commit_event_t_properties">
@ -18,7 +17,6 @@
> <p id="im_commit_event_t_replace;"> 是否替换原来的文本。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -30,7 +28,6 @@
> <p id="im_commit_event_t_text"> 提交的文本。
* 类型：char*
| 特性 | 是否支持 |

960
docs/manual/image_animation_t.md
View File

File diff suppressed because it is too large Load Diff

668
docs/manual/image_base_t.md
View File

@ -1,12 +1,12 @@
## image\_base\_t
### 概述
![image](images/image_base_t_0.png)
## image\_base\_t
### 概述
![image](images/image_base_t_0.png)
图片控件基类。
本类把图片相关控件的公共行为进行抽象，放到一起方便重用。目前已知的具体实现如下图：
![image](images/image_base_t_1.png)
![image](images/image_base_t_1.png)
> 本类是一个抽象类，不能进行实例化。请在应用程序中使用具体的类，如image\_t。
@ -18,360 +18,360 @@
<gif image="file://./demos/assets/raw/images/x2/bee.gif" />
<svg image="file://./demos/assets/raw/images/svg/china.bsvg" />
```
----------------------------------
### 函数
<p id="image_base_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#image_base_t_image_base_cast">image\_base\_cast</a> | 转换为image_base对象(供脚本语言使用)。 |
| <a href="#image_base_t_image_base_set_anchor">image\_base\_set\_anchor</a> | 设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。 |
| <a href="#image_base_t_image_base_set_clickable">image\_base\_set\_clickable</a> | 设置控件是否可以被点击。 |
| <a href="#image_base_t_image_base_set_image">image\_base\_set\_image</a> | 设置控件的图片名称。 |
| <a href="#image_base_t_image_base_set_rotation">image\_base\_set\_rotation</a> | 设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。 |
| <a href="#image_base_t_image_base_set_scale">image\_base\_set\_scale</a> | 设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。 |
| <a href="#image_base_t_image_base_set_selectable">image\_base\_set\_selectable</a> | 设置控件是否可以被选中。 |
| <a href="#image_base_t_image_base_set_selected">image\_base\_set\_selected</a> | 设置控件的选中状态。 |
### 属性
<p id="image_base_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#image_base_t_anchor_x">anchor\_x</a> | float\_t | 锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。 |
| <a href="#image_base_t_anchor_y">anchor\_y</a> | float\_t | 锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。 |
| <a href="#image_base_t_clickable">clickable</a> | bool\_t | 点击时，是否触发EVT_CLICK事件。 |
| <a href="#image_base_t_image">image</a> | char* | 图片的名称。 |
| <a href="#image_base_t_rotation">rotation</a> | float\_t | 控件的旋转角度(幅度)。 |
| <a href="#image_base_t_scale_x">scale\_x</a> | float\_t | 控件在X方向上的缩放比例。 |
| <a href="#image_base_t_scale_y">scale\_y</a> | float\_t | 控件在Y方向上的缩放比例。 |
| <a href="#image_base_t_selectable">selectable</a> | bool\_t | 是否设置选中状态。 |
| <a href="#image_base_t_selected">selected</a> | bool\_t | 当前是否被选中。 |
#### image\_base\_cast 函数
-----------------------
* 函数功能：
----------------------------------
### 函数
<p id="image_base_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#image_base_t_image_base_cast">image\_base\_cast</a> | 转换为image_base对象(供脚本语言使用)。 |
| <a href="#image_base_t_image_base_set_anchor">image\_base\_set\_anchor</a> | 设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。 |
| <a href="#image_base_t_image_base_set_clickable">image\_base\_set\_clickable</a> | 设置控件是否可以被点击。 |
| <a href="#image_base_t_image_base_set_image">image\_base\_set\_image</a> | 设置控件的图片名称。 |
| <a href="#image_base_t_image_base_set_rotation">image\_base\_set\_rotation</a> | 设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。 |
| <a href="#image_base_t_image_base_set_scale">image\_base\_set\_scale</a> | 设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。 |
| <a href="#image_base_t_image_base_set_selectable">image\_base\_set\_selectable</a> | 设置控件是否可以被选中。 |
| <a href="#image_base_t_image_base_set_selected">image\_base\_set\_selected</a> | 设置控件的选中状态。 |
### 属性
<p id="image_base_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#image_base_t_anchor_x">anchor\_x</a> | float\_t | 锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。 |
| <a href="#image_base_t_anchor_y">anchor\_y</a> | float\_t | 锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。 |
| <a href="#image_base_t_clickable">clickable</a> | bool\_t | 点击时，是否触发EVT_CLICK事件。 |
| <a href="#image_base_t_image">image</a> | char* | 图片的名称。 |
| <a href="#image_base_t_rotation">rotation</a> | float\_t | 控件的旋转角度(幅度)。 |
| <a href="#image_base_t_scale_x">scale\_x</a> | float\_t | 控件在X方向上的缩放比例。 |
| <a href="#image_base_t_scale_y">scale\_y</a> | float\_t | 控件在Y方向上的缩放比例。 |
| <a href="#image_base_t_selectable">selectable</a> | bool\_t | 是否设置选中状态。 |
| <a href="#image_base_t_selected">selected</a> | bool\_t | 当前是否被选中。 |
#### image\_base\_cast 函数
-----------------------
* 函数功能：
> <p id="image_base_t_image_base_cast"> 转换为image_base对象(供脚本语言使用)。
* 函数原型：
```
widget_t* image_base_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | image\_base对象。 |
| widget | widget\_t* | image\_base对象。 |
#### image\_base\_set\_anchor 函数
-----------------------
* 函数功能：
* 函数原型：
```
widget_t* image_base_cast (widget_t* widget);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | image\_base对象。 |
| widget | widget\_t* | image\_base对象。 |
#### image\_base\_set\_anchor 函数
-----------------------
* 函数功能：
> <p id="image_base_t_image_base_set_anchor"> 设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。
* 函数原型：
```
ret_t image_base_set_anchor (widget_t* widget, float_t anchor_x, float_t anchor_y);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| anchor\_x | float\_t | 锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。 |
| anchor\_y | float\_t | 锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。 |
#### image\_base\_set\_clickable 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t image_base_set_anchor (widget_t* widget, float_t anchor_x, float_t anchor_y);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| anchor\_x | float\_t | 锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。 |
| anchor\_y | float\_t | 锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。 |
#### image\_base\_set\_clickable 函数
-----------------------
* 函数功能：
> <p id="image_base_t_image_base_set_clickable"> 设置控件是否可以被点击。
* 函数原型：
```
ret_t image_base_set_clickable (widget_t* widget, bool_t clickable);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| clickable | bool\_t | 是否可以被点击。 |
#### image\_base\_set\_image 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t image_base_set_clickable (widget_t* widget, bool_t clickable);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| clickable | bool\_t | 是否可以被点击。 |
#### image\_base\_set\_image 函数
-----------------------
* 函数功能：
> <p id="image_base_t_image_base_set_image"> 设置控件的图片名称。
> 如果需要显示文件系统中的图片，只需将图片名称换成实际的文件名，并加上"file://"前缀即可。
* 函数原型：
```
ret_t image_base_set_image (widget_t* widget, char* name);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image对象。 |
| name | char* | 图片名称，该图片必须存在于资源管理器。 |
#### image\_base\_set\_rotation 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t image_base_set_image (widget_t* widget, char* name);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | image对象。 |
| name | char* | 图片名称，该图片必须存在于资源管理器。 |
#### image\_base\_set\_rotation 函数
-----------------------
* 函数功能：
> <p id="image_base_t_image_base_set_rotation"> 设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。
* 函数原型：
```
ret_t image_base_set_rotation (widget_t* widget, float_t rotation);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| rotation | float\_t | 旋转角度(幅度)。 |
#### image\_base\_set\_scale 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t image_base_set_rotation (widget_t* widget, float_t rotation);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| rotation | float\_t | 旋转角度(幅度)。 |
#### image\_base\_set\_scale 函数
-----------------------
* 函数功能：
> <p id="image_base_t_image_base_set_scale"> 设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。
* 函数原型：
```
ret_t image_base_set_scale (widget_t* widget, float_t scale_x, float_t scale_y);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| scale\_x | float\_t | X方向缩放比例。 |
| scale\_y | float\_t | Y方向缩放比例。 |
#### image\_base\_set\_selectable 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t image_base_set_scale (widget_t* widget, float_t scale_x, float_t scale_y);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| scale\_x | float\_t | X方向缩放比例。 |
| scale\_y | float\_t | Y方向缩放比例。 |
#### image\_base\_set\_selectable 函数
-----------------------
* 函数功能：
> <p id="image_base_t_image_base_set_selectable"> 设置控件是否可以被选中。
* 函数原型：
```
ret_t image_base_set_selectable (widget_t* widget, bool_t selectable);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| selectable | bool\_t | 是否可以被选中。 |
#### image\_base\_set\_selected 函数
-----------------------
* 函数功能：
* 函数原型：
```
ret_t image_base_set_selectable (widget_t* widget, bool_t selectable);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| selectable | bool\_t | 是否可以被选中。 |
#### image\_base\_set\_selected 函数
-----------------------
* 函数功能：
> <p id="image_base_t_image_base_set_selected"> 设置控件的选中状态。
* 函数原型：
```
ret_t image_base_set_selected (widget_t* widget, bool_t selected);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| selected | bool\_t | 是否被选中。 |
#### anchor\_x 属性
-----------------------
* 函数原型：
```
ret_t image_base_set_selected (widget_t* widget, bool_t selected);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| selected | bool\_t | 是否被选中。 |
#### anchor\_x 属性
-----------------------
> <p id="image_base_t_anchor_x"> 锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### anchor\_y 属性
-----------------------
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### anchor\_y 属性
-----------------------
> <p id="image_base_t_anchor_y"> 锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### clickable 属性
-----------------------
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### clickable 属性
-----------------------
> <p id="image_base_t_clickable"> 点击时，是否触发EVT_CLICK事件。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### image 属性
-----------------------
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### image 属性
-----------------------
> <p id="image_base_t_image"> 图片的名称。
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### rotation 属性
-----------------------
* 类型：char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### rotation 属性
-----------------------
> <p id="image_base_t_rotation"> 控件的旋转角度(幅度)。
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### scale\_x 属性
-----------------------
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### scale\_x 属性
-----------------------
> <p id="image_base_t_scale_x"> 控件在X方向上的缩放比例。
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### scale\_y 属性
-----------------------
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### scale\_y 属性
-----------------------
> <p id="image_base_t_scale_y"> 控件在Y方向上的缩放比例。
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### selectable 属性
-----------------------
* 类型：float\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### selectable 属性
-----------------------
> <p id="image_base_t_selectable"> 是否设置选中状态。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### selected 属性
-----------------------
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### selected 属性
-----------------------
> <p id="image_base_t_selected"> 当前是否被选中。
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
* 类型：bool\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |

1
docs/manual/image_draw_type_t.md
View File

@ -1,7 +1,6 @@
## image\_draw\_type\_t
### 概述
图片绘制方法常量定义。
### 常量
<p id="image_draw_type_t_consts">

2
docs/manual/image_loader_stb_t.md
View File

@ -8,7 +8,6 @@
----------------------------------
### 函数
<p id="image_loader_stb_t_methods">
@ -26,7 +25,6 @@
* 函数原型：
```

5
docs/manual/image_loader_t.md
View File

@ -2,7 +2,6 @@
### 概述
图片加载接口。
----------------------------------
### 函数
<p id="image_loader_t_methods">
@ -22,7 +21,6 @@
* 函数原型：
```
@ -47,7 +45,6 @@ ret_t image_loader_load (image_loader_t* loader, const asset_info_t* asset, bitm
* 函数原型：
```
@ -71,7 +68,6 @@ ret_t image_loader_load_image (const asset_info_t* asset, bitmap_t* bitmap);
* 函数原型：
```
@ -94,7 +90,6 @@ ret_t image_loader_register (image_loader_t* loader);
* 函数原型：
```

12
docs/manual/image_manager_t.md
View File

@ -2,7 +2,6 @@
### 概述
图片管理器。负责加载，解码和缓存图片。
----------------------------------
### 函数
<p id="image_manager_t_methods">
@ -33,7 +32,6 @@
> <p id="image_manager_t_image_manager"> 获取缺省的图片管理器。
* 函数原型：
```
@ -54,7 +52,6 @@ image_manager_t* image_manager ();
* 函数原型：
```
@ -75,7 +72,6 @@ image_manager_t* image_manager_create ();
* 函数原型：
```
@ -97,7 +93,6 @@ ret_t image_manager_deinit (image_manager_t* imm);
* 函数原型：
```
@ -121,7 +116,6 @@ ret_t image_manager_destroy (image_manager_t* imm);
* 函数原型：
```
@ -145,7 +139,6 @@ ret_t image_manager_get_bitmap (image_manager_t* imm, char* name, bitmap_t* imag
* 函数原型：
```
@ -167,7 +160,6 @@ image_manager_t* image_manager_init (image_manager_t* imm);
* 函数原型：
```
@ -198,7 +190,6 @@ ret_t image_manager_set (image_manager_t* imm);
* 函数原型：
```
@ -221,7 +212,6 @@ ret_t image_manager_set_assets_manager (image_manager_t* imm, assets_manager_t*
* 函数原型：
```
@ -244,7 +234,6 @@ ret_t image_manager_unload_bitmap (image_manager_t* imm, bitmap_t* image);
* 函数原型：
```
@ -267,7 +256,6 @@ ret_t image_manager_unload_unused (image_manager_t* imm, uint32_t time_delta_s);
* 函数原型：
```

Some files were not shown because too many files have changed in this diff Show More