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 (fix issue #253)

Browse Source
This commit is contained in:
lixianjing 2019-10-16 09:02:32 +08:00
parent 2a4a9c5d3c
commit 5441513869
206 changed files with 6921 additions and 4973 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/changes.md
View File

@ -1,5 +1,8 @@
# 最新动态 # 最新动态
* 2019/10/16
* 更新文档。
* 2019/10/15 * 2019/10/15
* 增加fs\_file\_eof。 * 增加fs\_file\_eof。
* 增加tk\_iostream\_noisy。 * 增加tk\_iostream\_noisy。

3
docs/manual/arg_desc_flags_t.md
View File

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

3
docs/manual/asset_data_type_t.md
View File

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

3
docs/manual/asset_font_type_t.md
View File

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

3
docs/manual/asset_image_type_t.md
View File

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

23
docs/manual/asset_info_t.md
View File

@ -1,6 +1,7 @@
## asset\_info\_t ## asset\_info\_t
### 概述 ### 概述
单个资源的描述信息。 单个资源的描述信息。
---------------------------------- ----------------------------------
### 属性 ### 属性
@ -16,7 +17,8 @@
| <a href="#asset_info_t_type">type</a> | uint16\_t | 类型。 | | <a href="#asset_info_t_type">type</a> | uint16\_t | 类型。 |
#### is\_in\_rom 属性 #### is\_in\_rom 属性
----------------------- -----------------------
> <p id="asset_info_t_is_in_rom"> 资源是否在ROM中。 > <p id="asset_info_t_is_in_rom"> 资源是否在ROM中。
* 类型：uint8\_t * 类型：uint8\_t
@ -28,7 +30,8 @@
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### name 属性 #### name 属性
----------------------- -----------------------
> <p id="asset_info_t_name"> 名称。 > <p id="asset_info_t_name"> 名称。
* 类型：char* * 类型：char*
@ -40,8 +43,9 @@
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### refcount 属性 #### refcount 属性
----------------------- -----------------------
> <p id="asset_info_t_refcount"> 引用计数。 > <p id="asset_info_t_refcount"> 引用计数。
is\_in\_rom == FALSE时才有效。 is\_in\_rom == FALSE时才有效。
* 类型：uint32\_t * 类型：uint32\_t
@ -53,7 +57,8 @@
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### size 属性 #### size 属性
----------------------- -----------------------
> <p id="asset_info_t_size"> 大小。 > <p id="asset_info_t_size"> 大小。
* 类型：uint32\_t * 类型：uint32\_t
@ -65,7 +70,8 @@
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### subtype 属性 #### subtype 属性
----------------------- -----------------------
> <p id="asset_info_t_subtype"> 子类型。 > <p id="asset_info_t_subtype"> 子类型。
* 类型：uint8\_t * 类型：uint8\_t
@ -77,7 +83,8 @@
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### type 属性 #### type 属性
----------------------- -----------------------
> <p id="asset_info_t_type"> 类型。 > <p id="asset_info_t_type"> 类型。
* 类型：uint16\_t * 类型：uint16\_t

3
docs/manual/asset_script_type_t.md
View File

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

3
docs/manual/asset_type_t.md
View File

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

3
docs/manual/asset_ui_type_t.md
View File

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

141
docs/manual/assets_manager_t.md
View File

@ -1,35 +1,36 @@
## assets\_manager\_t ## assets\_manager\_t
### 概述 ### 概述
资源管理器。 资源管理器。
这里的资源管理器并非Windows下的文件浏览器，而是负责对各种资源，比如字体、主题、图片、界面数据、字符串和其它数据的进行集中管理的组件。引入资源管理器的目的有以下几个： 这里的资源管理器并非Windows下的文件浏览器，而是负责对各种资源，比如字体、主题、图片、界面数据、字符串和其它数据的进行集中管理的组件。引入资源管理器的目的有以下几个：
* *
让上层不需要了解存储的方式。在没有文件系统时或者内存紧缺时，把资源转成常量数组直接编译到代码中。在有文件系统而且内存充足时，资源放在文件系统中。在有网络时，资源也可以存放在服务器上(暂未实现)。资源管理器为上层提供统一的接口，让上层而不用关心底层的存储方式。 让上层不需要了解存储的方式。在没有文件系统时或者内存紧缺时，把资源转成常量数组直接编译到代码中。在有文件系统而且内存充足时，资源放在文件系统中。在有网络时，资源也可以存放在服务器上(暂未实现)。资源管理器为上层提供统一的接口，让上层而不用关心底层的存储方式。
* *
让上层不需要了解资源的具体格式。比如一个名为earth的图片，没有文件系统或内存紧缺，图片直接用位图数据格式存在ROM中，而有文件系统时，则用PNG格式存放在文件系统中。资源管理器让上层不需要关心图片的格式，访问时指定图片的名称即可(不用指定扩展名)。 让上层不需要了解资源的具体格式。比如一个名为earth的图片，没有文件系统或内存紧缺，图片直接用位图数据格式存在ROM中，而有文件系统时，则用PNG格式存放在文件系统中。资源管理器让上层不需要关心图片的格式，访问时指定图片的名称即可(不用指定扩展名)。
* *
让上层不需要了解屏幕的密度。不同的屏幕密度下需要加载不同的图片，比如MacPro的Retina屏就需要用双倍解析度的图片，否则就出现界面模糊。AWTK以后会支持PC软件和手机软件的开发，所以资源管理器需要为此提供支持，让上层不需关心屏幕的密度。 让上层不需要了解屏幕的密度。不同的屏幕密度下需要加载不同的图片，比如MacPro的Retina屏就需要用双倍解析度的图片，否则就出现界面模糊。AWTK以后会支持PC软件和手机软件的开发，所以资源管理器需要为此提供支持，让上层不需关心屏幕的密度。
* *
对资源进行内存缓存。不同类型的资源使用方式是不一样的，比如字体和主题加载之后会一直使用，UI文件在生成界面之后就暂时不需要了，PNG文件解码之后就只需要保留解码的位图数据即可。资源管理器配合图片管理器等其它组件实现资源的自动缓存。 对资源进行内存缓存。不同类型的资源使用方式是不一样的，比如字体和主题加载之后会一直使用，UI文件在生成界面之后就暂时不需要了，PNG文件解码之后就只需要保留解码的位图数据即可。资源管理器配合图片管理器等其它组件实现资源的自动缓存。
当从文件系统加载资源时，目录结构要求如下： 当从文件系统加载资源时，目录结构要求如下：
``` ```
assets/raw/ assets/raw/
fonts 字体 fonts 字体
images 图片 images 图片
x1 普通密度屏幕的图片。 x1 普通密度屏幕的图片。
x2 2倍密度屏幕的图片。 x2 2倍密度屏幕的图片。
x3 3倍密度屏幕的图片。 x3 3倍密度屏幕的图片。
xx 密度无关的图片。 xx 密度无关的图片。
strings 需要翻译的字符串。 strings 需要翻译的字符串。
styles 主题数据。 styles 主题数据。
ui UI描述数据。 ui UI描述数据。
``` ```
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -58,8 +59,9 @@
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager"> 获取缺省资源管理器。 > <p id="assets_manager_t_assets_manager"> 获取缺省资源管理器。
* 函数原型： * 函数原型：
@ -78,8 +80,9 @@ assets_manager_t* assets_manager ();
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_add"> 向资源管理器中增加一个资源。 > <p id="assets_manager_t_assets_manager_add"> 向资源管理器中增加一个资源。
* 函数原型： * 函数原型：
@ -100,8 +103,9 @@ ret_t assets_manager_add (assets_manager_t* am, asset_info_t info);
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_clear_cache"> 清除指定类型的缓存。 > <p id="assets_manager_t_assets_manager_clear_cache"> 清除指定类型的缓存。
* 函数原型： * 函数原型：
@ -122,8 +126,9 @@ ret_t assets_manager_clear_cache (assets_manager_t* am, asset_type_t type);
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_create"> 创建资源管理器。 > <p id="assets_manager_t_assets_manager_create"> 创建资源管理器。
* 函数原型： * 函数原型：
@ -143,8 +148,9 @@ assets_manager_t* assets_manager_create (uint32_t init_nr);
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_deinit"> 释放全部资源。 > <p id="assets_manager_t_assets_manager_deinit"> 释放全部资源。
* 函数原型： * 函数原型：
@ -164,8 +170,9 @@ ret_t assets_manager_deinit (assets_manager_t* am);
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_destroy"> 释放全部资源并销毁asset manager对象。 > <p id="assets_manager_t_assets_manager_destroy"> 释放全部资源并销毁asset manager对象。
* 函数原型： * 函数原型：
@ -185,8 +192,9 @@ ret_t assets_manager_destroy (assets_manager_t* am);
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_find_in_cache"> 在资源管理器的缓存中查找指定的资源(不引用)。 > <p id="assets_manager_t_assets_manager_find_in_cache"> 在资源管理器的缓存中查找指定的资源(不引用)。
* 函数原型： * 函数原型：
@ -208,8 +216,9 @@ asset_info_t* assets_manager_find_in_cache (assets_manager_t* am, asset_type_t t
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_init"> 初始化资源管理器。 > <p id="assets_manager_t_assets_manager_init"> 初始化资源管理器。
* 函数原型： * 函数原型：
@ -230,8 +239,9 @@ assets_manager_t* assets_manager_init (assets_manager_t* am, uint32_t init_nr);
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_load"> 从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH\_FS\_RES时才生效。 > <p id="assets_manager_t_assets_manager_load"> 从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH\_FS\_RES时才生效。
* 函数原型： * 函数原型：
@ -253,8 +263,9 @@ asset_info_t* assets_manager_load (assets_manager_t* am, asset_type_t type, char
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_preload"> 从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH\_FS\_RES时才生效。 > <p id="assets_manager_t_assets_manager_preload"> 从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH\_FS\_RES时才生效。
* 函数原型： * 函数原型：
@ -276,8 +287,9 @@ ret_t assets_manager_preload (assets_manager_t* am, asset_type_t type, char* nam
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_ref"> 在资源管理器的缓存中查找指定的资源并引用它，如果缓存中不存在，尝试加载该资源。 > <p id="assets_manager_t_assets_manager_ref"> 在资源管理器的缓存中查找指定的资源并引用它，如果缓存中不存在，尝试加载该资源。
* 函数原型： * 函数原型：
@ -299,8 +311,9 @@ asset_info_t* assets_manager_ref (assets_manager_t* am, asset_type_t type, char*
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_set"> 设置缺省资源管理器。 > <p id="assets_manager_t_assets_manager_set"> 设置缺省资源管理器。
* 函数原型： * 函数原型：
@ -320,8 +333,9 @@ ret_t assets_manager_set (assets_manager_t* am);
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_set_locale_info"> 设置locale_info对象。 > <p id="assets_manager_t_assets_manager_set_locale_info"> 设置locale_info对象。
* 函数原型： * 函数原型：
@ -342,8 +356,9 @@ ret_t assets_manager_set_locale_info (assets_manager_t* am, locale_info_t* local
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_set_res_root"> 设置资源所在的目录(其下目录结构请参考demos)。 > <p id="assets_manager_t_assets_manager_set_res_root"> 设置资源所在的目录(其下目录结构请参考demos)。
* 函数原型： * 函数原型：
@ -364,8 +379,9 @@ ret_t assets_manager_set_res_root (assets_manager_t* am, const char* res_root);
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_set_system_info"> 设置system_info对象。 > <p id="assets_manager_t_assets_manager_set_system_info"> 设置system_info对象。
* 函数原型： * 函数原型：
@ -386,8 +402,9 @@ ret_t assets_manager_set_system_info (assets_manager_t* am, system_info_t* syste
* 函数功能： * 函数功能：
> <p id="assets_manager_t_assets_manager_unref"> 释放指定的资源。 > <p id="assets_manager_t_assets_manager_unref"> 释放指定的资源。
* 函数原型： * 函数原型：

3
docs/manual/bitmap_flag_t.md
View File

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

3
docs/manual/bitmap_format_t.md
View File

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

67
docs/manual/bitmap_t.md
View File

@ -1,6 +1,7 @@
## bitmap\_t ## bitmap\_t
### 概述 ### 概述
位图。 位图。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -34,7 +35,8 @@
* 函数功能： * 函数功能：
> <p id="bitmap_t_bitmap_create"> 创建图片对象(一般供脚本语言中使用)。 > <p id="bitmap_t_bitmap_create"> 创建图片对象(一般供脚本语言中使用)。
* 函数原型： * 函数原型：
@ -53,8 +55,9 @@ bitmap_t* bitmap_create ();
* 函数功能： * 函数功能：
> <p id="bitmap_t_bitmap_create_ex"> 创建图片对象。 > <p id="bitmap_t_bitmap_create_ex"> 创建图片对象。
* 函数原型： * 函数原型：
@ -77,7 +80,8 @@ bitmap_t* bitmap_create_ex (uint32_t w, uint32_t h, uint32_t line_length, bitmap
* 函数功能： * 函数功能：
> <p id="bitmap_t_bitmap_destroy"> 销毁图片。 > <p id="bitmap_t_bitmap_destroy"> 销毁图片。
* 函数原型： * 函数原型：
@ -97,8 +101,9 @@ ret_t bitmap_destroy (bitmap_t* bitmap);
* 函数功能： * 函数功能：
> <p id="bitmap_t_bitmap_get_bpp"> 获取图片一个像素占用的字节数。 > <p id="bitmap_t_bitmap_get_bpp"> 获取图片一个像素占用的字节数。
* 函数原型： * 函数原型：
@ -118,8 +123,9 @@ uint32_t bitmap_get_bpp (bitmap_t* bitmap);
* 函数功能： * 函数功能：
> <p id="bitmap_t_bitmap_get_line_length"> 获取每一行占用内存的字节数。 > <p id="bitmap_t_bitmap_get_line_length"> 获取每一行占用内存的字节数。
* 函数原型： * 函数原型：
@ -139,8 +145,9 @@ ret_t bitmap_get_line_length (bitmap_t* bitmap);
* 函数功能： * 函数功能：
> <p id="bitmap_t_bitmap_get_pixel"> 获取图片指定像素的rgba颜色值(主要用于测试程序)。 > <p id="bitmap_t_bitmap_get_pixel"> 获取图片指定像素的rgba颜色值(主要用于测试程序)。
* 函数原型： * 函数原型：
@ -163,8 +170,9 @@ ret_t bitmap_get_pixel (bitmap_t* bitmap, uint32_t x, uint32_t y, rgba_t* rgba);
* 函数功能： * 函数功能：
> <p id="bitmap_t_bitmap_init"> 初始化图片。 > <p id="bitmap_t_bitmap_init"> 初始化图片。
* 函数原型： * 函数原型：
@ -188,9 +196,10 @@ ret_t bitmap_init (bitmap_t* bitmap, uint32_t w, uint32_t h, bitmap_format_t for
* 函数功能： * 函数功能：
> <p id="bitmap_t_bitmap_init_from_rgba"> 初始化图片。 > <p id="bitmap_t_bitmap_init_from_rgba"> 初始化图片。
数据。3通道时为RGB888格式，4通道时为RGBA888格式(内部拷贝该数据，不会引用，调用者自行释放)。 数据。3通道时为RGB888格式，4通道时为RGBA888格式(内部拷贝该数据，不会引用，调用者自行释放)。
* 函数原型： * 函数原型：
@ -215,8 +224,9 @@ ret_t bitmap_init_from_rgba (bitmap_t* bitmap, uint32_t w, uint32_t h, bitmap_fo
* 函数功能： * 函数功能：
> <p id="bitmap_t_bitmap_set_line_length"> 设置line_length。 > <p id="bitmap_t_bitmap_set_line_length"> 设置line_length。
* 函数原型： * 函数原型：
@ -234,7 +244,8 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
| line\_length | uint32\_t | line\_length。 | | line\_length | uint32\_t | line\_length。 |
#### data 属性 #### data 属性
----------------------- -----------------------
> <p id="bitmap_t_data"> 图片数据。 > <p id="bitmap_t_data"> 图片数据。
* 类型：uint8\_t* * 类型：uint8\_t*
@ -245,7 +256,8 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### flags 属性 #### flags 属性
----------------------- -----------------------
> <p id="bitmap_t_flags"> 标志。请参考{bitmap_flag_t}。 > <p id="bitmap_t_flags"> 标志。请参考{bitmap_flag_t}。
* 类型：uint16\_t * 类型：uint16\_t
@ -257,7 +269,8 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### format 属性 #### format 属性
----------------------- -----------------------
> <p id="bitmap_t_format"> 格式。请参考{bitmap_format_t}。 > <p id="bitmap_t_format"> 格式。请参考{bitmap_format_t}。
* 类型：uint16\_t * 类型：uint16\_t
@ -269,7 +282,8 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### h 属性 #### h 属性
----------------------- -----------------------
> <p id="bitmap_t_h"> 高度。 > <p id="bitmap_t_h"> 高度。
* 类型：wh\_t * 类型：wh\_t
@ -281,7 +295,8 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### line\_length 属性 #### line\_length 属性
----------------------- -----------------------
> <p id="bitmap_t_line_length"> 每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。 > <p id="bitmap_t_line_length"> 每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。
* 类型：uint32\_t * 类型：uint32\_t
@ -293,7 +308,8 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### name 属性 #### name 属性
----------------------- -----------------------
> <p id="bitmap_t_name"> 名称。 > <p id="bitmap_t_name"> 名称。
* 类型：const char* * 类型：const char*
@ -305,7 +321,8 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### w 属性 #### w 属性
----------------------- -----------------------
> <p id="bitmap_t_w"> 宽度。 > <p id="bitmap_t_w"> 宽度。
* 类型：wh\_t * 类型：wh\_t

27
docs/manual/children_layouter_default_t.md
View File

@ -2,12 +2,13 @@
### 概述 ### 概述
![image](images/children_layouter_default_t_0.png) ![image](images/children_layouter_default_t_0.png)
缺省的子控件布局算法实现。 缺省的子控件布局算法实现。
> 用法请参考：[缺省子控件布局算法]( > 用法请参考：[缺省子控件布局算法](
https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_default.md) https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_default.md)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -22,10 +23,11 @@ https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_default.md)
* 函数功能： * 函数功能：
> <p id="children_layouter_default_t_children_layouter_default_create"> > <p id="children_layouter_default_t_children_layouter_default_create">
创建子控件布局对象。 创建子控件布局对象。
* 函数原型： * 函数原型：
@ -44,8 +46,9 @@ children_layouter_t* children_layouter_default_create ();
* 函数功能： * 函数功能：
> <p id="children_layouter_default_t_self_layouter_register_builtins"> 注册内置的控件自身布局算法。 > <p id="children_layouter_default_t_self_layouter_register_builtins"> 注册内置的控件自身布局算法。
* 函数原型： * 函数原型：

33
docs/manual/children_layouter_factory_t.md
View File

@ -1,7 +1,8 @@
## children\_layouter\_factory\_t ## children\_layouter\_factory\_t
### 概述 ### 概述
子控件布局算法工厂。 子控件布局算法工厂。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -20,7 +21,8 @@
* 函数功能： * 函数功能：
> <p id="children_layouter_factory_t_children_layouter_factory"> 获取缺省的子控件布局算法工厂对象。 > <p id="children_layouter_factory_t_children_layouter_factory"> 获取缺省的子控件布局算法工厂对象。
* 函数原型： * 函数原型：
@ -39,8 +41,9 @@ children_layouter_factory_t* children_layouter_factory ();
* 函数功能： * 函数功能：
> <p id="children_layouter_factory_t_children_layouter_factory_create"> 创建子控件布局算法工厂对象。 > <p id="children_layouter_factory_t_children_layouter_factory_create"> 创建子控件布局算法工厂对象。
* 函数原型： * 函数原型：
@ -59,8 +62,9 @@ children_layouter_factory_t* children_layouter_factory_create ();
* 函数功能： * 函数功能：
> <p id="children_layouter_factory_t_children_layouter_factory_create_layouter"> 创建指定类型的子控件布局算法对象。 > <p id="children_layouter_factory_t_children_layouter_factory_create_layouter"> 创建指定类型的子控件布局算法对象。
* 函数原型： * 函数原型：
@ -81,8 +85,9 @@ children_layouter_t* children_layouter_factory_create_layouter (children_layoute
* 函数功能： * 函数功能：
> <p id="children_layouter_factory_t_children_layouter_factory_destroy"> 析构并释放子控件布局算法工厂对象。 > <p id="children_layouter_factory_t_children_layouter_factory_destroy"> 析构并释放子控件布局算法工厂对象。
* 函数原型： * 函数原型：
@ -102,8 +107,9 @@ ret_t children_layouter_factory_destroy (children_layouter_factory_t* factory);
* 函数功能： * 函数功能：
> <p id="children_layouter_factory_t_children_layouter_factory_register"> 注册子控件布局算法创建函数。 > <p id="children_layouter_factory_t_children_layouter_factory_register"> 注册子控件布局算法创建函数。
* 函数原型： * 函数原型：
@ -125,8 +131,9 @@ ret_t children_layouter_factory_register (children_layouter_factory_t* factory,
* 函数功能： * 函数功能：
> <p id="children_layouter_factory_t_children_layouter_factory_set"> 设置缺省的子控件布局算法工厂对象。 > <p id="children_layouter_factory_t_children_layouter_factory_set"> 设置缺省的子控件布局算法工厂对象。
* 函数原型： * 函数原型：

22
docs/manual/children_layouter_list_view_t.md
View File

@ -2,12 +2,13 @@
### 概述 ### 概述
![image](images/children_layouter_list_view_t_0.png) ![image](images/children_layouter_list_view_t_0.png)
listview的子控件布局算法实现。 listview的子控件布局算法实现。
> 用法请参考：[listview子控件布局算法]( > 用法请参考：[listview子控件布局算法](
https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_list_view.md) https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_list_view.md)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -21,10 +22,11 @@ https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_list_view.md)
* 函数功能： * 函数功能：
> <p id="children_layouter_list_view_t_children_layouter_list_view_create"> > <p id="children_layouter_list_view_t_children_layouter_list_view_create">
创建子控件布局对象。 创建子控件布局对象。
* 函数原型： * 函数原型：

75
docs/manual/children_layouter_t.md
View File

@ -1,9 +1,10 @@
## children\_layouter\_t ## children\_layouter\_t
### 概述 ### 概述
子控件排版布局器的接口。 子控件排版布局器的接口。
按特定算法对子控件进行排版布局，子类需要实现vtable中的函数。 按特定算法对子控件进行排版布局，子类需要实现vtable中的函数。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -26,8 +27,9 @@
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_create"> 创建layouter对象。 > <p id="children_layouter_t_children_layouter_create"> 创建layouter对象。
* 函数原型： * 函数原型：
@ -47,9 +49,10 @@ children_layouter_t* children_layouter_create (const char* params);
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_destroy"> 销毁layouter对象。 > <p id="children_layouter_t_children_layouter_destroy"> 销毁layouter对象。
* 函数原型： * 函数原型：
@ -69,9 +72,10 @@ ret_t children_layouter_destroy (children_layouter_t* layouter);
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_get_param"> 获取指定的参数。 > <p id="children_layouter_t_children_layouter_get_param"> 获取指定的参数。
* 函数原型： * 函数原型：
@ -93,9 +97,10 @@ ret_t children_layouter_get_param (children_layouter_t* layouter, const char* na
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_get_param_float"> 获取指定的浮点格式的参数。 > <p id="children_layouter_t_children_layouter_get_param_float"> 获取指定的浮点格式的参数。
* 函数原型： * 函数原型：
@ -117,9 +122,10 @@ ret_t children_layouter_get_param_float (children_layouter_t* layouter, const ch
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_get_param_int"> 获取指定的整数格式的参数。 > <p id="children_layouter_t_children_layouter_get_param_int"> 获取指定的整数格式的参数。
* 函数原型： * 函数原型：
@ -141,9 +147,10 @@ ret_t children_layouter_get_param_int (children_layouter_t* layouter, const char
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_is_valid"> 判断layouter对象是否有效。 > <p id="children_layouter_t_children_layouter_is_valid"> 判断layouter对象是否有效。
* 函数原型： * 函数原型：
@ -163,9 +170,10 @@ bool_t children_layouter_is_valid (children_layouter_t* layouter);
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_layout"> 对控件的子控件进行布局。 > <p id="children_layouter_t_children_layouter_layout"> 对控件的子控件进行布局。
* 函数原型： * 函数原型：
@ -186,9 +194,10 @@ ret_t children_layouter_layout (children_layouter_t* layouter, widget_t* widget)
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_set_param"> 获取指定的参数。 > <p id="children_layouter_t_children_layouter_set_param"> 获取指定的参数。
* 函数原型： * 函数原型：
@ -210,9 +219,10 @@ ret_t children_layouter_set_param (children_layouter_t* layouter, const char* na
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_set_param_str"> 设置字符串格式的参数。 > <p id="children_layouter_t_children_layouter_set_param_str"> 设置字符串格式的参数。
* 函数原型： * 函数原型：
@ -234,8 +244,9 @@ ret_t children_layouter_set_param_str (children_layouter_t* layouter, const char
* 函数功能： * 函数功能：
> <p id="children_layouter_t_children_layouter_to_string"> 获取全部参数。 > <p id="children_layouter_t_children_layouter_to_string"> 获取全部参数。
* 函数原型： * 函数原型：

3
docs/manual/clip_board_data_type_t.md
View File

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

43
docs/manual/clip_board_t.md
View File

@ -1,6 +1,7 @@
## clip\_board\_t ## clip\_board\_t
### 概述 ### 概述
剪切板接口。 剪切板接口。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -21,8 +22,9 @@
* 函数功能： * 函数功能：
> <p id="clip_board_t_clip_board"> 获取缺省的剪切板对象。 > <p id="clip_board_t_clip_board"> 获取缺省的剪切板对象。
* 函数原型： * 函数原型：
@ -41,8 +43,9 @@ ret_t clip_board ();
* 函数功能： * 函数功能：
> <p id="clip_board_t_clip_board_clear"> 清空剪切板中的数据。 > <p id="clip_board_t_clip_board_clear"> 清空剪切板中的数据。
* 函数原型： * 函数原型：
@ -62,8 +65,9 @@ ret_t clip_board_clear (clip_board_t* cl);
* 函数功能： * 函数功能：
> <p id="clip_board_t_clip_board_destroy"> 销毁剪切板对象。 > <p id="clip_board_t_clip_board_destroy"> 销毁剪切板对象。
* 函数原型： * 函数原型：
@ -83,8 +87,9 @@ ret_t clip_board_destroy (clip_board_t* cl);
* 函数功能： * 函数功能：
> <p id="clip_board_t_clip_board_get_data"> 从剪切板中获取数据。 > <p id="clip_board_t_clip_board_get_data"> 从剪切板中获取数据。
* 函数原型： * 函数原型：
@ -107,8 +112,9 @@ ret_t clip_board_get_data (clip_board_t* cl, clip_board_data_type_t* type, void*
* 函数功能： * 函数功能：
> <p id="clip_board_t_clip_board_get_text"> 从剪切板中获取文本(UTF8)数据。 > <p id="clip_board_t_clip_board_get_text"> 从剪切板中获取文本(UTF8)数据。
* 函数原型： * 函数原型：
@ -127,8 +133,9 @@ const char* clip_board_get_text ();
* 函数功能： * 函数功能：
> <p id="clip_board_t_clip_board_set"> 设置缺省的剪切板对象。 > <p id="clip_board_t_clip_board_set"> 设置缺省的剪切板对象。
* 函数原型： * 函数原型：
@ -148,8 +155,9 @@ ret_t clip_board_set (clip_board_t* cl);
* 函数功能： * 函数功能：
> <p id="clip_board_t_clip_board_set_data"> 设置数据到剪切板中。 > <p id="clip_board_t_clip_board_set_data"> 设置数据到剪切板中。
* 函数原型： * 函数原型：
@ -172,8 +180,9 @@ ret_t clip_board_set_data (clip_board_t* cl, clip_board_data_type_t type, const
* 函数功能： * 函数功能：
> <p id="clip_board_t_clip_board_set_text"> 设置文本(UTF8)数据到剪切板。 > <p id="clip_board_t_clip_board_set_text"> 设置文本(UTF8)数据到剪切板。
* 函数原型： * 函数原型：

46
docs/manual/color_parser_t.md
View File

@ -1,17 +1,18 @@
## color\_parser\_t ## color\_parser\_t
### 概述 ### 概述
颜色解析相关函数。 颜色解析相关函数。
示例： 示例：
```c ```c
color_t c; color_t c;
c = color_parse("#112233"); c = color_parse("#112233");
c = color_parse("white"); c = color_parse("white");
c = color_parse("rgb(11,22,33)"); c = color_parse("rgb(11,22,33)");
c = color_parse("rgba(11,22,33,0.5)"); c = color_parse("rgba(11,22,33,0.5)");
``` ```
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -25,16 +26,17 @@
* 函数功能： * 函数功能：
> <p id="color_parser_t_color_parse"> 把字符串格式的颜色转换成color\_t对象。 > <p id="color_parser_t_color_parse"> 把字符串格式的颜色转换成color\_t对象。
目前支持下列格式： 目前支持下列格式：
* 16进制格式。如："#112233" * 16进制格式。如："#112233"
* 颜色名称格式。如："green" * 颜色名称格式。如："green"
* rgb格式。如："rgb(11,22,33)" * rgb格式。如："rgb(11,22,33)"
* rgba格式。如："rgba(11,22,33,0.5)" * rgba格式。如："rgba(11,22,33,0.5)"
* 函数原型： * 函数原型：

118
docs/manual/color_t.md
View File

@ -1,7 +1,8 @@
## color\_t ## color\_t
### 概述 ### 概述
颜色。 颜色。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -30,13 +31,14 @@
* 函数功能： * 函数功能：
> <p id="color_t_color_a"> > <p id="color_t_color_a">
获取alpha通道的值。 获取alpha通道的值。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -56,13 +58,14 @@ uint8_t color_a (color_t* c);
* 函数功能： * 函数功能：
> <p id="color_t_color_b"> > <p id="color_t_color_b">
获取蓝色通道的值。 获取蓝色通道的值。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -82,10 +85,11 @@ uint8_t color_b (color_t* c);
* 函数功能： * 函数功能：
> <p id="color_t_color_cast"> 转换为color对象。 > <p id="color_t_color_cast"> 转换为color对象。
> 供脚本语言使用。 > 供脚本语言使用。
* 函数原型： * 函数原型：
@ -105,11 +109,12 @@ color_t* color_cast (color_t* color);
* 函数功能： * 函数功能：
> <p id="color_t_color_create"> 创建color对象。 > <p id="color_t_color_create"> 创建color对象。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -132,11 +137,12 @@ color_t* color_create (uint8_t r, uint8_t b, uint8_t g, uint8_t a);
* 函数功能： * 函数功能：
> <p id="color_t_color_destroy"> > <p id="color_t_color_destroy">
销毁color对象。 销毁color对象。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -156,11 +162,12 @@ ret_t color_destroy (color_t* c);
* 函数功能： * 函数功能：
> <p id="color_t_color_from_str"> 创建color对象。 > <p id="color_t_color_from_str"> 创建color对象。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -181,13 +188,14 @@ color_t* color_from_str (color_t* c, const char* str);
* 函数功能： * 函数功能：
> <p id="color_t_color_g"> > <p id="color_t_color_g">
获取绿色通道的值。 获取绿色通道的值。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -207,8 +215,9 @@ uint8_t color_g (color_t* c);
* 函数功能： * 函数功能：
> <p id="color_t_color_init"> 初始化颜色对象。 > <p id="color_t_color_init"> 初始化颜色对象。
* 函数原型： * 函数原型：
@ -231,13 +240,14 @@ color_t color_init (uint8_t r, uint8_t g, uint8_t b, uint8_t a);
* 函数功能： * 函数功能：
> <p id="color_t_color_r"> > <p id="color_t_color_r">
获取红色通道的值。 获取红色通道的值。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -254,7 +264,8 @@ uint8_t color_r (color_t* c);
| c | color\_t* | color对象。 | | c | color\_t* | color对象。 |
#### color 属性 #### color 属性
----------------------- -----------------------
> <p id="color_t_color"> 颜色的数值。 > <p id="color_t_color"> 颜色的数值。
* 类型：uint32\_t * 类型：uint32\_t
@ -266,7 +277,8 @@ uint8_t color_r (color_t* c);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### rgba 属性 #### rgba 属性
----------------------- -----------------------
> <p id="color_t_rgba"> 颜色的RGBA值。 > <p id="color_t_rgba"> 颜色的RGBA值。
* 类型：rgba\_t * 类型：rgba\_t

10
docs/manual/combo_box_ex_t.md
View File

@ -2,8 +2,9 @@
### 概述 ### 概述
![image](images/combo_box_ex_t_0.png) ![image](images/combo_box_ex_t_0.png)
可滚动的combo_box控件。 可滚动的combo_box控件。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -17,8 +18,9 @@
* 函数功能： * 函数功能：
> <p id="combo_box_ex_t_combo_box_ex_create"> 创建combo_box_ex对象 > <p id="combo_box_ex_t_combo_box_ex_create"> 创建combo_box_ex对象
* 函数原型： * 函数原型：

97
docs/manual/compressor_t.md Normal file
View File

@ -0,0 +1,97 @@
## compressor\_t
### 概述
compressor interface
----------------------------------
### 函数
<p id="compressor_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#compressor_t_compressor_compress">compressor\_compress</a> | |
| <a href="#compressor_t_compressor_destroy">compressor\_destroy</a> | |
| <a href="#compressor_t_compressor_uncompress">compressor\_uncompress</a> | |
#### compressor\_compress 函数
-----------------------
* 函数功能：
> <p id="compressor_t_compressor_compress">
压缩数据。
* 函数原型：
```
ret_t compressor_compress (compressor_t* compressor, const void* data, uint32_t size, wbuffer_t* out);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| compressor | compressor\_t* | compressor对象。 |
| data | const void* | 待压缩的数据。 |
| size | uint32\_t | 数据长度。 |
| out | wbuffer\_t* | 压缩之后的数据。 |
#### compressor\_destroy 函数
-----------------------
* 函数功能：
> <p id="compressor_t_compressor_destroy">
销毁compressor对象。
* 函数原型：
```
ret_t compressor_destroy (compressor_t* compressor);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| compressor | compressor\_t* | compressor对象。 |
#### compressor\_uncompress 函数
-----------------------
* 函数功能：
> <p id="compressor_t_compressor_uncompress">
解压数据。
* 函数原型：
```
ret_t compressor_uncompress (compressor_t* compressor, const void* data, uint32_t size, wbuffer_t* out);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| compressor | compressor\_t* | compressor对象。 |
| data | const void* | 待解压的数据。 |
| size | uint32\_t | 数据长度。 |
| out | wbuffer\_t* | 解压之后的数据。 |

138
docs/manual/darray_t.md
View File

@ -1,24 +1,25 @@
## darray\_t ## darray\_t
### 概述 ### 概述
动态数组，根据元素个数动态调整数组的容量。 动态数组，根据元素个数动态调整数组的容量。
用darray\_init初始化时，用darray\_deinit释放。如： 用darray\_init初始化时，用darray\_deinit释放。如：
```c ```c
darray_t darray; darray_t darray;
darray_init(&darray, 10, destroy, compare); darray_init(&darray, 10, destroy, compare);
... ...
darray_deinit(&darray); darray_deinit(&darray);
``` ```
用darray\_create创建时，用darray\_destroy销毁。如： 用darray\_create创建时，用darray\_destroy销毁。如：
```c ```c
darray_t* darray = darray_create(10, destroy, compare); darray_t* darray = darray_create(10, destroy, compare);
... ...
darray_destroy(darray); darray_destroy(darray);
``` ```
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -57,8 +58,9 @@
* 函数功能： * 函数功能：
> <p id="darray_t_darray_clear"> 清除全部元素。 > <p id="darray_t_darray_clear"> 清除全部元素。
* 函数原型： * 函数原型：
@ -78,8 +80,9 @@ ret_t darray_clear (darray_t* darray);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_count"> 返回满足条件元素的个数。 > <p id="darray_t_darray_count"> 返回满足条件元素的个数。
* 函数原型： * 函数原型：
@ -100,9 +103,10 @@ int32_t darray_count (darray_t* darray, void* ctx);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_create"> 创建darray对象。 > <p id="darray_t_darray_create"> 创建darray对象。
* 函数原型： * 函数原型：
@ -124,8 +128,9 @@ darray_t* darray_create (uint32_t capacity, tk_destroy_t destroy, tk_compare_t c
* 函数功能： * 函数功能：
> <p id="darray_t_darray_deinit"> 清除全部元素，并释放elms。 > <p id="darray_t_darray_deinit"> 清除全部元素，并释放elms。
* 函数原型： * 函数原型：
@ -145,8 +150,9 @@ ret_t darray_deinit (darray_t* darray);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_destroy"> 销毁darray对象。 > <p id="darray_t_darray_destroy"> 销毁darray对象。
* 函数原型： * 函数原型：
@ -166,8 +172,9 @@ ret_t darray_destroy (darray_t* darray);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_find"> 查找第一个满足条件的元素。 > <p id="darray_t_darray_find"> 查找第一个满足条件的元素。
* 函数原型： * 函数原型：
@ -188,8 +195,9 @@ void* darray_find (darray_t* darray, void* ctx);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_find_index"> 查找第一个满足条件的元素，并返回位置。 > <p id="darray_t_darray_find_index"> 查找第一个满足条件的元素，并返回位置。
* 函数原型： * 函数原型：
@ -210,8 +218,9 @@ int darray_find_index (darray_t* darray, void* ctx);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_foreach"> 遍历元素。 > <p id="darray_t_darray_foreach"> 遍历元素。
* 函数原型： * 函数原型：
@ -233,8 +242,9 @@ ret_t darray_foreach (darray_t* darray, tk_visit_t visit, void* ctx);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_head"> 返回第一个元素。 > <p id="darray_t_darray_head"> 返回第一个元素。
* 函数原型： * 函数原型：
@ -254,9 +264,10 @@ void* darray_head (darray_t* darray);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_init"> 初始化darray对象。 > <p id="darray_t_darray_init"> 初始化darray对象。
* 函数原型： * 函数原型：
@ -279,8 +290,9 @@ darray_t* darray_init (darray_t* darray, uint32_t* capacity, tk_destroy_t destro
* 函数功能： * 函数功能：
> <p id="darray_t_darray_pop"> 弹出最后一个元素。 > <p id="darray_t_darray_pop"> 弹出最后一个元素。
* 函数原型： * 函数原型：
@ -300,8 +312,9 @@ void* darray_pop (darray_t* darray);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_push"> 在尾巴追加一个元素。 > <p id="darray_t_darray_push"> 在尾巴追加一个元素。
* 函数原型： * 函数原型：
@ -322,8 +335,9 @@ ret_t darray_push (darray_t* darray, void* data);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_remove"> 删除第一个满足条件的元素。 > <p id="darray_t_darray_remove"> 删除第一个满足条件的元素。
* 函数原型： * 函数原型：
@ -344,8 +358,9 @@ ret_t darray_remove (darray_t* darray, void* ctx);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_remove_all"> 删除全部满足条件的元素。 > <p id="darray_t_darray_remove_all"> 删除全部满足条件的元素。
* 函数原型： * 函数原型：
@ -366,8 +381,9 @@ ret_t darray_remove_all (darray_t* darray, void* ctx);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_remove_index"> 删除指定位置的元素。 > <p id="darray_t_darray_remove_index"> 删除指定位置的元素。
* 函数原型： * 函数原型：
@ -388,8 +404,9 @@ ret_t darray_remove_index (darray_t* darray, uint32_t index);
* 函数功能： * 函数功能：
> <p id="darray_t_darray_tail"> 返回最后一个元素。 > <p id="darray_t_darray_tail"> 返回最后一个元素。
* 函数原型： * 函数原型：
@ -406,7 +423,8 @@ void* darray_tail (darray_t* darray);
| darray | darray\_t* | 数组对象。 | | darray | darray\_t* | 数组对象。 |
#### capacity 属性 #### capacity 属性
----------------------- -----------------------
> <p id="darray_t_capacity"> 数组的容量大小。 > <p id="darray_t_capacity"> 数组的容量大小。
* 类型：uint32\_t * 类型：uint32\_t
@ -417,7 +435,8 @@ void* darray_tail (darray_t* darray);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### compare 属性 #### compare 属性
----------------------- -----------------------
> <p id="darray_t_compare"> 元素比较函数。 > <p id="darray_t_compare"> 元素比较函数。
* 类型：tk\_compare\_t * 类型：tk\_compare\_t
@ -428,7 +447,8 @@ void* darray_tail (darray_t* darray);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### destroy 属性 #### destroy 属性
----------------------- -----------------------
> <p id="darray_t_destroy"> 元素销毁函数。 > <p id="darray_t_destroy"> 元素销毁函数。
* 类型：tk\_destroy\_t * 类型：tk\_destroy\_t
@ -439,7 +459,8 @@ void* darray_tail (darray_t* darray);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### elms 属性 #### elms 属性
----------------------- -----------------------
> <p id="darray_t_elms"> 数组中的元素。 > <p id="darray_t_elms"> 数组中的元素。
* 类型：void** * 类型：void**
@ -450,7 +471,8 @@ void* darray_tail (darray_t* darray);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### size 属性 #### size 属性
----------------------- -----------------------
> <p id="darray_t_size"> 数组中元素的个数。 > <p id="darray_t_size"> 数组中元素的个数。
* 类型：uint32\_t * 类型：uint32\_t

58
docs/manual/date_time_t.md
View File

@ -1,9 +1,10 @@
## date\_time\_t ## date\_time\_t
### 概述 ### 概述
日期时间。 日期时间。
> 在嵌入式平台中，在系统初始时，需要调用date\_time\_set\_impl设置实际获取系统时间的函数。 > 在嵌入式平台中，在系统初始时，需要调用date\_time\_set\_impl设置实际获取系统时间的函数。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -32,8 +33,9 @@
* 函数功能： * 函数功能：
> <p id="date_time_t_date_time_create"> 创建date_time对象，并初始为当前日期和时间(一般供脚本语言中使用)。 > <p id="date_time_t_date_time_create"> 创建date_time对象，并初始为当前日期和时间(一般供脚本语言中使用)。
* 函数原型： * 函数原型：
@ -52,9 +54,10 @@ date_time_t* date_time_create ();
* 函数功能： * 函数功能：
> <p id="date_time_t_date_time_destroy"> 销毁date_time对象(一般供脚本语言中使用)。 > <p id="date_time_t_date_time_destroy"> 销毁date_time对象(一般供脚本语言中使用)。
* 函数原型： * 函数原型：
@ -74,8 +77,9 @@ ret_t date_time_destroy (date_time_t* dt);
* 函数功能： * 函数功能：
> <p id="date_time_t_date_time_init"> 初始为当前日期和时间。 > <p id="date_time_t_date_time_init"> 初始为当前日期和时间。
* 函数原型： * 函数原型：
@ -95,11 +99,12 @@ date_time_t* date_time_init (date_time_t* dt);
* 函数功能： * 函数功能：
> <p id="date_time_t_date_time_set_impl"> 设置获取当前日期和时间的函数。 > <p id="date_time_t_date_time_set_impl"> 设置获取当前日期和时间的函数。
> 嵌入式平台需要提供并设置获取当前日期和时间的函数，否则相关的功能(如时钟控件)将无法正常工作。 > 嵌入式平台需要提供并设置获取当前日期和时间的函数，否则相关的功能(如时钟控件)将无法正常工作。
* 函数原型： * 函数原型：
@ -116,7 +121,8 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
| date\_time\_get\_now | date\_time\_get\_now\_t | 获取当前日期和时间的函数。 | | date\_time\_get\_now | date\_time\_get\_now\_t | 获取当前日期和时间的函数。 |
#### day 属性 #### day 属性
----------------------- -----------------------
> <p id="date_time_t_day"> 日(1-31)。 > <p id="date_time_t_day"> 日(1-31)。
* 类型：int32\_t * 类型：int32\_t
@ -128,7 +134,8 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### hour 属性 #### hour 属性
----------------------- -----------------------
> <p id="date_time_t_hour"> 时(0 - 23)。 > <p id="date_time_t_hour"> 时(0 - 23)。
* 类型：int32\_t * 类型：int32\_t
@ -140,7 +147,8 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### minute 属性 #### minute 属性
----------------------- -----------------------
> <p id="date_time_t_minute"> 分(0 - 59)。 > <p id="date_time_t_minute"> 分(0 - 59)。
* 类型：int32\_t * 类型：int32\_t
@ -152,7 +160,8 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### month 属性 #### month 属性
----------------------- -----------------------
> <p id="date_time_t_month"> 月(1-12)。 > <p id="date_time_t_month"> 月(1-12)。
* 类型：int32\_t * 类型：int32\_t
@ -164,7 +173,8 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### second 属性 #### second 属性
----------------------- -----------------------
> <p id="date_time_t_second"> 秒(0 - 59)。 > <p id="date_time_t_second"> 秒(0 - 59)。
* 类型：int32\_t * 类型：int32\_t
@ -176,7 +186,8 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### wday 属性 #### wday 属性
----------------------- -----------------------
> <p id="date_time_t_wday"> 星期几(0-6, Sunday = 0)。 > <p id="date_time_t_wday"> 星期几(0-6, Sunday = 0)。
* 类型：int32\_t * 类型：int32\_t
@ -188,7 +199,8 @@ ret_t date_time_set_impl (date_time_get_now_t date_time_get_now);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### year 属性 #### year 属性
----------------------- -----------------------
> <p id="date_time_t_year"> 年。 > <p id="date_time_t_year"> 年。
* 类型：int32\_t * 类型：int32\_t

22
docs/manual/dialog_highlighter_default_t.md
View File

@ -1,10 +1,11 @@
## dialog\_highlighter\_default\_t ## dialog\_highlighter\_default\_t
### 概述 ### 概述
缺省对话框高亮策略。 缺省对话框高亮策略。
>本策略在背景上画一层半透明的蒙版来高亮(突出)对话框本身。 >本策略在背景上画一层半透明的蒙版来高亮(突出)对话框本身。
>对于性能不高的平台，建议将start\_alpha和end\_alpha设为相同。 >对于性能不高的平台，建议将start\_alpha和end\_alpha设为相同。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -25,8 +26,9 @@
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_default_t_dialog_highlighter_default_create"> 创建缺省的对话框高亮策略。 > <p id="dialog_highlighter_default_t_dialog_highlighter_default_create"> 创建缺省的对话框高亮策略。
* 函数原型： * 函数原型：
@ -43,14 +45,16 @@ dialog_highlighter_t* dialog_highlighter_default_create (object_t* args);
| args | object\_t* | 参数。 | | args | object\_t* | 参数。 |
#### end\_alpha 属性 #### end\_alpha 属性
----------------------- -----------------------
> <p id="dialog_highlighter_default_t_end_alpha"> 结束alpha，打开对话框的动画结束(直到对话框被关闭)时的alpha值。 > <p id="dialog_highlighter_default_t_end_alpha"> 结束alpha，打开对话框的动画结束(直到对话框被关闭)时的alpha值。
* 类型：uint8\_t * 类型：uint8\_t
#### start\_alpha 属性 #### start\_alpha 属性
----------------------- -----------------------
> <p id="dialog_highlighter_default_t_start_alpha"> 起始alpha，打开对话框的动画开始时的alpha值。 > <p id="dialog_highlighter_default_t_start_alpha"> 起始alpha，打开对话框的动画开始时的alpha值。
* 类型：uint8\_t * 类型：uint8\_t

33
docs/manual/dialog_highlighter_factory_t.md
View File

@ -1,7 +1,8 @@
## dialog\_highlighter\_factory\_t ## dialog\_highlighter\_factory\_t
### 概述 ### 概述
对话框高亮策略工厂。 对话框高亮策略工厂。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -20,7 +21,8 @@
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_factory_t_dialog_highlighter_factory"> 获取缺省的对话框高亮策略工厂对象。 > <p id="dialog_highlighter_factory_t_dialog_highlighter_factory"> 获取缺省的对话框高亮策略工厂对象。
* 函数原型： * 函数原型：
@ -39,8 +41,9 @@ dialog_highlighter_factory_t* dialog_highlighter_factory ();
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_create"> 创建对话框高亮策略工厂对象。 > <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_create"> 创建对话框高亮策略工厂对象。
* 函数原型： * 函数原型：
@ -59,8 +62,9 @@ dialog_highlighter_factory_t* dialog_highlighter_factory_create ();
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_create_highlighter"> 创建指定类型的对话框高亮策略对象。 > <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_create_highlighter"> 创建指定类型的对话框高亮策略对象。
* 函数原型： * 函数原型：
@ -82,8 +86,9 @@ dialog_highlighter_t* dialog_highlighter_factory_create_highlighter (dialog_high
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_destroy"> 析构并释放对话框高亮策略工厂对象。 > <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_destroy"> 析构并释放对话框高亮策略工厂对象。
* 函数原型： * 函数原型：
@ -103,8 +108,9 @@ ret_t dialog_highlighter_factory_destroy (dialog_highlighter_factory_t* factory)
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_register"> 注册对话框高亮策略创建函数。 > <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_register"> 注册对话框高亮策略创建函数。
* 函数原型： * 函数原型：
@ -126,8 +132,9 @@ ret_t dialog_highlighter_factory_register (dialog_highlighter_factory_t* factory
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_set"> 设置缺省的对话框高亮策略工厂对象。 > <p id="dialog_highlighter_factory_t_dialog_highlighter_factory_set"> 设置缺省的对话框高亮策略工厂对象。
* 函数原型： * 函数原型：

52
docs/manual/dialog_highlighter_t.md
View File

@ -1,9 +1,10 @@
## dialog\_highlighter\_t ## dialog\_highlighter\_t
### 概述 ### 概述
对话框高亮策略。 对话框高亮策略。
> 高亮策略的基本思路是对背景进行处理，比如将背景变暗或变模糊。 > 高亮策略的基本思路是对背景进行处理，比如将背景变暗或变模糊。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -30,10 +31,11 @@
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_t_dialog_highlighter_create"> 创建对话框高亮策略对象。 > <p id="dialog_highlighter_t_dialog_highlighter_create"> 创建对话框高亮策略对象。
>供子类构造函数用。 >供子类构造函数用。
* 函数原型： * 函数原型：
@ -53,8 +55,9 @@ dialog_highlighter_t* dialog_highlighter_create (const dialog_highlighter_vtable
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_t_dialog_highlighter_destroy"> 销毁对话框高亮策略对象。 > <p id="dialog_highlighter_t_dialog_highlighter_destroy"> 销毁对话框高亮策略对象。
* 函数原型： * 函数原型：
@ -74,8 +77,9 @@ ret_t dialog_highlighter_destroy (dialog_highlighter_t* h);
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_t_dialog_highlighter_draw"> 绘制背景。 > <p id="dialog_highlighter_t_dialog_highlighter_draw"> 绘制背景。
* 函数原型： * 函数原型：
@ -96,8 +100,9 @@ ret_t dialog_highlighter_draw (dialog_highlighter_t* h, float_t percent);
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_t_dialog_highlighter_is_dynamic"> 是否是动态绘制(方便外层优化)。 > <p id="dialog_highlighter_t_dialog_highlighter_is_dynamic"> 是否是动态绘制(方便外层优化)。
* 函数原型： * 函数原型：
@ -117,8 +122,9 @@ bool_t dialog_highlighter_is_dynamic (dialog_highlighter_t* h);
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_t_dialog_highlighter_prepare"> 初始化。在绘制完背景，在截图前调用。 > <p id="dialog_highlighter_t_dialog_highlighter_prepare"> 初始化。在绘制完背景，在截图前调用。
* 函数原型： * 函数原型：
@ -139,8 +145,9 @@ ret_t dialog_highlighter_prepare (dialog_highlighter_t* h, canvas_t* c);
* 函数功能： * 函数功能：
> <p id="dialog_highlighter_t_dialog_highlighter_set_bg"> 设置背景图片。 > <p id="dialog_highlighter_t_dialog_highlighter_set_bg"> 设置背景图片。
* 函数原型： * 函数原型：
@ -159,21 +166,24 @@ ret_t dialog_highlighter_set_bg (dialog_highlighter_t* h, bitmap_t* img, framebu
| fbo | framebuffer\_object\_t* | fbo对象。 | | fbo | framebuffer\_object\_t* | fbo对象。 |
#### canvas 属性 #### canvas 属性
----------------------- -----------------------
> <p id="dialog_highlighter_t_canvas"> 画布。 > <p id="dialog_highlighter_t_canvas"> 画布。
* 类型：canvas\_t* * 类型：canvas\_t*
#### dialog 属性 #### dialog 属性
----------------------- -----------------------
> <p id="dialog_highlighter_t_dialog"> 对应的对话框。 > <p id="dialog_highlighter_t_dialog"> 对应的对话框。
* 类型：widget\_t* * 类型：widget\_t*
#### img 属性 #### img 属性
----------------------- -----------------------
> <p id="dialog_highlighter_t_img"> 底层窗口的截图。 > <p id="dialog_highlighter_t_img"> 底层窗口的截图。
* 类型：bitmap\_t * 类型：bitmap\_t

5
docs/manual/dialog_highlighter_type_t.md
View File

@ -1,7 +1,8 @@
## dialog\_highlighter\_type\_t ## dialog\_highlighter\_type\_t
### 概述 ### 概述
@type string @type string
内置的对话框高亮策略。 内置的对话框高亮策略。
### 常量 ### 常量
<p id="dialog_highlighter_type_t_consts"> <p id="dialog_highlighter_type_t_consts">

311
docs/manual/dialog_t.md
View File

@ -2,102 +2,103 @@
### 概述 ### 概述
![image](images/dialog_t_0.png) ![image](images/dialog_t_0.png)
对话框。 对话框是一种特殊的窗口，大小和位置可以自由设置。 对话框。 对话框是一种特殊的窗口，大小和位置可以自由设置。
AWTK中的对话框可以是模态的，也可以是非模态的。 AWTK中的对话框可以是模态的，也可以是非模态的。
如果dialog有透明或半透效果则不支持窗口动画。 如果dialog有透明或半透效果则不支持窗口动画。
> 由于浏览器中无法实现主循环嵌套，因此无法实现模态对话框。 > 由于浏览器中无法实现主循环嵌套，因此无法实现模态对话框。
如果希望自己写的AWTK应用程序可以在浏览器(包括各种小程序)中运行或演示， 如果希望自己写的AWTK应用程序可以在浏览器(包括各种小程序)中运行或演示，
请避免使用模态对话框。 请避免使用模态对话框。
对话框通常由对话框标题和对话框客户区两部分组成： 对话框通常由对话框标题和对话框客户区两部分组成：
![image](images/dialog_t_1.png) ![image](images/dialog_t_1.png)
dialog\_t是[window\_base\_t](window_base_t.md)的子类控件，window\_base\_t的函数均适用于dialog\_t控件。 dialog\_t是[window\_base\_t](window_base_t.md)的子类控件，window\_base\_t的函数均适用于dialog\_t控件。
在xml中使用"dialog"标签创建对话框。如： 在xml中使用"dialog"标签创建对话框。如：
```xml ```xml
<dialog anim_hint="center_scale(duration=300)" x="c" y="m" w="80%" h="160" text="Dialog"> <dialog anim_hint="center_scale(duration=300)" x="c" y="m" w="80%" h="160" text="Dialog">
<dialog_title x="0" y="0" w="100%" h="30" text="Hello AWTK" /> <dialog_title x="0" y="0" w="100%" h="30" text="Hello AWTK" />
<dialog_client x="0" y="bottom" w="100%" h="-30"> <dialog_client x="0" y="bottom" w="100%" h="-30">
<label name="" x="center" y="middle:-20" w="200" h="30" text="Are you ready?"/> <label name="" x="center" y="middle:-20" w="200" h="30" text="Are you ready?"/>
<button name="quit" x="10" y="bottom:10" w="40%" h="30" text="确定"/> <button name="quit" x="10" y="bottom:10" w="40%" h="30" text="确定"/>
<button name="quit" x="right:10" y="bottom:10" w="40%" h="30" text="取消"/> <button name="quit" x="right:10" y="bottom:10" w="40%" h="30" text="取消"/>
</dialog_client> </dialog_client>
</dialog> </dialog>
``` ```
如果你不需要对话框的标题，可以这样写： 如果你不需要对话框的标题，可以这样写：
```xml ```xml
<dialog anim_hint="center_scale(duration=300)" x="c" y="m" w="80%" h="160" text="Dialog"> <dialog anim_hint="center_scale(duration=300)" x="c" y="m" w="80%" h="160" text="Dialog">
<label name="" x="center" y="middle:-20" w="200" h="30" text="Are you ready?"/> <label name="" x="center" y="middle:-20" w="200" h="30" text="Are you ready?"/>
<button name="quit" x="10" y="bottom:10" w="40%" h="30" text="确定"/> <button name="quit" x="10" y="bottom:10" w="40%" h="30" text="确定"/>
<button name="quit" x="right:10" y="bottom:10" w="40%" h="30" text="取消"/> <button name="quit" x="right:10" y="bottom:10" w="40%" h="30" text="取消"/>
</dialog> </dialog>
``` ```
打开非模态对话框时，其用法与普通窗口一样。打开非模态对话框时，还需要调用dialog\_modal。 打开非模态对话框时，其用法与普通窗口一样。打开非模态对话框时，还需要调用dialog\_modal。
```c ```c
widget_t* dlg = dialog_open(name); widget_t* dlg = dialog_open(name);
ret = dialog_modal(dlg); ret = dialog_modal(dlg);
``` ```
关闭模态对话框用dialog\_quit 关闭模态对话框用dialog\_quit
```c ```c
static ret_t on_dialog_btn_click(void* ctx, event_t* evt) { static ret_t on_dialog_btn_click(void* ctx, event_t* evt) {
widget_t* win = widget_get_window(WIDGET(evt->target)); widget_t* win = widget_get_window(WIDGET(evt->target));
int code = (char*)ctx - (char*)NULL; int code = (char*)ctx - (char*)NULL;
dialog_quit(win, code); dialog_quit(win, code);
return RET_OK; return RET_OK;
} }
``` ```
关闭非模态对话框用window\_close。 关闭非模态对话框用window\_close。
```c ```c
static ret_t on_dialog_btn_click(void* ctx, event_t* evt) { static ret_t on_dialog_btn_click(void* ctx, event_t* evt) {
widget_t* win = widget_get_window(WIDGET(evt->target)); widget_t* win = widget_get_window(WIDGET(evt->target));
int code = (char*)ctx - (char*)NULL; int code = (char*)ctx - (char*)NULL;
window_close(win); window_close(win);
return RET_OK; return RET_OK;
} }
``` ```
> 更多用法请参考： > 更多用法请参考：
[dialog.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/) [dialog.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/)
> 完整C代码示例请参考： > 完整C代码示例请参考：
* [非模态对话框](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/dialog.c) * [非模态对话框](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/dialog.c)
* [模态对话框](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/dialog_modal.c) * [模态对话框](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/dialog_modal.c)
可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如： 可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：
```xml ```xml
<style name="default"> <style name="default">
<normal border_color="#606060" /> <normal border_color="#606060" />
</style> </style>
``` ```
> 更多用法请参考： > 更多用法请参考：
[theme default] [theme default]
(https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L324) (https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L324)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -131,8 +132,9 @@
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_cast"> 转换dialog对象(供脚本语言使用)。 > <p id="dialog_t_dialog_cast"> 转换dialog对象(供脚本语言使用)。
* 函数原型： * 函数原型：
@ -152,11 +154,12 @@ widget_t* dialog_cast (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_confirm"> 显示『确认』对话框。 > <p id="dialog_t_dialog_confirm"> 显示『确认』对话框。
主题由dialog_confirm.xml文件决定。 主题由dialog_confirm.xml文件决定。
* 函数原型： * 函数原型：
@ -177,8 +180,9 @@ ret_t dialog_confirm (const char* title, const char* text);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_create"> 创建dialog对象。 > <p id="dialog_t_dialog_create"> 创建dialog对象。
* 函数原型： * 函数原型：
@ -202,8 +206,9 @@ widget_t* dialog_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_create_simple"> 创建dialog对象，同时创建title/client。 > <p id="dialog_t_dialog_create_simple"> 创建dialog对象，同时创建title/client。
* 函数原型： * 函数原型：
@ -227,8 +232,9 @@ widget_t* dialog_create_simple (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_get_client"> 获取client控件。 > <p id="dialog_t_dialog_get_client"> 获取client控件。
* 函数原型： * 函数原型：
@ -248,8 +254,9 @@ widget_t* dialog_get_client (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_get_title"> 获取title控件。 > <p id="dialog_t_dialog_get_title"> 获取title控件。
* 函数原型： * 函数原型：
@ -269,11 +276,12 @@ widget_t* dialog_get_title (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_info"> 显示『提示信息』对话框。 > <p id="dialog_t_dialog_info"> 显示『提示信息』对话框。
主题由dialog_info.xml文件决定。 主题由dialog_info.xml文件决定。
* 函数原型： * 函数原型：
@ -294,9 +302,10 @@ ret_t dialog_info (const char* title, const char* text);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_is_modal"> 检查对话框是否为模态对话框。 > <p id="dialog_t_dialog_is_modal"> 检查对话框是否为模态对话框。
* 函数原型： * 函数原型：
@ -316,9 +325,10 @@ bool_t dialog_is_modal (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_is_quited"> 检查对话框是否已经退出模态。 > <p id="dialog_t_dialog_is_quited"> 检查对话框是否已经退出模态。
* 函数原型： * 函数原型：
@ -338,10 +348,11 @@ bool_t dialog_is_quited (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_modal"> 模态显示对话框。 > <p id="dialog_t_dialog_modal"> 模态显示对话框。
dialog_modal返回后，dialog对象将在下一个idle函数中回收。 dialog_modal返回后，dialog对象将在下一个idle函数中回收。
也就是在dialog_modal调用完成后仍然可以访问dialog中控件，直到本次事件结束。 也就是在dialog_modal调用完成后仍然可以访问dialog中控件，直到本次事件结束。
* 函数原型： * 函数原型：
@ -361,10 +372,11 @@ ret_t dialog_modal (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_open"> 从资源文件中加载并创建Dialog对象。 > <p id="dialog_t_dialog_open"> 从资源文件中加载并创建Dialog对象。
本函数在ui\_loader/ui\_builder_default里实现。 本函数在ui\_loader/ui\_builder_default里实现。
* 函数原型： * 函数原型：
@ -384,11 +396,12 @@ widget_t* dialog_open (const char* name);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_quit"> 退出模态显示，关闭对话框。 > <p id="dialog_t_dialog_quit"> 退出模态显示，关闭对话框。
> 比如，在对话框中关闭按钮的事件处理函数中，调用本函数关闭对话框。 > 比如，在对话框中关闭按钮的事件处理函数中，调用本函数关闭对话框。
* 函数原型： * 函数原型：
@ -409,8 +422,9 @@ ret_t dialog_quit (widget_t* widget, uint32_t code);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_set_title"> 设置对话框的标题文本。 > <p id="dialog_t_dialog_set_title"> 设置对话框的标题文本。
* 函数原型： * 函数原型：
@ -431,11 +445,12 @@ ret_t dialog_set_title (widget_t* widget, char* title);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_toast"> 显示『短暂提示信息』对话框。 > <p id="dialog_t_dialog_toast"> 显示『短暂提示信息』对话框。
主题由dialog_toast.xml文件决定。 主题由dialog_toast.xml文件决定。
* 函数原型： * 函数原型：
@ -456,11 +471,12 @@ ret_t dialog_toast (const char* text, uint32_t duration);
* 函数功能： * 函数功能：
> <p id="dialog_t_dialog_warn"> 显示『警告』对话框。 > <p id="dialog_t_dialog_warn"> 显示『警告』对话框。
主题由dialog_warn.xml文件决定。 主题由dialog_warn.xml文件决定。
* 函数原型： * 函数原型：
@ -478,7 +494,8 @@ ret_t dialog_warn (const char* title, const char* text);
| text | const char* | 文本内容。 | | text | const char* | 文本内容。 |
#### highlight 属性 #### highlight 属性
----------------------- -----------------------
> <p id="dialog_t_highlight"> 对话框高亮策略。 > <p id="dialog_t_highlight"> 对话框高亮策略。
* 类型：const char* * 类型：const char*

1
docs/manual/easing_type_t.md
View File

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

106
docs/manual/emitter_t.md
View File

@ -1,7 +1,8 @@
## emitter\_t ## emitter\_t
### 概述 ### 概述
事件分发器, 用于实现观察者模式。 事件分发器, 用于实现观察者模式。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -36,10 +37,11 @@
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_cast"> 转换为emitter对象(供脚本语言使用)。 > <p id="emitter_t_emitter_cast"> 转换为emitter对象(供脚本语言使用)。
主要给脚本语言使用。 主要给脚本语言使用。
* 函数原型： * 函数原型：
@ -59,8 +61,9 @@ emitter_t* emitter_cast (emitter_t* emitter);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_create"> 创建emitter对象。 > <p id="emitter_t_emitter_create"> 创建emitter对象。
* 函数原型： * 函数原型：
@ -79,9 +82,10 @@ emitter_t* emitter_create ();
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_deinit"> 析构。 > <p id="emitter_t_emitter_deinit"> 析构。
* 函数原型： * 函数原型：
@ -101,9 +105,10 @@ ret_t emitter_deinit (emitter_t* emitter);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_destroy"> 销毁。 > <p id="emitter_t_emitter_destroy"> 销毁。
* 函数原型： * 函数原型：
@ -123,11 +128,12 @@ ret_t emitter_destroy (emitter_t* emitter);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_disable"> 禁用。 > <p id="emitter_t_emitter_disable"> 禁用。
禁用后emitter_dispatch无效，但可以注册和注销。 禁用后emitter_dispatch无效，但可以注册和注销。
* 函数原型： * 函数原型：
@ -147,9 +153,10 @@ ret_t emitter_disable (emitter_t* emitter);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_dispatch"> 分发事件。如果当前分发的回调函数返回RET_REMOVE，该回调函数将被移出。 > <p id="emitter_t_emitter_dispatch"> 分发事件。如果当前分发的回调函数返回RET_REMOVE，该回调函数将被移出。
禁用状态下，本函数不做任何事情。 禁用状态下，本函数不做任何事情。
如果当前分发的回调函数返回RET_STOP，dispatch中断分发，并返回RET_STOP，否则返回RET_OK。 如果当前分发的回调函数返回RET_STOP，dispatch中断分发，并返回RET_STOP，否则返回RET_OK。
* 函数原型： * 函数原型：
@ -170,9 +177,10 @@ ret_t emitter_dispatch (emitter_t* emitter, event_t* e);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_dispatch_simple_event"> 分发事件。 > <p id="emitter_t_emitter_dispatch_simple_event"> 分发事件。
> 对emitter_dispatch的包装，分发一个简单的事件。 > 对emitter_dispatch的包装，分发一个简单的事件。
如果当前分发的回调函数返回RET_STOP，dispatch中断分发，并返回RET_STOP，否则返回RET_OK。 如果当前分发的回调函数返回RET_STOP，dispatch中断分发，并返回RET_STOP，否则返回RET_OK。
* 函数原型： * 函数原型：
@ -193,8 +201,9 @@ ret_t emitter_dispatch_simple_event (emitter_t* emitter, uint32_t type);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_enable"> 启用。 > <p id="emitter_t_emitter_enable"> 启用。
* 函数原型： * 函数原型：
@ -214,8 +223,9 @@ ret_t emitter_enable (emitter_t* emitter);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_find"> 通过ID查找emitter_item_t，主要用于辅助测试。 > <p id="emitter_t_emitter_find"> 通过ID查找emitter_item_t，主要用于辅助测试。
* 函数原型： * 函数原型：
@ -236,8 +246,9 @@ ret_t emitter_find (emitter_t* emitter, uint32_t id);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_init"> 初始化emitter对象。 > <p id="emitter_t_emitter_init"> 初始化emitter对象。
* 函数原型： * 函数原型：
@ -257,8 +268,9 @@ emitter_t* emitter_init (emitter_t* emitter);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_off"> 注销指定事件的处理函数。 > <p id="emitter_t_emitter_off"> 注销指定事件的处理函数。
* 函数原型： * 函数原型：
@ -279,8 +291,9 @@ ret_t emitter_off (emitter_t* emitter, uint32_t id);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_off_by_ctx"> 注销指定事件的处理函数。 > <p id="emitter_t_emitter_off_by_ctx"> 注销指定事件的处理函数。
* 函数原型： * 函数原型：
@ -301,8 +314,9 @@ ret_t emitter_off_by_ctx (emitter_t* emitter, void* ctx);
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_off_by_func"> 注销指定事件的处理函数。 > <p id="emitter_t_emitter_off_by_func"> 注销指定事件的处理函数。
* 函数原型： * 函数原型：
@ -325,8 +339,9 @@ ret_t emitter_off_by_func (emitter_t* emitter, uint32_t type, event_func_t on_ev
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_on"> 注册指定事件的处理函数。 > <p id="emitter_t_emitter_on"> 注册指定事件的处理函数。
* 函数原型： * 函数原型：
@ -349,8 +364,9 @@ uint32_t emitter_on (emitter_t* emitter, uint32_t type, event_func_t on_event, v
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_set_on_destroy"> 设置一个回调函数，在emitter被销毁时调用(方便脚本语言去释放回调函数)。 > <p id="emitter_t_emitter_set_on_destroy"> 设置一个回调函数，在emitter被销毁时调用(方便脚本语言去释放回调函数)。
* 函数原型： * 函数原型：
@ -373,8 +389,9 @@ ret_t emitter_set_on_destroy (emitter_t* emitter, uint32_t id, tk_destroy_t on_d
* 函数功能： * 函数功能：
> <p id="emitter_t_emitter_size"> 获取注册的回调函数个数，主要用于辅助测试。 > <p id="emitter_t_emitter_size"> 获取注册的回调函数个数，主要用于辅助测试。
* 函数原型： * 函数原型：
@ -391,7 +408,8 @@ uint32_t emitter_size (emitter_t* emitter);
| emitter | emitter\_t* | emitter对象。 | | emitter | emitter\_t* | emitter对象。 |
#### enable 属性 #### enable 属性
----------------------- -----------------------
> <p id="emitter_t_enable"> 禁用标志。禁用时dispatch无效。 > <p id="emitter_t_enable"> 禁用标志。禁用时dispatch无效。
* 类型：bool\_t * 类型：bool\_t

3
docs/manual/event_base_type_t.md
View File

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

2
docs/manual/event_source_fd_t.md
View File

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

3
docs/manual/event_source_idle_t.md
View File

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

8
docs/manual/event_source_manager_t.md
View File

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

5
docs/manual/event_source_t.md
View File

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

2
docs/manual/event_source_timer_t.md
View File

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

44
docs/manual/event_t.md
View File

@ -1,6 +1,7 @@
## event\_t ## event\_t
### 概述 ### 概述
事件基类。 事件基类。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -25,10 +26,11 @@
* 函数功能： * 函数功能：
> <p id="event_t_event_cast"> 转换为event对象。 > <p id="event_t_event_cast"> 转换为event对象。
> 供脚本语言使用 > 供脚本语言使用
* 函数原型： * 函数原型：
@ -48,10 +50,11 @@ event_t* event_cast (event_t* event);
* 函数功能： * 函数功能：
> <p id="event_t_event_create"> 创建event对象。 > <p id="event_t_event_create"> 创建event对象。
主要给脚本语言使用。 主要给脚本语言使用。
* 函数原型： * 函数原型：
@ -72,10 +75,11 @@ event_t* event_create (uint32_t type, void* target);
* 函数功能： * 函数功能：
> <p id="event_t_event_destroy"> 销毁事件对象。 > <p id="event_t_event_destroy"> 销毁事件对象。
主要给脚本语言使用。 主要给脚本语言使用。
* 函数原型： * 函数原型：
@ -95,8 +99,9 @@ ret_t event_destroy (event_t* event);
* 函数功能： * 函数功能：
> <p id="event_t_event_init"> 初始化事件。 > <p id="event_t_event_init"> 初始化事件。
* 函数原型： * 函数原型：
@ -114,7 +119,8 @@ event_t event_init (uint32_t type, void* target);
| target | void* | 目标对象。 | | target | void* | 目标对象。 |
#### target 属性 #### target 属性
----------------------- -----------------------
> <p id="event_t_target"> 事件发生的目标对象。 > <p id="event_t_target"> 事件发生的目标对象。
* 类型：void* * 类型：void*
@ -126,7 +132,8 @@ event_t event_init (uint32_t type, void* target);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### time 属性 #### time 属性
----------------------- -----------------------
> <p id="event_t_time"> 事件发生的时间。 > <p id="event_t_time"> 事件发生的时间。
* 类型：int32\_t * 类型：int32\_t
@ -138,7 +145,8 @@ event_t event_init (uint32_t type, void* target);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### type 属性 #### type 属性
----------------------- -----------------------
> <p id="event_t_type"> 类型。 > <p id="event_t_type"> 类型。
* 类型：int32\_t * 类型：int32\_t

3
docs/manual/event_type_t.md
View File

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

24
docs/manual/font_loader_bitmap_t.md
View File

@ -2,14 +2,15 @@
### 概述 ### 概述
![image](images/font_loader_bitmap_t_0.png) ![image](images/font_loader_bitmap_t_0.png)
bitmap字体加载器。 bitmap字体加载器。
bitmap字体是用工具预先生成位图字体数据，优势是速度快，不占用内存，缺点是字体大小固定。 bitmap字体是用工具预先生成位图字体数据，优势是速度快，不占用内存，缺点是字体大小固定。
适合低端嵌入式平台。 适合低端嵌入式平台。
tools/font_gen用于把矢量字体(如truetype)转换成位图字体。 tools/font_gen用于把矢量字体(如truetype)转换成位图字体。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -23,9 +24,10 @@
* 函数功能： * 函数功能：
> <p id="font_loader_bitmap_t_font_loader_bitmap"> > <p id="font_loader_bitmap_t_font_loader_bitmap">
获取bitmap字体加载器对象。 获取bitmap字体加载器对象。
* 函数原型： * 函数原型：

18
docs/manual/font_loader_stb_t.md
View File

@ -2,11 +2,12 @@
### 概述 ### 概述
![image](images/font_loader_stb_t_0.png) ![image](images/font_loader_stb_t_0.png)
stb字体加载器。 stb字体加载器。
stb主要用于加载矢量字体(如truetype)，它功能强大，体积小巧。 stb主要用于加载矢量字体(如truetype)，它功能强大，体积小巧。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -20,9 +21,10 @@
* 函数功能： * 函数功能：
> <p id="font_loader_stb_t_font_loader_stb"> > <p id="font_loader_stb_t_font_loader_stb">
获取stb字体加载器对象。 获取stb字体加载器对象。
* 函数原型： * 函数原型：

10
docs/manual/font_loader_t.md
View File

@ -1,6 +1,7 @@
## font\_loader\_t ## font\_loader\_t
### 概述 ### 概述
字体加载接口。 字体加载接口。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -14,9 +15,10 @@
* 函数功能： * 函数功能：
> <p id="font_loader_t_font_loader_load"> 加载字体。 > <p id="font_loader_t_font_loader_load"> 加载字体。
* 函数原型： * 函数原型：

69
docs/manual/font_manager_t.md
View File

@ -1,7 +1,8 @@
## font\_manager\_t ## font\_manager\_t
### 概述 ### 概述
字体管理器，负责字体的加载和缓存管理。 字体管理器，负责字体的加载和缓存管理。
(如果使用nanovg，字体由nanovg内部管理) (如果使用nanovg，字体由nanovg内部管理)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -29,7 +30,8 @@
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager"> 获取缺省的字体管理器。 > <p id="font_manager_t_font_manager"> 获取缺省的字体管理器。
* 函数原型： * 函数原型：
@ -48,8 +50,9 @@ font_manager_t* font_manager ();
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager_add_font"> 向缓存中加入字体。 > <p id="font_manager_t_font_manager_add_font"> 向缓存中加入字体。
* 函数原型： * 函数原型：
@ -71,8 +74,9 @@ ret_t font_manager_add_font (font_manager_t* fm, char* name, font_t* font);
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager_create"> 创建字体管理器。 > <p id="font_manager_t_font_manager_create"> 创建字体管理器。
* 函数原型： * 函数原型：
@ -92,8 +96,9 @@ font_manager_t* font_manager_create (font_loader_t* loader);
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager_deinit"> 析构字体管理器。 > <p id="font_manager_t_font_manager_deinit"> 析构字体管理器。
* 函数原型： * 函数原型：
@ -113,8 +118,9 @@ ret_t font_manager_deinit (font_manager_t* fm);
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager_destroy"> 析构并释放字体管理器。 > <p id="font_manager_t_font_manager_destroy"> 析构并释放字体管理器。
* 函数原型： * 函数原型：
@ -134,8 +140,9 @@ ret_t font_manager_destroy (font_manager_t* fm);
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager_get_font"> 从缓存中查找字体，如果没找到，再加载字体，并缓存。 > <p id="font_manager_t_font_manager_get_font"> 从缓存中查找字体，如果没找到，再加载字体，并缓存。
* 函数原型： * 函数原型：
@ -157,8 +164,9 @@ font_t* font_manager_get_font (font_manager_t* fm, char* name, font_size_t size)
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager_init"> 初始化字体管理器。 > <p id="font_manager_t_font_manager_init"> 初始化字体管理器。
* 函数原型： * 函数原型：
@ -179,8 +187,9 @@ font_manager_t* font_manager_init (font_manager_t* fm, font_loader_t* loader);
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager_set"> 设置缺省的字体管理器。 > <p id="font_manager_t_font_manager_set"> 设置缺省的字体管理器。
* 函数原型： * 函数原型：
@ -200,16 +209,17 @@ ret_t font_manager_set (font_manager_t* fm);
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager_set_assets_manager"> 设置资源管理器对象 > <p id="font_manager_t_font_manager_set_assets_manager"> 设置资源管理器对象
之所以需要设置资源管理器对象，而不是使用缺省的资源管理器对象，是因为在designer中有两个字体管理器： 之所以需要设置资源管理器对象，而不是使用缺省的资源管理器对象，是因为在designer中有两个字体管理器：
* 一个用于designer本身加载字体。 * 一个用于designer本身加载字体。
* 一个用于被设计的窗口加载字体。 * 一个用于被设计的窗口加载字体。
这两个字体管理器需要从不同的路径加载资源。 这两个字体管理器需要从不同的路径加载资源。
* 函数原型： * 函数原型：
@ -230,8 +240,9 @@ ret_t font_manager_set_assets_manager (font_manager_t* imm, assets_manager_t* as
* 函数功能： * 函数功能：
> <p id="font_manager_t_font_manager_unload_font"> 卸载指定的字体。 > <p id="font_manager_t_font_manager_unload_font"> 卸载指定的字体。
* 函数原型： * 函数原型：

29
docs/manual/font_t.md
View File

@ -1,7 +1,8 @@
## font\_t ## font\_t
### 概述 ### 概述
代表一种字体。 代表一种字体。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -18,8 +19,9 @@
* 函数功能： * 函数功能：
> <p id="font_t_font_destroy"> 销毁font对象。 > <p id="font_t_font_destroy"> 销毁font对象。
* 函数原型： * 函数原型：
@ -39,8 +41,9 @@ ret_t font_destroy (font_t* font);
* 函数功能： * 函数功能：
> <p id="font_t_font_get_baseline"> 获取字体的基线。 > <p id="font_t_font_get_baseline"> 获取字体的基线。
* 函数原型： * 函数原型：
@ -61,9 +64,10 @@ int32_t font_get_baseline (font_t* font, font_size_t font_size);
* 函数功能： * 函数功能：
> <p id="font_t_font_get_glyph"> 获取指定字符和大小的字模。 > <p id="font_t_font_get_glyph"> 获取指定字符和大小的字模。
* 函数原型： * 函数原型：
@ -86,9 +90,10 @@ ret_t font_get_glyph (font_t* font, wchar_t chr, font_size_t font_size, glyph_t*
* 函数功能： * 函数功能：
> <p id="font_t_font_match"> 检查当前字体是否与指定名称和大小相匹配。 > <p id="font_t_font_match"> 检查当前字体是否与指定名称和大小相匹配。
* 函数原型： * 函数原型：

4
docs/manual/fs_dir_t.md
View File

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

32
docs/manual/fs_file_t.md
View File

@ -4,6 +4,7 @@
文件接口。 文件接口。
---------------------------------- ----------------------------------
### 函数 ### 函数
<p id="fs_file_t_methods"> <p id="fs_file_t_methods">
@ -11,6 +12,7 @@
| 函数名称 | 说明 | | 函数名称 | 说明 |
| -------- | ------------ | | -------- | ------------ |
| <a href="#fs_file_t_fs_file_close">fs\_file\_close</a> | | | <a href="#fs_file_t_fs_file_close">fs\_file\_close</a> | |
| <a href="#fs_file_t_fs_file_eof">fs\_file\_eof</a> | |
| <a href="#fs_file_t_fs_file_read">fs\_file\_read</a> | | | <a href="#fs_file_t_fs_file_read">fs\_file\_read</a> | |
| <a href="#fs_file_t_fs_file_seek">fs\_file\_seek</a> | | | <a href="#fs_file_t_fs_file_seek">fs\_file\_seek</a> | |
| <a href="#fs_file_t_fs_file_truncate">fs\_file\_truncate</a> | | | <a href="#fs_file_t_fs_file_truncate">fs\_file\_truncate</a> | |
@ -27,6 +29,7 @@
* 函数原型： * 函数原型：
``` ```
@ -39,6 +42,31 @@ ret_t fs_file_close (fs_file_t* file);
| -------- | ----- | --------- | | -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| file | fs\_file\_t* | 文件对象。 | | file | fs\_file\_t* | 文件对象。 |
#### fs\_file\_eof 函数
-----------------------
* 函数功能：
> <p id="fs_file_t_fs_file_eof">
判断文件是否结束。
* 函数原型：
```
bool_t fs_file_eof (fs_file_t* file);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | bool\_t | 返回TRUE表示结束，否则表示没结束。 |
| file | fs\_file\_t* | 文件对象。 |
#### fs\_file\_read 函数 #### fs\_file\_read 函数
----------------------- -----------------------
@ -51,6 +79,7 @@ ret_t fs_file_close (fs_file_t* file);
* 函数原型： * 函数原型：
``` ```
@ -77,6 +106,7 @@ int32_t fs_file_read (fs_file_t* file, void* buffer, uint32_t size);
* 函数原型： * 函数原型：
``` ```
@ -102,6 +132,7 @@ ret_t fs_file_seek (fs_file_t* file, uint32_t offset);
* 函数原型： * 函数原型：
``` ```
@ -126,6 +157,7 @@ ret_t fs_file_truncate (fs_file_t* file);
* 函数原型： * 函数原型：
``` ```

1
docs/manual/fs_t.md
View File

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

45
docs/manual/func_call_parser_t.md
View File

@ -1,15 +1,16 @@
## func\_call\_parser\_t ## func\_call\_parser\_t
### 概述 ### 概述
从字符串中解析出函数调用需要的参数。 从字符串中解析出函数调用需要的参数。
func_call => func_name '(' params ')' func_call => func_name '(' params ')'
params => param ',' params params => param ',' params
param => name '=' value param => name '=' value
func_name => ID func_name => ID
name = ID name = ID
value = int | float | ID value = int | float | ID
如:move(x=10, y=20) 如:move(x=10, y=20)
如:rename(old_name=aa, new_name=bb) 如:rename(old_name=aa, new_name=bb)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -26,8 +27,9 @@
* 函数功能： * 函数功能：
> <p id="func_call_parser_t_func_call_parser_deinit"> 重置parser。 > <p id="func_call_parser_t_func_call_parser_deinit"> 重置parser。
* 函数原型： * 函数原型：
@ -47,8 +49,9 @@ ret_t func_call_parser_deinit (func_call_parser_t* parser);
* 函数功能： * 函数功能：
> <p id="func_call_parser_t_func_call_parser_init"> 初始化parser对象。 > <p id="func_call_parser_t_func_call_parser_init"> 初始化parser对象。
* 函数原型： * 函数原型：
@ -70,8 +73,9 @@ func_call_parser_t* func_call_parser_init (func_call_parser_t* parser, const cha
* 函数功能： * 函数功能：
> <p id="func_call_parser_t_func_call_parser_parse"> 开始解析。 > <p id="func_call_parser_t_func_call_parser_parse"> 开始解析。
* 函数原型： * 函数原型：
@ -91,10 +95,11 @@ ret_t func_call_parser_parse (func_call_parser_t* parser);
* 函数功能： * 函数功能：
> <p id="func_call_parser_t_func_call_parser_parse"> 解析参数，并将结果生成一个object对象。 > <p id="func_call_parser_t_func_call_parser_parse"> 解析参数，并将结果生成一个object对象。
> 调用者负责释放返回的object对象。 > 调用者负责释放返回的object对象。
* 函数原型： * 函数原型：

6
docs/manual/func_desc_t.md
View File

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

4
docs/manual/gif_image_t.md
View File

@ -9,10 +9,10 @@
gif\_image\_t是[image\_base\_t](image_base_t.md)的子类控件，image\_base\_t的函数均适用于gif\_image\_t控件。 gif\_image\_t是[image\_base\_t](image_base_t.md)的子类控件，image\_base\_t的函数均适用于gif\_image\_t控件。
在xml中使用"gif\_image"标签创建GIF图片控件。如： 在xml中使用"gif"标签创建GIF图片控件。如：
```xml ```xml
<gif_image image="bee"/> <gif image="bee"/>
``` ```
>更多用法请参考： >更多用法请参考：

38
docs/manual/global_t.md
View File

@ -1,6 +1,7 @@
## global\_t ## global\_t
### 概述 ### 概述
TK全局对象。 TK全局对象。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -20,8 +21,9 @@
* 函数功能： * 函数功能：
> <p id="global_t_tk_get_pointer_x"> 获取全局指针的X坐标。 > <p id="global_t_tk_get_pointer_x"> 获取全局指针的X坐标。
* 函数原型： * 函数原型：
@ -40,8 +42,9 @@ int32_t tk_get_pointer_x ();
* 函数功能： * 函数功能：
> <p id="global_t_tk_get_pointer_y"> 获取全局指针的Y坐标。 > <p id="global_t_tk_get_pointer_y"> 获取全局指针的Y坐标。
* 函数原型： * 函数原型：
@ -60,8 +63,9 @@ int32_t tk_get_pointer_y ();
* 函数功能： * 函数功能：
> <p id="global_t_tk_init"> 初始化TK。 > <p id="global_t_tk_init"> 初始化TK。
* 函数原型： * 函数原型：
@ -85,8 +89,9 @@ ret_t tk_init (wh_t w, wh_t h, app_type_t app_type, const char* app_name, const
* 函数功能： * 函数功能：
> <p id="global_t_tk_is_pointer_pressed"> 获取全局指针是否按下。 > <p id="global_t_tk_is_pointer_pressed"> 获取全局指针是否按下。
* 函数原型： * 函数原型：
@ -105,8 +110,9 @@ bool_t tk_is_pointer_pressed ();
* 函数功能： * 函数功能：
> <p id="global_t_tk_quit"> 退出TK事件主循环。 > <p id="global_t_tk_quit"> 退出TK事件主循环。
* 函数原型： * 函数原型：
@ -125,8 +131,9 @@ ret_t tk_quit ();
* 函数功能： * 函数功能：
> <p id="global_t_tk_run"> 进入TK事件主循环。 > <p id="global_t_tk_run"> 进入TK事件主循环。
* 函数原型： * 函数原型：
@ -145,8 +152,9 @@ ret_t tk_run ();
* 函数功能： * 函数功能：
> <p id="global_t_tk_set_lcd_orientation"> 设置屏幕的旋转方向(XXX:目前仅支持0度和90度)。 > <p id="global_t_tk_set_lcd_orientation"> 设置屏幕的旋转方向(XXX:目前仅支持0度和90度)。
* 函数原型： * 函数原型：

3
docs/manual/glyph_format_t.md
View File

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

60
docs/manual/glyph_t.md
View File

@ -1,7 +1,8 @@
## glyph\_t ## glyph\_t
### 概述 ### 概述
代表一个字符的字模。 代表一个字符的字模。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -20,18 +21,19 @@
| <a href="#glyph_t_advance">advance</a> | uint16\_t | 占位宽度。 | | <a href="#glyph_t_advance">advance</a> | uint16\_t | 占位宽度。 |
| <a href="#glyph_t_data">data</a> | const uint8\_t* | 数据。 | | <a href="#glyph_t_data">data</a> | const uint8\_t* | 数据。 |
| <a href="#glyph_t_format">format</a> | uint8\_t | 格式。 | | <a href="#glyph_t_format">format</a> | uint8\_t | 格式。 |
| <a href="#glyph_t_h">h</a> | uint8\_t | 高度。 | | <a href="#glyph_t_h">h</a> | uint16\_t | 高度。 |
| <a href="#glyph_t_pitch">pitch</a> | uint8\_t | pitch。 | | <a href="#glyph_t_pitch">pitch</a> | uint8\_t | pitch。 |
| <a href="#glyph_t_w">w</a> | uint8\_t | 宽度。 | | <a href="#glyph_t_w">w</a> | uint16\_t | 宽度。 |
| <a href="#glyph_t_x">x</a> | int8\_t | x坐标。 | | <a href="#glyph_t_x">x</a> | int16\_t | x坐标。 |
| <a href="#glyph_t_y">y</a> | int8\_t | y坐标。 | | <a href="#glyph_t_y">y</a> | int16\_t | y坐标。 |
#### glyph\_clone 函数 #### glyph\_clone 函数
----------------------- -----------------------
* 函数功能： * 函数功能：
> <p id="glyph_t_glyph_clone"> 克隆glyph对象。 > <p id="glyph_t_glyph_clone"> 克隆glyph对象。
* 函数原型： * 函数原型：
@ -50,8 +52,9 @@ glyph_t* glyph_clone ();
* 函数功能： * 函数功能：
> <p id="glyph_t_glyph_create"> 创建glyph对象。 > <p id="glyph_t_glyph_create"> 创建glyph对象。
* 函数原型： * 函数原型：
@ -70,8 +73,9 @@ glyph_t* glyph_create ();
* 函数功能： * 函数功能：
> <p id="glyph_t_glyph_destroy"> 销毁glyph对象。 > <p id="glyph_t_glyph_destroy"> 销毁glyph对象。
* 函数原型： * 函数原型：
@ -88,7 +92,8 @@ ret_t glyph_destroy (glyph_t* glyph);
| glyph | glyph\_t* | glyph对象。 | | glyph | glyph\_t* | glyph对象。 |
#### advance 属性 #### advance 属性
----------------------- -----------------------
> <p id="glyph_t_advance"> 占位宽度。 > <p id="glyph_t_advance"> 占位宽度。
* 类型：uint16\_t * 类型：uint16\_t
@ -99,7 +104,8 @@ ret_t glyph_destroy (glyph_t* glyph);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### data 属性 #### data 属性
----------------------- -----------------------
> <p id="glyph_t_data"> 数据。 > <p id="glyph_t_data"> 数据。
* 类型：const uint8\_t* * 类型：const uint8\_t*
@ -110,7 +116,8 @@ ret_t glyph_destroy (glyph_t* glyph);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### format 属性 #### format 属性
----------------------- -----------------------
> <p id="glyph_t_format"> 格式。 > <p id="glyph_t_format"> 格式。
* 类型：uint8\_t * 类型：uint8\_t
@ -121,10 +128,11 @@ ret_t glyph_destroy (glyph_t* glyph);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### h 属性 #### h 属性
----------------------- -----------------------
> <p id="glyph_t_h"> 高度。 > <p id="glyph_t_h"> 高度。
* 类型：uint8\_t
* 类型：uint16\_t
| 特性 | 是否支持 | | 特性 | 是否支持 |
| -------- | ----- | | -------- | ----- |
@ -132,7 +140,8 @@ ret_t glyph_destroy (glyph_t* glyph);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### pitch 属性 #### pitch 属性
----------------------- -----------------------
> <p id="glyph_t_pitch"> pitch。 > <p id="glyph_t_pitch"> pitch。
* 类型：uint8\_t * 类型：uint8\_t
@ -143,10 +152,11 @@ ret_t glyph_destroy (glyph_t* glyph);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### w 属性 #### w 属性
----------------------- -----------------------
> <p id="glyph_t_w"> 宽度。 > <p id="glyph_t_w"> 宽度。
* 类型：uint8\_t
* 类型：uint16\_t
| 特性 | 是否支持 | | 特性 | 是否支持 |
| -------- | ----- | | -------- | ----- |
@ -154,10 +164,11 @@ ret_t glyph_destroy (glyph_t* glyph);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### x 属性 #### x 属性
----------------------- -----------------------
> <p id="glyph_t_x"> x坐标。 > <p id="glyph_t_x"> x坐标。
* 类型：int8\_t
* 类型：int16\_t
| 特性 | 是否支持 | | 特性 | 是否支持 |
| -------- | ----- | | -------- | ----- |
@ -165,10 +176,11 @@ ret_t glyph_destroy (glyph_t* glyph);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### y 属性 #### y 属性
----------------------- -----------------------
> <p id="glyph_t_y"> y坐标。 > <p id="glyph_t_y"> y坐标。
* 类型：int8\_t
* 类型：int16\_t
| 特性 | 是否支持 | | 特性 | 是否支持 |
| -------- | ----- | | -------- | ----- |

98
docs/manual/guage_pointer_t.md
View File

@ -2,33 +2,34 @@
### 概述 ### 概述
![image](images/guage_pointer_t_0.png) ![image](images/guage_pointer_t_0.png)
仪表指针控件。 仪表指针控件。
仪表指针就是一张旋转的图片，图片可以是普通图片也可以是SVG图片。 仪表指针就是一张旋转的图片，图片可以是普通图片也可以是SVG图片。
在嵌入式平台上，对于旋转的图片，SVG图片的效率比位图高数倍，所以推荐使用SVG图片。 在嵌入式平台上，对于旋转的图片，SVG图片的效率比位图高数倍，所以推荐使用SVG图片。
guage\_pointer\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于guage\_pointer\_t控件。 guage\_pointer\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于guage\_pointer\_t控件。
在xml中使用"guage\_pointer"标签创建仪表指针控件。如： 在xml中使用"guage\_pointer"标签创建仪表指针控件。如：
```xml ```xml
<guage_pointer x="c" y="50" w="24" h="140" value="-128" image="guage_pointer" /> <guage_pointer x="c" y="50" w="24" h="140" value="-128" image="guage_pointer" />
``` ```
> 更多用法请参考： > 更多用法请参考：
[guage.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/guage.xml) [guage.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/guage.xml)
在c代码中使用函数guage\_pointer\_create创建仪表指针控件。如： 在c代码中使用函数guage\_pointer\_create创建仪表指针控件。如：
```c ```c
widget_t* guage_pointer = guage_pointer_create(guage, 10, 10, 100, 30); widget_t* guage_pointer = guage_pointer_create(guage, 10, 10, 100, 30);
guage_pointer_set_image(guage_pointer, "guage_pointer"); guage_pointer_set_image(guage_pointer, "guage_pointer");
``` ```
> 创建之后，需要用guage\_pointer\_set\_image设置仪表指针图片。 > 创建之后，需要用guage\_pointer\_set\_image设置仪表指针图片。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -55,8 +56,9 @@
* 函数功能： * 函数功能：
> <p id="guage_pointer_t_guage_pointer_cast"> 转换为guage_pointer对象(供脚本语言使用)。 > <p id="guage_pointer_t_guage_pointer_cast"> 转换为guage_pointer对象(供脚本语言使用)。
* 函数原型： * 函数原型：
@ -76,8 +78,9 @@ widget_t* guage_pointer_cast (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="guage_pointer_t_guage_pointer_create"> 创建guage_pointer对象 > <p id="guage_pointer_t_guage_pointer_create"> 创建guage_pointer对象
* 函数原型： * 函数原型：
@ -101,8 +104,9 @@ widget_t* guage_pointer_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h
* 函数功能： * 函数功能：
> <p id="guage_pointer_t_guage_pointer_set_anchor"> 设置指针的旋转锚点。 > <p id="guage_pointer_t_guage_pointer_set_anchor"> 设置指针的旋转锚点。
* 函数原型： * 函数原型：
@ -124,8 +128,9 @@ ret_t guage_pointer_set_anchor (widget_t* widget, const char* anchor_x, const ch
* 函数功能： * 函数功能：
> <p id="guage_pointer_t_guage_pointer_set_angle"> 设置指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。 > <p id="guage_pointer_t_guage_pointer_set_angle"> 设置指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。
* 函数原型： * 函数原型：
@ -146,8 +151,9 @@ ret_t guage_pointer_set_angle (widget_t* widget, int32_t angle);
* 函数功能： * 函数功能：
> <p id="guage_pointer_t_guage_pointer_set_image"> 设置指针的图片。 > <p id="guage_pointer_t_guage_pointer_set_image"> 设置指针的图片。
* 函数原型： * 函数原型：
@ -165,7 +171,8 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
| image | const char* | 指针的图片。 | | image | const char* | 指针的图片。 |
#### anchor\_x 属性 #### anchor\_x 属性
----------------------- -----------------------
> <p id="guage_pointer_t_anchor_x"> 旋转锚点x坐标。 > <p id="guage_pointer_t_anchor_x"> 旋转锚点x坐标。
* 类型：float\_t * 类型：float\_t
@ -182,7 +189,8 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### anchor\_y 属性 #### anchor\_y 属性
----------------------- -----------------------
> <p id="guage_pointer_t_anchor_y"> 旋转锚点y坐标。 > <p id="guage_pointer_t_anchor_y"> 旋转锚点y坐标。
* 类型：float\_t * 类型：float\_t
@ -199,7 +207,8 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### angle 属性 #### angle 属性
----------------------- -----------------------
> <p id="guage_pointer_t_angle"> 指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。 > <p id="guage_pointer_t_angle"> 指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。
* 类型：int32\_t * 类型：int32\_t
@ -216,10 +225,11 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### image 属性 #### image 属性
----------------------- -----------------------
> <p id="guage_pointer_t_image"> 指针图片。 > <p id="guage_pointer_t_image"> 指针图片。
图片须垂直向上，图片的中心点为旋转方向。 图片须垂直向上，图片的中心点为旋转方向。
* 类型：char* * 类型：char*

144
docs/manual/hscroll_label_t.md
View File

@ -2,33 +2,34 @@
### 概述 ### 概述
![image](images/hscroll_label_t_0.png) ![image](images/hscroll_label_t_0.png)
可水平滚动的文本控件，方便实现长文本滚动。 可水平滚动的文本控件，方便实现长文本滚动。
hscroll\_label\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于hscroll\_label\_t控件。 hscroll\_label\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于hscroll\_label\_t控件。
在xml中使用"hscroll\_label"标签创建行号控件，一般配合mledit使用。如： 在xml中使用"hscroll\_label"标签创建行号控件，一般配合mledit使用。如：
```xml ```xml
``` ```
> 更多用法请参考：[mledit.xml]( > 更多用法请参考：[mledit.xml](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/mledit.xml) https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/mledit.xml)
可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如： 可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：
```xml ```xml
<style name="default" text_color="black"> <style name="default" text_color="black">
<normal /> <normal />
<focused /> <focused />
</style> </style>
``` ```
> 更多用法请参考： > 更多用法请参考：
[theme default]( [theme default](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml) https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -65,8 +66,9 @@ https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml)
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_cast"> 转换为hscroll_label对象(供脚本语言使用)。 > <p id="hscroll_label_t_hscroll_label_cast"> 转换为hscroll_label对象(供脚本语言使用)。
* 函数原型： * 函数原型：
@ -86,8 +88,9 @@ widget_t* hscroll_label_cast (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_create"> 创建hscroll_label对象 > <p id="hscroll_label_t_hscroll_label_create"> 创建hscroll_label对象
* 函数原型： * 函数原型：
@ -111,8 +114,9 @@ widget_t* hscroll_label_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_set_duration"> 设置duration。 > <p id="hscroll_label_t_hscroll_label_set_duration"> 设置duration。
* 函数原型： * 函数原型：
@ -133,8 +137,9 @@ ret_t hscroll_label_set_duration (widget_t* widget, int32_t duration);
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_set_ellipses"> 设置ellipses。 > <p id="hscroll_label_t_hscroll_label_set_ellipses"> 设置ellipses。
* 函数原型： * 函数原型：
@ -155,8 +160,9 @@ ret_t hscroll_label_set_ellipses (widget_t* widget, bool_t ellipses);
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_set_loop"> 设置loop。 > <p id="hscroll_label_t_hscroll_label_set_loop"> 设置loop。
* 函数原型： * 函数原型：
@ -177,8 +183,9 @@ ret_t hscroll_label_set_loop (widget_t* widget, bool_t loop);
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_set_lull"> 设置lull。 > <p id="hscroll_label_t_hscroll_label_set_lull"> 设置lull。
* 函数原型： * 函数原型：
@ -199,8 +206,9 @@ ret_t hscroll_label_set_lull (widget_t* widget, int32_t lull);
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_set_only_focus"> 设置only_focus。 > <p id="hscroll_label_t_hscroll_label_set_only_focus"> 设置only_focus。
* 函数原型： * 函数原型：
@ -221,8 +229,9 @@ ret_t hscroll_label_set_only_focus (widget_t* widget, bool_t only_focus);
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_set_xoffset"> 设置x偏移(一般无需用户调用)。。 > <p id="hscroll_label_t_hscroll_label_set_xoffset"> 设置x偏移(一般无需用户调用)。。
* 函数原型： * 函数原型：
@ -243,8 +252,9 @@ ret_t hscroll_label_set_xoffset (widget_t* widget, int32_t xoffset);
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_set_yoyo"> 设置yoyo。 > <p id="hscroll_label_t_hscroll_label_set_yoyo"> 设置yoyo。
* 函数原型： * 函数原型：
@ -265,8 +275,9 @@ ret_t hscroll_label_set_yoyo (widget_t* widget, bool_t yoyo);
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_start"> 启动(一般无需用户调用)。 > <p id="hscroll_label_t_hscroll_label_start"> 启动(一般无需用户调用)。
* 函数原型： * 函数原型：
@ -286,8 +297,9 @@ ret_t hscroll_label_start (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="hscroll_label_t_hscroll_label_stop"> 停止(一般无需用户调用)。 > <p id="hscroll_label_t_hscroll_label_stop"> 停止(一般无需用户调用)。
* 函数原型： * 函数原型：
@ -304,7 +316,8 @@ ret_t hscroll_label_stop (widget_t* widget);
| widget | widget\_t* | 控件对象。 | | widget | widget\_t* | 控件对象。 |
#### duration 属性 #### duration 属性
----------------------- -----------------------
> <p id="hscroll_label_t_duration"> 完整的滚动一次需要的时间(ms)，缺省5000ms。 > <p id="hscroll_label_t_duration"> 完整的滚动一次需要的时间(ms)，缺省5000ms。
* 类型：int32\_t * 类型：int32\_t
@ -319,8 +332,9 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### ellipses 属性 #### ellipses 属性
----------------------- -----------------------
> <p id="hscroll_label_t_ellipses"> > <p id="hscroll_label_t_ellipses">
文本显示不下时，在行尾显示ellipses(缺省FALSE)。 文本显示不下时，在行尾显示ellipses(缺省FALSE)。
* 类型：bool\_t * 类型：bool\_t
@ -337,8 +351,9 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### loop 属性 #### loop 属性
----------------------- -----------------------
> <p id="hscroll_label_t_loop"> > <p id="hscroll_label_t_loop">
loop是否循环滚动(缺省FALSE)。 loop是否循环滚动(缺省FALSE)。
* 类型：bool\_t * 类型：bool\_t
@ -355,8 +370,9 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### lull 属性 #### lull 属性
----------------------- -----------------------
> <p id="hscroll_label_t_lull"> > <p id="hscroll_label_t_lull">
滚动之间的间歇时间(ms)，缺省3000ms。 滚动之间的间歇时间(ms)，缺省3000ms。
* 类型：int32\_t * 类型：int32\_t
@ -373,8 +389,9 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### only\_focus 属性 #### only\_focus 属性
----------------------- -----------------------
> <p id="hscroll_label_t_only_focus"> > <p id="hscroll_label_t_only_focus">
只有处于focus时才滚动(缺省否)。 只有处于focus时才滚动(缺省否)。
* 类型：bool\_t * 类型：bool\_t
@ -391,7 +408,8 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### text\_w 属性 #### text\_w 属性
----------------------- -----------------------
> <p id="hscroll_label_t_text_w"> 文本的宽度。 > <p id="hscroll_label_t_text_w"> 文本的宽度。
* 类型：int32\_t * 类型：int32\_t
@ -406,7 +424,8 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### xoffset 属性 #### xoffset 属性
----------------------- -----------------------
> <p id="hscroll_label_t_xoffset"> 偏移量。 > <p id="hscroll_label_t_xoffset"> 偏移量。
* 类型：int32\_t * 类型：int32\_t
@ -421,8 +440,9 @@ ret_t hscroll_label_stop (widget_t* widget);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### yoyo 属性 #### yoyo 属性
----------------------- -----------------------
> <p id="hscroll_label_t_yoyo"> > <p id="hscroll_label_t_yoyo">
是否往返滚动(缺省FALSE)。 是否往返滚动(缺省FALSE)。
* 类型：bool\_t * 类型：bool\_t

3
docs/manual/hscrollable_t.md
View File

@ -1,5 +1,6 @@
## hscrollable\_t ## hscrollable\_t
### 概述 ### 概述
帮助实现控件左右滚动的效果。 帮助实现控件左右滚动的效果。
---------------------------------- ----------------------------------

29
docs/manual/idle_info_t.md
View File

@ -2,8 +2,9 @@
### 概述 ### 概述
![image](images/idle_info_t_0.png) ![image](images/idle_info_t_0.png)
单个idle的信息。 单个idle的信息。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -27,8 +28,9 @@
* 函数功能： * 函数功能：
> <p id="idle_info_t_idle_info_cast"> 转换为idle_info对象(供脚本语言使用)。 > <p id="idle_info_t_idle_info_cast"> 转换为idle_info对象(供脚本语言使用)。
* 函数原型： * 函数原型：
@ -45,7 +47,8 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
| idle | idle\_info\_t* | idle\_info对象。 | | idle | idle\_info\_t* | idle\_info对象。 |
#### ctx 属性 #### ctx 属性
----------------------- -----------------------
> <p id="idle_info_t_ctx"> idle回调函数上下文。 > <p id="idle_info_t_ctx"> idle回调函数上下文。
* 类型：void* * 类型：void*
@ -57,9 +60,10 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### id 属性 #### id 属性
----------------------- -----------------------
> <p id="idle_info_t_id"> idle的ID > <p id="idle_info_t_id"> idle的ID
> 为TK\_INVALID\_ID时表示无效idle。 > 为TK\_INVALID\_ID时表示无效idle。
* 类型：uint32\_t * 类型：uint32\_t
@ -71,7 +75,8 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### on\_destroy 属性 #### on\_destroy 属性
----------------------- -----------------------
> <p id="idle_info_t_on_destroy"> idle销毁时的回调函数。 > <p id="idle_info_t_on_destroy"> idle销毁时的回调函数。
* 类型：tk\_destroy\_t * 类型：tk\_destroy\_t
@ -82,7 +87,8 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### on\_destroy\_ctx 属性 #### on\_destroy\_ctx 属性
----------------------- -----------------------
> <p id="idle_info_t_on_destroy_ctx"> idle销毁时的回调函数的上下文。 > <p id="idle_info_t_on_destroy_ctx"> idle销毁时的回调函数的上下文。
* 类型：tk\_destroy\_t * 类型：tk\_destroy\_t
@ -93,7 +99,8 @@ idle_info_t* idle_info_cast (idle_info_t* idle);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### on\_idle 属性 #### on\_idle 属性
----------------------- -----------------------
> <p id="idle_info_t_on_idle"> idle回调函数。 > <p id="idle_info_t_on_idle"> idle回调函数。
* 类型：idle\_func\_t * 类型：idle\_func\_t

72
docs/manual/idle_t.md
View File

@ -1,28 +1,29 @@
## idle\_t ## idle\_t
### 概述 ### 概述
idle可以看作是duration为0的定时器。 idle可以看作是duration为0的定时器。
> idle可以用来实现一些异步处理。 > idle可以用来实现一些异步处理。
示例： 示例：
```c ```c
static ret_t something_on_idle(const idle_info_t* info) { static ret_t something_on_idle(const idle_info_t* info) {
widget_t* widget = WIDGET(info->ctx); widget_t* widget = WIDGET(info->ctx);
edit_t* edit = EDIT(widget); edit_t* edit = EDIT(widget);
... ...
return RET_REMOVE; return RET_REMOVE;
} }
... ...
idle_add(something_on_idle, edit); idle_add(something_on_idle, edit);
``` ```
> 在非GUI线程请用idle\_queue。 > 在非GUI线程请用idle\_queue。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -40,8 +41,9 @@
* 函数功能： * 函数功能：
> <p id="idle_t_idle_add"> 增加一个idle。 > <p id="idle_t_idle_add"> 增加一个idle。
* 函数原型： * 函数原型：
@ -62,8 +64,9 @@ uint32_t idle_add (idle_func_t on_idle, void* ctx);
* 函数功能： * 函数功能：
> <p id="idle_t_idle_count"> 返回idle的个数。 > <p id="idle_t_idle_count"> 返回idle的个数。
* 函数原型： * 函数原型：
@ -82,8 +85,9 @@ uint32_t idle_count ();
* 函数功能： * 函数功能：
> <p id="idle_t_idle_queue"> 用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。 > <p id="idle_t_idle_queue"> 用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。
* 函数原型： * 函数原型：
@ -104,8 +108,9 @@ ret_t idle_queue (idle_func_t on_idle, void* ctx);
* 函数功能： * 函数功能：
> <p id="idle_t_idle_remove"> 删除指定的idle。 > <p id="idle_t_idle_remove"> 删除指定的idle。
* 函数原型： * 函数原型：
@ -125,8 +130,9 @@ ret_t idle_remove (uint32_t idle_id);
* 函数功能： * 函数功能：
> <p id="idle_t_idle_set_on_destroy"> 设置一个回调函数，在idle被销毁时调用(方便脚本语言去释放回调函数)。 > <p id="idle_t_idle_set_on_destroy"> 设置一个回调函数，在idle被销毁时调用(方便脚本语言去释放回调函数)。
* 函数原型： * 函数原型：

9
docs/manual/im_action_button_info_event_t.md
View File

@ -2,7 +2,8 @@
### 概述 ### 概述
![image](images/im_action_button_info_event_t_0.png) ![image](images/im_action_button_info_event_t_0.png)
设置软键盘上的action按钮的信息事件。 设置软键盘上的action按钮的信息事件。
---------------------------------- ----------------------------------
### 属性 ### 属性
@ -14,7 +15,8 @@
| <a href="#im_action_button_info_event_t_text">text</a> | char* | 软键盘上的action按钮显示的文本。 | | <a href="#im_action_button_info_event_t_text">text</a> | char* | 软键盘上的action按钮显示的文本。 |
#### enable 属性 #### enable 属性
----------------------- -----------------------
> <p id="im_action_button_info_event_t_enable"> 软键盘上的action按钮启用。 > <p id="im_action_button_info_event_t_enable"> 软键盘上的action按钮启用。
* 类型：bool\_t * 类型：bool\_t
@ -25,7 +27,8 @@
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### text 属性 #### text 属性
----------------------- -----------------------
> <p id="im_action_button_info_event_t_text"> 软键盘上的action按钮显示的文本。 > <p id="im_action_button_info_event_t_text"> 软键盘上的action按钮显示的文本。
* 类型：char* * 类型：char*

9
docs/manual/im_candidates_event_t.md
View File

@ -2,7 +2,8 @@
### 概述 ### 概述
![image](images/im_candidates_event_t_0.png) ![image](images/im_candidates_event_t_0.png)
输入法请求显示候选字的事件。 输入法请求显示候选字的事件。
---------------------------------- ----------------------------------
### 属性 ### 属性
@ -14,7 +15,8 @@
| <a href="#im_candidates_event_t_candidates_nr">candidates\_nr</a> | uint32\_t | 可选的文本的个数。 | | <a href="#im_candidates_event_t_candidates_nr">candidates\_nr</a> | uint32\_t | 可选的文本的个数。 |
#### candidates 属性 #### candidates 属性
----------------------- -----------------------
> <p id="im_candidates_event_t_candidates"> 可选的文本，多个文本以\0分隔。如：里\0李\0力\0离\0 > <p id="im_candidates_event_t_candidates"> 可选的文本，多个文本以\0分隔。如：里\0李\0力\0离\0
* 类型：char* * 类型：char*
@ -25,7 +27,8 @@
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### candidates\_nr 属性 #### candidates\_nr 属性
----------------------- -----------------------
> <p id="im_candidates_event_t_candidates_nr"> 可选的文本的个数。 > <p id="im_candidates_event_t_candidates_nr"> 可选的文本的个数。
* 类型：uint32\_t * 类型：uint32\_t

9
docs/manual/im_commit_event_t.md
View File

@ -2,7 +2,8 @@
### 概述 ### 概述
![image](images/im_commit_event_t_0.png) ![image](images/im_commit_event_t_0.png)
输入法提交输入的文本事件。 输入法提交输入的文本事件。
---------------------------------- ----------------------------------
### 属性 ### 属性
@ -14,7 +15,8 @@
| <a href="#im_commit_event_t_text">text</a> | char* | 提交的文本。 | | <a href="#im_commit_event_t_text">text</a> | char* | 提交的文本。 |
#### replace; 属性 #### replace; 属性
----------------------- -----------------------
> <p id="im_commit_event_t_replace;"> 是否替换原来的文本。 > <p id="im_commit_event_t_replace;"> 是否替换原来的文本。
* 类型：bool\_t * 类型：bool\_t
@ -25,7 +27,8 @@
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### text 属性 #### text 属性
----------------------- -----------------------
> <p id="im_commit_event_t_text"> 提交的文本。 > <p id="im_commit_event_t_text"> 提交的文本。
* 类型：char* * 类型：char*

4
docs/manual/image_draw_type_t.md
View File

@ -1,6 +1,7 @@
## image\_draw\_type\_t ## image\_draw\_type\_t
### 概述 ### 概述
图片绘制方法常量定义。 图片绘制方法常量定义。
### 常量 ### 常量
<p id="image_draw_type_t_consts"> <p id="image_draw_type_t_consts">
@ -17,6 +18,7 @@
| IMAGE\_DRAW\_REPEAT | 平铺显示。 | | IMAGE\_DRAW\_REPEAT | 平铺显示。 |
| IMAGE\_DRAW\_REPEAT\_X | 水平方向平铺显示，垂直方向缩放。 | | IMAGE\_DRAW\_REPEAT\_X | 水平方向平铺显示，垂直方向缩放。 |
| IMAGE\_DRAW\_REPEAT\_Y | 垂直方向平铺显示，水平方向缩放。 | | IMAGE\_DRAW\_REPEAT\_Y | 垂直方向平铺显示，水平方向缩放。 |
| IMAGE\_DRAW\_REPEAT\_Y\_INVERSE | 垂直方向平铺显示，水平方向缩放(从底部到顶部)。 |
| IMAGE\_DRAW\_PATCH9 | 9宫格显示。 将图片分成等大小的9块，4个角按原大小显示在目标矩形的4个角，左右上下和中间5块分别缩放显示在对应的目标区域。 | | IMAGE\_DRAW\_PATCH9 | 9宫格显示。 将图片分成等大小的9块，4个角按原大小显示在目标矩形的4个角，左右上下和中间5块分别缩放显示在对应的目标区域。 |
| IMAGE\_DRAW\_PATCH3\_X | 水平方向3宫格显示，垂直方向居中显示。 将图片在水平方向上分成等大小的3块，左右两块按原大小显示在目标矩形的左右，中间一块缩放显示在目标区域中间剩余部分。 | | IMAGE\_DRAW\_PATCH3\_X | 水平方向3宫格显示，垂直方向居中显示。 将图片在水平方向上分成等大小的3块，左右两块按原大小显示在目标矩形的左右，中间一块缩放显示在目标区域中间剩余部分。 |
| IMAGE\_DRAW\_PATCH3\_Y | 垂直方向3宫格显示，水平方向居中显示。 将图片在垂直方向上分成等大小的3块，上下两块按原大小显示在目标矩形的上下，中间一块缩放显示在目标区域中间剩余部分。 | | IMAGE\_DRAW\_PATCH3\_Y | 垂直方向3宫格显示，水平方向居中显示。 将图片在垂直方向上分成等大小的3块，上下两块按原大小显示在目标矩形的上下，中间一块缩放显示在目标区域中间剩余部分。 |

18
docs/manual/image_loader_stb_t.md
View File

@ -2,11 +2,12 @@
### 概述 ### 概述
![image](images/image_loader_stb_t_0.png) ![image](images/image_loader_stb_t_0.png)
stb图片加载器。 stb图片加载器。
stb主要用于加载jpg/png/gif等格式的图片，它功能强大，体积小巧。 stb主要用于加载jpg/png/gif等格式的图片，它功能强大，体积小巧。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -20,9 +21,10 @@
* 函数功能： * 函数功能：
> <p id="image_loader_stb_t_image_loader_stb"> > <p id="image_loader_stb_t_image_loader_stb">
获取stb图片加载器对象。 获取stb图片加载器对象。
* 函数原型： * 函数原型：

29
docs/manual/image_loader_t.md
View File

@ -1,6 +1,7 @@
## image\_loader\_t ## image\_loader\_t
### 概述 ### 概述
图片加载接口。 图片加载接口。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -17,8 +18,9 @@
* 函数功能： * 函数功能：
> <p id="image_loader_t_image_loader_load"> 加载图片。 > <p id="image_loader_t_image_loader_load"> 加载图片。
* 函数原型： * 函数原型：
@ -40,9 +42,10 @@ ret_t image_loader_load (image_loader_t* loader, const asset_info_t* asset, bitm
* 函数功能： * 函数功能：
> <p id="image_loader_t_image_loader_load_image"> 查找满足条件加载器并加载图片。 > <p id="image_loader_t_image_loader_load_image"> 查找满足条件加载器并加载图片。
* 函数原型： * 函数原型：
@ -63,9 +66,10 @@ ret_t image_loader_load_image (const asset_info_t* asset, bitmap_t* bitmap);
* 函数功能： * 函数功能：
> <p id="image_loader_t_image_loader_register"> 注册图片加载器。 > <p id="image_loader_t_image_loader_register"> 注册图片加载器。
* 函数原型： * 函数原型：
@ -85,9 +89,10 @@ ret_t image_loader_register (image_loader_t* loader);
* 函数功能： * 函数功能：
> <p id="image_loader_t_image_loader_unregister"> 注销图片加载器。 > <p id="image_loader_t_image_loader_unregister"> 注销图片加载器。
* 函数原型： * 函数原型：

78
docs/manual/image_manager_t.md
View File

@ -1,6 +1,7 @@
## image\_manager\_t ## image\_manager\_t
### 概述 ### 概述
图片管理器。负责加载，解码和缓存图片。 图片管理器。负责加载，解码和缓存图片。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -29,7 +30,8 @@
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager"> 获取缺省的图片管理器。 > <p id="image_manager_t_image_manager"> 获取缺省的图片管理器。
* 函数原型： * 函数原型：
@ -48,8 +50,9 @@ image_manager_t* image_manager ();
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_create"> 创建图片管理器。 > <p id="image_manager_t_image_manager_create"> 创建图片管理器。
* 函数原型： * 函数原型：
@ -68,8 +71,9 @@ image_manager_t* image_manager_create ();
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_deinit"> 析构图片管理器。 > <p id="image_manager_t_image_manager_deinit"> 析构图片管理器。
* 函数原型： * 函数原型：
@ -89,8 +93,9 @@ ret_t image_manager_deinit (image_manager_t* imm);
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_destroy"> 析构并释放图片管理器。 > <p id="image_manager_t_image_manager_destroy"> 析构并释放图片管理器。
* 函数原型： * 函数原型：
@ -110,10 +115,11 @@ ret_t image_manager_destroy (image_manager_t* imm);
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_get_bitmap"> 获取指定的图片。 > <p id="image_manager_t_image_manager_get_bitmap"> 获取指定的图片。
先从缓存查找，如果没找到，再加载并缓存。 先从缓存查找，如果没找到，再加载并缓存。
* 函数原型： * 函数原型：
@ -135,8 +141,9 @@ ret_t image_manager_get_bitmap (image_manager_t* imm, char* name, bitmap_t* imag
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_init"> 初始化图片管理器。 > <p id="image_manager_t_image_manager_init"> 初始化图片管理器。
* 函数原型： * 函数原型：
@ -156,8 +163,9 @@ image_manager_t* image_manager_init (image_manager_t* imm);
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_set"> 设置缺省的图片管理器。 > <p id="image_manager_t_image_manager_set"> 设置缺省的图片管理器。
* 函数原型： * 函数原型：
@ -177,17 +185,18 @@ ret_t image_manager_set (image_manager_t* imm);
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_set_assets_manager"> 设置资源管理器对象。 > <p id="image_manager_t_image_manager_set_assets_manager"> 设置资源管理器对象。
之所以需要设置资源管理器对象，而不是使用缺省的资源管理器对象，是因为在designer中有两个图片管理器： 之所以需要设置资源管理器对象，而不是使用缺省的资源管理器对象，是因为在designer中有两个图片管理器：
* 一个用于designer本身加载图片。 * 一个用于designer本身加载图片。
* 一个用于被设计的窗口加载图片。 * 一个用于被设计的窗口加载图片。
这两个图片管理器需要从不同的路径加载资源。 这两个图片管理器需要从不同的路径加载资源。
* 函数原型： * 函数原型：
@ -208,8 +217,9 @@ ret_t image_manager_set_assets_manager (image_manager_t* imm, assets_manager_t*
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_unload_bitmap"> 从图片管理器中卸载指定的图片。 > <p id="image_manager_t_image_manager_unload_bitmap"> 从图片管理器中卸载指定的图片。
* 函数原型： * 函数原型：
@ -230,8 +240,9 @@ ret_t image_manager_unload_bitmap (image_manager_t* imm, bitmap_t* image);
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_unload_unused"> 从图片管理器中卸载指定时间内没有使用的图片。 > <p id="image_manager_t_image_manager_unload_unused"> 从图片管理器中卸载指定时间内没有使用的图片。
* 函数原型： * 函数原型：
@ -252,8 +263,9 @@ ret_t image_manager_unload_unused (image_manager_t* imm, uint32_t time_delta_s);
* 函数功能： * 函数功能：
> <p id="image_manager_t_image_manager_update_specific"> 更新缓存中图片的specific信息。 > <p id="image_manager_t_image_manager_update_specific"> 更新缓存中图片的specific信息。
* 函数原型： * 函数原型：

BIN
docs/manual/images/tk_iostream_noisy_t_0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.9 KiB

BIN
docs/manual/images/tk_iostream_shdlc_t_0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.9 KiB

BIN
docs/manual/images/tk_istream_shdlc_t_0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.9 KiB

BIN
docs/manual/images/tk_ostream_noisy_t_0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.9 KiB

BIN
docs/manual/images/tk_ostream_shdlc_t_0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.9 KiB

3
docs/manual/indicator_default_paint_t.md
View File

@ -1,6 +1,7 @@
## indicator\_default\_paint\_t ## indicator\_default\_paint\_t
### 概述 ### 概述
指示器默认绘制的类型。 指示器默认绘制的类型。
### 常量 ### 常量
<p id="indicator_default_paint_t_consts"> <p id="indicator_default_paint_t_consts">

22
docs/manual/input_engine_null_t.md
View File

@ -2,12 +2,13 @@
### 概述 ### 概述
![image](images/input_engine_null_t_0.png) ![image](images/input_engine_null_t_0.png)
空输入法引擎实现。 空输入法引擎实现。
缺省输入法可以选择启用软键盘，但不启用具体的输入法引擎，此时可以选择空输入法引擎实现。 缺省输入法可以选择启用软键盘，但不启用具体的输入法引擎，此时可以选择空输入法引擎实现。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -21,10 +22,11 @@
* 函数功能： * 函数功能：
> <p id="input_engine_null_t_input_engine_create"> > <p id="input_engine_null_t_input_engine_create">
创建空输入法引擎对象。 创建空输入法引擎对象。
* 函数原型： * 函数原型：

22
docs/manual/input_engine_pinyin_t.md
View File

@ -2,12 +2,13 @@
### 概述 ### 概述
![image](images/input_engine_pinyin_t_0.png) ![image](images/input_engine_pinyin_t_0.png)
拼音输入法引擎实现。 拼音输入法引擎实现。
基于谷歌拼音输入法实现。 基于谷歌拼音输入法实现。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -21,10 +22,11 @@
* 函数功能： * 函数功能：
> <p id="input_engine_pinyin_t_input_engine_create"> > <p id="input_engine_pinyin_t_input_engine_create">
创建拼音输入法引擎对象。 创建拼音输入法引擎对象。
* 函数原型： * 函数原型：

39
docs/manual/input_engine_t.md
View File

@ -1,15 +1,16 @@
## input\_engine\_t ## input\_engine\_t
### 概述 ### 概述
输入法引擎接口。 输入法引擎接口。
常见的实现方式有以下几种： 常见的实现方式有以下几种：
* 空实现。用于不需要输入法的嵌入式平台。 * 空实现。用于不需要输入法的嵌入式平台。
* 拼音输入法实现。用于需要输入法的嵌入式平台。 * 拼音输入法实现。用于需要输入法的嵌入式平台。
![image](images/input_engine_t_0.png) ![image](images/input_engine_t_0.png)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -31,8 +32,9 @@
* 函数功能： * 函数功能：
> <p id="input_engine_t_input_engine_create"> 创建输入法引擎对象。 > <p id="input_engine_t_input_engine_create"> 创建输入法引擎对象。
* 函数原型： * 函数原型：
@ -51,8 +53,9 @@ input_engine_t* input_engine_create ();
* 函数功能： * 函数功能：
> <p id="input_engine_t_input_engine_destroy"> 销毁输入法引擎对象。 > <p id="input_engine_t_input_engine_destroy"> 销毁输入法引擎对象。
* 函数原型： * 函数原型：
@ -72,8 +75,9 @@ ret_t input_engine_destroy (input_engine_t* engine);
* 函数功能： * 函数功能：
> <p id="input_engine_t_input_engine_input"> 输入新的按键，并更新候选字。 > <p id="input_engine_t_input_engine_input"> 输入新的按键，并更新候选字。
* 函数原型： * 函数原型：
@ -94,8 +98,9 @@ ret_t input_engine_input (input_engine_t* engine, int key);
* 函数功能： * 函数功能：
> <p id="input_engine_t_input_engine_reset_input"> 清除所有输入的按键组合和候选字。 > <p id="input_engine_t_input_engine_reset_input"> 清除所有输入的按键组合和候选字。
* 函数原型： * 函数原型：

26
docs/manual/input_method_default_t.md
View File

@ -2,14 +2,15 @@
### 概述 ### 概述
![image](images/input_method_default_t_0.png) ![image](images/input_method_default_t_0.png)
缺省输入法实现。输入法会启用软键盘，但是开发者可以自定义输入法引擎。 缺省输入法实现。输入法会启用软键盘，但是开发者可以自定义输入法引擎。
目前可以选择不启用输入法引擎或启用拼音输入法引擎。 目前可以选择不启用输入法引擎或启用拼音输入法引擎。
开发者也可以开发手写输入法或语音输入法，如果实现时遇到问题可以和我们交流。 开发者也可以开发手写输入法或语音输入法，如果实现时遇到问题可以和我们交流。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -23,10 +24,11 @@
* 函数功能： * 函数功能：
> <p id="input_method_default_t_input_method_default_create"> > <p id="input_method_default_t_input_method_default_create">
创建缺省输入法对象。 创建缺省输入法对象。
* 函数原型： * 函数原型：

22
docs/manual/input_method_null_t.md
View File

@ -2,12 +2,13 @@
### 概述 ### 概述
![image](images/input_method_null_t_0.png) ![image](images/input_method_null_t_0.png)
空输入法实现。 空输入法实现。
在不需要输入法的嵌入式平台使用空的输入法。 在不需要输入法的嵌入式平台使用空的输入法。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -21,10 +22,11 @@
* 函数功能： * 函数功能：
> <p id="input_method_null_t_input_method_null_create"> > <p id="input_method_null_t_input_method_null_create">
创建空输入法对象。 创建空输入法对象。
* 函数原型： * 函数原型：

27
docs/manual/input_method_sdl_t.md
View File

@ -2,12 +2,13 @@
### 概述 ### 概述
![image](images/input_method_sdl_t_0.png) ![image](images/input_method_sdl_t_0.png)
SDL输入法实现。 SDL输入法实现。
SDL输入法使用平台自身的输入法引擎，一般在桌面Linux、MacOS、Windows、Android和iOS上使用。 SDL输入法使用平台自身的输入法引擎，一般在桌面Linux、MacOS、Windows、Android和iOS上使用。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -22,8 +23,9 @@
* 函数功能： * 函数功能：
> <p id="input_method_sdl_t_children_layouter_register_builtins"> 注册内置的子控件布局算法。 > <p id="input_method_sdl_t_children_layouter_register_builtins"> 注册内置的子控件布局算法。
* 函数原型： * 函数原型：
@ -42,10 +44,11 @@ ret_t children_layouter_register_builtins ();
* 函数功能： * 函数功能：
> <p id="input_method_sdl_t_input_method_sdl_create"> > <p id="input_method_sdl_t_input_method_sdl_create">
创建SDL输入法对象。 创建SDL输入法对象。
* 函数原型： * 函数原型：

113
docs/manual/input_method_t.md
View File

@ -1,20 +1,21 @@
## input\_method\_t ## input\_method\_t
### 概述 ### 概述
输入法接口。 输入法接口。
常见的实现方式有以下几种： 常见的实现方式有以下几种：
* 空实现。用于不需要输入法的嵌入式平台。 * 空实现。用于不需要输入法的嵌入式平台。
* 缺省实现。用于需要输入法的嵌入式平台。 * 缺省实现。用于需要输入法的嵌入式平台。
* 基于SDL实现的平台原生输入法。用于桌面系统和手机系统。 * 基于SDL实现的平台原生输入法。用于桌面系统和手机系统。
![image](images/input_method_t_0.png) ![image](images/input_method_t_0.png)
> 输入类型请参考：[input\_type](input_type_t.md) > 输入类型请参考：[input\_type](input_type_t.md)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -50,8 +51,9 @@
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method"> 获取全局输入法对象。 > <p id="input_method_t_input_method"> 获取全局输入法对象。
* 函数原型： * 函数原型：
@ -70,8 +72,9 @@ input_method_t* input_method ();
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_commit_text"> 提交输入文本。 > <p id="input_method_t_input_method_commit_text"> 提交输入文本。
* 函数原型： * 函数原型：
@ -92,8 +95,9 @@ ret_t input_method_commit_text (input_method_t* im, char* text);
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_commit_text_ex"> 提交输入文本。 > <p id="input_method_t_input_method_commit_text_ex"> 提交输入文本。
* 函数原型： * 函数原型：
@ -115,8 +119,9 @@ ret_t input_method_commit_text_ex (input_method_t* im, bool_t replace, char* tex
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_create"> 创建输入法对象。在具体实现中实现。 > <p id="input_method_t_input_method_create"> 创建输入法对象。在具体实现中实现。
* 函数原型： * 函数原型：
@ -135,8 +140,9 @@ input_method_t* input_method_create ();
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_destroy"> 销毁输入法对象。在具体实现中实现。 > <p id="input_method_t_input_method_destroy"> 销毁输入法对象。在具体实现中实现。
* 函数原型： * 函数原型：
@ -156,8 +162,9 @@ ret_t input_method_destroy (input_method_t* im);
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_dispatch"> 分发一个事件。 > <p id="input_method_t_input_method_dispatch"> 分发一个事件。
* 函数原型： * 函数原型：
@ -178,8 +185,9 @@ ret_t input_method_dispatch (input_method_t* im, event_t* e);
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_dispatch_action"> 软键盘上的action按钮被点击时，调用本函数分发EVT_IM_ACTION事件。 > <p id="input_method_t_input_method_dispatch_action"> 软键盘上的action按钮被点击时，调用本函数分发EVT_IM_ACTION事件。
* 函数原型： * 函数原型：
@ -199,8 +207,9 @@ ret_t input_method_dispatch_action (input_method_t* im);
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_dispatch_candidates"> 请求显示候选字。 > <p id="input_method_t_input_method_dispatch_candidates"> 请求显示候选字。
* 函数原型： * 函数原型：
@ -222,8 +231,9 @@ ret_t input_method_dispatch_candidates (input_method_t* im, char* strs, uint32_t
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_dispatch_key"> 提交按键。 > <p id="input_method_t_input_method_dispatch_key"> 提交按键。
* 函数原型： * 函数原型：
@ -244,8 +254,9 @@ ret_t input_method_dispatch_key (input_method_t* im, uint32_t key);
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_dispatch_to_widget"> 分发一个事件当前焦点控件。 > <p id="input_method_t_input_method_dispatch_to_widget"> 分发一个事件当前焦点控件。
* 函数原型： * 函数原型：
@ -266,8 +277,9 @@ ret_t input_method_dispatch_to_widget (input_method_t* im, event_t* e);
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_off"> 注销指定事件的处理函数。 > <p id="input_method_t_input_method_off"> 注销指定事件的处理函数。
* 函数原型： * 函数原型：
@ -288,8 +300,9 @@ ret_t input_method_off (input_method_t* im, uint32_t id);
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_on"> 注册指定事件的处理函数。 > <p id="input_method_t_input_method_on"> 注册指定事件的处理函数。
* 函数原型： * 函数原型：
@ -312,8 +325,9 @@ uint32_t input_method_on (input_method_t* im, event_type_t type, event_func_t on
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_request"> 打开或关闭输入法。 > <p id="input_method_t_input_method_request"> 打开或关闭输入法。
* 函数原型： * 函数原型：
@ -334,8 +348,9 @@ ret_t input_method_request (input_method_t* im, widget_t* widget);
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_set"> 设置全局输入法对象。 > <p id="input_method_t_input_method_set"> 设置全局输入法对象。
* 函数原型： * 函数原型：
@ -355,8 +370,9 @@ ret_t input_method_set (input_method_t* im);
* 函数功能： * 函数功能：
> <p id="input_method_t_input_method_update_action_button_info"> 设置软键盘上的action按钮的信息。 > <p id="input_method_t_input_method_update_action_button_info"> 设置软键盘上的action按钮的信息。
* 函数原型： * 函数原型：
@ -375,7 +391,8 @@ ret_t input_method_update_action_button_info (input_method_t* im, char* text, bo
| enable | bool\_t | 按钮的是否可用。 | | enable | bool\_t | 按钮的是否可用。 |
#### action\_button\_enable 属性 #### action\_button\_enable 属性
----------------------- -----------------------
> <p id="input_method_t_action_button_enable"> 软键盘的上的action按钮是否可用。 > <p id="input_method_t_action_button_enable"> 软键盘的上的action按钮是否可用。
* 类型：bool\_t * 类型：bool\_t
@ -386,7 +403,8 @@ ret_t input_method_update_action_button_info (input_method_t* im, char* text, bo
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### action\_button\_enable 属性 #### action\_button\_enable 属性
----------------------- -----------------------
> <p id="input_method_t_action_button_enable"> 软键盘的上的action按钮文本。 > <p id="input_method_t_action_button_enable"> 软键盘的上的action按钮文本。
* 类型：bool\_t * 类型：bool\_t
@ -397,7 +415,8 @@ ret_t input_method_update_action_button_info (input_method_t* im, char* text, bo
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### input\_type 属性 #### input\_type 属性
----------------------- -----------------------
> <p id="input_method_t_input_type"> 当前输入的类型。 > <p id="input_method_t_input_type"> 当前输入的类型。
* 类型：input\_type\_t * 类型：input\_type\_t

3
docs/manual/input_type_t.md
View File

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

3
docs/manual/key_code_t.md
View File

@ -1,6 +1,7 @@
## key\_code\_t ## key\_code\_t
### 概述 ### 概述
key code。 key code。
### 常量 ### 常量
<p id="key_code_t_consts"> <p id="key_code_t_consts">

56
docs/manual/key_event_t.md
View File

@ -2,7 +2,8 @@
### 概述 ### 概述
![image](images/key_event_t_0.png) ![image](images/key_event_t_0.png)
按键事件。 按键事件。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -35,8 +36,9 @@
* 函数功能： * 函数功能：
> <p id="key_event_t_key_event_cast"> 把event对象转key_event_t对象，主要给脚本语言使用。 > <p id="key_event_t_key_event_cast"> 把event对象转key_event_t对象，主要给脚本语言使用。
* 函数原型： * 函数原型：
@ -56,8 +58,9 @@ key_event_t* key_event_cast (event_t* event);
* 函数功能： * 函数功能：
> <p id="key_event_t_key_event_init"> 初始化事件。 > <p id="key_event_t_key_event_init"> 初始化事件。
* 函数原型： * 函数原型：
@ -77,7 +80,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| key | int32\_t | key的值。 | | key | int32\_t | key的值。 |
#### alt 属性 #### alt 属性
----------------------- -----------------------
> <p id="key_event_t_alt"> alt键是否按下。 > <p id="key_event_t_alt"> alt键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -89,7 +93,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### capslock 属性 #### capslock 属性
----------------------- -----------------------
> <p id="key_event_t_capslock"> capslock键是否按下。 > <p id="key_event_t_capslock"> capslock键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -101,8 +106,9 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### cmd 属性 #### cmd 属性
----------------------- -----------------------
> <p id="key_event_t_cmd"> left shift键是否按下。 > <p id="key_event_t_cmd"> left shift键是否按下。
cmd/win键是否按下。 cmd/win键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -114,8 +120,9 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### ctrl 属性 #### ctrl 属性
----------------------- -----------------------
> <p id="key_event_t_ctrl"> right alt键是否按下。 > <p id="key_event_t_ctrl"> right alt键是否按下。
ctrl键是否按下。 ctrl键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -127,7 +134,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### key 属性 #### key 属性
----------------------- -----------------------
> <p id="key_event_t_key"> 键值。 > <p id="key_event_t_key"> 键值。
* 类型：uint32\_t * 类型：uint32\_t
@ -139,7 +147,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### lalt 属性 #### lalt 属性
----------------------- -----------------------
> <p id="key_event_t_lalt"> left alt键是否按下。 > <p id="key_event_t_lalt"> left alt键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -151,7 +160,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### lctrl 属性 #### lctrl 属性
----------------------- -----------------------
> <p id="key_event_t_lctrl"> left ctrl键是否按下。 > <p id="key_event_t_lctrl"> left ctrl键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -163,7 +173,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### lshift 属性 #### lshift 属性
----------------------- -----------------------
> <p id="key_event_t_lshift"> left shift键是否按下。 > <p id="key_event_t_lshift"> left shift键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -175,7 +186,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### menu 属性 #### menu 属性
----------------------- -----------------------
> <p id="key_event_t_menu"> menu键是否按下。 > <p id="key_event_t_menu"> menu键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -187,7 +199,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### ralt 属性 #### ralt 属性
----------------------- -----------------------
> <p id="key_event_t_ralt"> right alt键是否按下。 > <p id="key_event_t_ralt"> right alt键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -199,7 +212,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### rctrl 属性 #### rctrl 属性
----------------------- -----------------------
> <p id="key_event_t_rctrl"> right ctrl键是否按下。 > <p id="key_event_t_rctrl"> right ctrl键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -211,7 +225,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### rshift 属性 #### rshift 属性
----------------------- -----------------------
> <p id="key_event_t_rshift"> right shift键是否按下。 > <p id="key_event_t_rshift"> right shift键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -223,7 +238,8 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### shift 属性 #### shift 属性
----------------------- -----------------------
> <p id="key_event_t_shift"> shift键是否按下。 > <p id="key_event_t_shift"> shift键是否按下。
* 类型：bool\_t * 类型：bool\_t

95
docs/manual/line_number_t.md
View File

@ -2,38 +2,39 @@
### 概述 ### 概述
![image](images/line_number_t_0.png) ![image](images/line_number_t_0.png)
行号。多行编辑器的行号。 行号。多行编辑器的行号。
line\_number\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于line\_number\_t控件。 line\_number\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于line\_number\_t控件。
在xml中使用"lin\e_number"标签创建行号控件，一般配合mledit使用。如： 在xml中使用"lin\e_number"标签创建行号控件，一般配合mledit使用。如：
```xml ```xml
<mledit x="c" y="10" h="40%" w="90%" focus="true" left_margin="36" right_margin="16" <mledit x="c" y="10" h="40%" w="90%" focus="true" left_margin="36" right_margin="16"
wrap_word="true"> wrap_word="true">
<line_number x="0" y="0" w="32" h="100%" value="0"/> <line_number x="0" y="0" w="32" h="100%" value="0"/>
<scroll_bar_d x="right" y="0" w="14" h="100%" value="0"/> <scroll_bar_d x="right" y="0" w="14" h="100%" value="0"/>
</mledit> </mledit>
``` ```
> 更多用法请参考：[mledit.xml]( > 更多用法请参考：[mledit.xml](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/mledit.xml) https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/mledit.xml)
可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如： 可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：
```xml ```xml
<line_number> <line_number>
<style name="default"> <style name="default">
<normal text_color="black" bg_color="#d0d0d0" text_align_h="right"/> <normal text_color="black" bg_color="#d0d0d0" text_align_h="right"/>
</style> </style>
</line_number> </line_number>
``` ```
> 更多用法请参考： > 更多用法请参考：
[theme default]( [theme default](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L556) https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L556)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -52,8 +53,9 @@ https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#
* 函数功能： * 函数功能：
> <p id="line_number_t_line_number_cast"> 转换为line_number对象(供脚本语言使用)。 > <p id="line_number_t_line_number_cast"> 转换为line_number对象(供脚本语言使用)。
* 函数原型： * 函数原型：
@ -73,8 +75,9 @@ widget_t* line_number_cast (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="line_number_t_line_number_create"> 创建line_number对象 > <p id="line_number_t_line_number_create"> 创建line_number对象
* 函数原型： * 函数原型：
@ -98,8 +101,9 @@ widget_t* line_number_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
* 函数功能： * 函数功能：
> <p id="line_number_t_line_number_set_bottom_margin"> 设置顶部边距。 > <p id="line_number_t_line_number_set_bottom_margin"> 设置顶部边距。
* 函数原型： * 函数原型：
@ -120,8 +124,9 @@ ret_t line_number_set_bottom_margin (widget_t* widget, int32_t bottom_margin);
* 函数功能： * 函数功能：
> <p id="line_number_t_line_number_set_line_height"> 设置行高。 > <p id="line_number_t_line_number_set_line_height"> 设置行高。
* 函数原型： * 函数原型：
@ -142,8 +147,9 @@ ret_t line_number_set_line_height (widget_t* widget, int32_t line_height);
* 函数功能： * 函数功能：
> <p id="line_number_t_line_number_set_top_margin"> 设置顶部边距。 > <p id="line_number_t_line_number_set_top_margin"> 设置顶部边距。
* 函数原型： * 函数原型：
@ -164,8 +170,9 @@ ret_t line_number_set_top_margin (widget_t* widget, int32_t top_margin);
* 函数功能： * 函数功能：
> <p id="line_number_t_line_number_set_yoffset"> 设置y偏移。 > <p id="line_number_t_line_number_set_yoffset"> 设置y偏移。
* 函数原型： * 函数原型：

58
docs/manual/locale_info_t.md
View File

@ -1,7 +1,8 @@
## locale\_info\_t ## locale\_info\_t
### 概述 ### 概述
本地化信息。提供字符串翻译数据管理，当前语言改变的事件通知等等。 本地化信息。提供字符串翻译数据管理，当前语言改变的事件通知等等。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -30,8 +31,9 @@
* 函数功能： * 函数功能：
> <p id="locale_info_t_locale_info"> 获取缺省locale_info。 > <p id="locale_info_t_locale_info"> 获取缺省locale_info。
* 函数原型： * 函数原型：
@ -50,8 +52,9 @@ locale_info_t* locale_info ();
* 函数功能： * 函数功能：
> <p id="locale_info_t_locale_info_change"> 设置当前的国家和语言。 > <p id="locale_info_t_locale_info_change"> 设置当前的国家和语言。
* 函数原型： * 函数原型：
@ -73,8 +76,9 @@ ret_t locale_info_change (locale_info_t* locale_info, char* language, char* coun
* 函数功能： * 函数功能：
> <p id="locale_info_t_locale_info_create"> 创建locale_info。 > <p id="locale_info_t_locale_info_create"> 创建locale_info。
* 函数原型： * 函数原型：
@ -95,8 +99,9 @@ locale_info_t* locale_info_create (char* language, char* country);
* 函数功能： * 函数功能：
> <p id="locale_info_t_locale_info_destroy"> 释放全部资源并销毁locale_info对象。 > <p id="locale_info_t_locale_info_destroy"> 释放全部资源并销毁locale_info对象。
* 函数原型： * 函数原型：
@ -116,8 +121,9 @@ ret_t locale_info_destroy (locale_info_t* locale_info);
* 函数功能： * 函数功能：
> <p id="locale_info_t_locale_info_off"> 注销指定事件的处理函数。 > <p id="locale_info_t_locale_info_off"> 注销指定事件的处理函数。
* 函数原型： * 函数原型：
@ -138,8 +144,9 @@ ret_t locale_info_off (locale_info_t* locale_info, uint32_t id);
* 函数功能： * 函数功能：
> <p id="locale_info_t_locale_info_on"> 注册指定事件的处理函数。 > <p id="locale_info_t_locale_info_on"> 注册指定事件的处理函数。
* 函数原型： * 函数原型：
@ -162,8 +169,9 @@ uint32_t locale_info_on (locale_info_t* locale_info, event_type_t type, event_fu
* 函数功能： * 函数功能：
> <p id="locale_info_t_locale_info_set"> 设置缺省locale_info。 > <p id="locale_info_t_locale_info_set"> 设置缺省locale_info。
* 函数原型： * 函数原型：
@ -183,9 +191,10 @@ ret_t locale_info_set (locale_info_t* locale_info);
* 函数功能： * 函数功能：
> <p id="locale_info_t_locale_info_set_assets_manager"> 设置资源管理器对象。 > <p id="locale_info_t_locale_info_set_assets_manager"> 设置资源管理器对象。
* 函数原型： * 函数原型：
@ -206,8 +215,9 @@ ret_t locale_info_set_assets_manager (locale_info_t* locale_info, assets_manager
* 函数功能： * 函数功能：
> <p id="locale_info_t_locale_info_tr"> 翻译字符串。 > <p id="locale_info_t_locale_info_tr"> 翻译字符串。
* 函数原型： * 函数原型：
@ -225,7 +235,8 @@ char* locale_info_tr (locale_info_t* locale_info, char* text);
| text | char* | 待翻译的文本。 | | text | char* | 待翻译的文本。 |
#### country; 属性 #### country; 属性
----------------------- -----------------------
> <p id="locale_info_t_country;"> 国家或地区。如：CN > <p id="locale_info_t_country;"> 国家或地区。如：CN
* 类型：char* * 类型：char*
@ -236,7 +247,8 @@ char* locale_info_tr (locale_info_t* locale_info, char* text);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### language 属性 #### language 属性
----------------------- -----------------------
> <p id="locale_info_t_language"> 语言。如：zh > <p id="locale_info_t_language"> 语言。如：zh
* 类型：char* * 类型：char*

108
docs/manual/mledit_t.md
View File

@ -2,30 +2,31 @@
### 概述 ### 概述
![image](images/mledit_t_0.png) ![image](images/mledit_t_0.png)
多行编辑器控件。 多行编辑器控件。
mledit\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于mledit\_t控件。 mledit\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于mledit\_t控件。
在xml中使用"mledit"标签创建多行编辑器控件。如： 在xml中使用"mledit"标签创建多行编辑器控件。如：
```xml ```xml
<mledit x="c" y="m" w="300" h="300" /> <mledit x="c" y="m" w="300" h="300" />
``` ```
> 更多用法请参考：[mledit.xml]( > 更多用法请参考：[mledit.xml](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/mledit.xml) https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/mledit.xml)
在c代码中使用函数mledit\_create创建多行编辑器控件。如： 在c代码中使用函数mledit\_create创建多行编辑器控件。如：
```c ```c
widget_t* tc = mledit_create(win, 10, 10, 240, 240); widget_t* tc = mledit_create(win, 10, 10, 240, 240);
``` ```
> 完整示例请参考：[mledit demo]( > 完整示例请参考：[mledit demo](
https://github.com/zlgopen/awtk-c-demos/blob/master/demos/mledit.c) https://github.com/zlgopen/awtk-c-demos/blob/master/demos/mledit.c)
time\_clock一般不需要设置style。 time\_clock一般不需要设置style。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -65,8 +66,9 @@
* 函数功能： * 函数功能：
> <p id="mledit_t_mledit_cast"> 转换为mledit对象(供脚本语言使用)。 > <p id="mledit_t_mledit_cast"> 转换为mledit对象(供脚本语言使用)。
* 函数原型： * 函数原型：
@ -86,8 +88,9 @@ widget_t* mledit_cast (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="mledit_t_mledit_create"> 创建mledit对象 > <p id="mledit_t_mledit_create"> 创建mledit对象
* 函数原型： * 函数原型：
@ -111,8 +114,9 @@ widget_t* mledit_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
* 函数功能： * 函数功能：
> <p id="mledit_t_mledit_set_focus"> 设置为焦点。 > <p id="mledit_t_mledit_set_focus"> 设置为焦点。
* 函数原型： * 函数原型：
@ -133,8 +137,9 @@ ret_t mledit_set_focus (widget_t* widget, bool_t focus);
* 函数功能： * 函数功能：
> <p id="mledit_t_mledit_set_input_tips"> 设置编辑器的输入提示。 > <p id="mledit_t_mledit_set_input_tips"> 设置编辑器的输入提示。
* 函数原型： * 函数原型：
@ -155,8 +160,9 @@ ret_t mledit_set_input_tips (widget_t* widget, char* tips);
* 函数功能： * 函数功能：
> <p id="mledit_t_mledit_set_max_lines"> 设置编辑器的最大行数。 > <p id="mledit_t_mledit_set_max_lines"> 设置编辑器的最大行数。
* 函数原型： * 函数原型：
@ -177,8 +183,9 @@ ret_t mledit_set_max_lines (widget_t* widget, uint32_t max_lines);
* 函数功能： * 函数功能：
> <p id="mledit_t_mledit_set_readonly"> 设置编辑器是否为只读。 > <p id="mledit_t_mledit_set_readonly"> 设置编辑器是否为只读。
* 函数原型： * 函数原型：
@ -199,8 +206,9 @@ ret_t mledit_set_readonly (widget_t* widget, bool_t readonly);
* 函数功能： * 函数功能：
> <p id="mledit_t_mledit_set_wrap_word"> 设置编辑器是否自动折行。 > <p id="mledit_t_mledit_set_wrap_word"> 设置编辑器是否自动折行。
* 函数原型： * 函数原型：
@ -218,7 +226,8 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
| wrap\_word | bool\_t | 是否自动折行。 | | wrap\_word | bool\_t | 是否自动折行。 |
#### bottom\_margin 属性 #### bottom\_margin 属性
----------------------- -----------------------
> <p id="mledit_t_bottom_margin"> 下边距。 > <p id="mledit_t_bottom_margin"> 下边距。
* 类型：uint8\_t * 类型：uint8\_t
@ -232,7 +241,8 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### left\_margin 属性 #### left\_margin 属性
----------------------- -----------------------
> <p id="mledit_t_left_margin"> 左边距。 > <p id="mledit_t_left_margin"> 左边距。
* 类型：uint8\_t * 类型：uint8\_t
@ -246,7 +256,8 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### max\_lines 属性 #### max\_lines 属性
----------------------- -----------------------
> <p id="mledit_t_max_lines"> 最大行数。 > <p id="mledit_t_max_lines"> 最大行数。
* 类型：uint32\_t * 类型：uint32\_t
@ -263,7 +274,8 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### readonly 属性 #### readonly 属性
----------------------- -----------------------
> <p id="mledit_t_readonly"> 编辑器是否为只读。 > <p id="mledit_t_readonly"> 编辑器是否为只读。
* 类型：bool\_t * 类型：bool\_t
@ -280,7 +292,8 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### right\_margin 属性 #### right\_margin 属性
----------------------- -----------------------
> <p id="mledit_t_right_margin"> 右边距。 > <p id="mledit_t_right_margin"> 右边距。
* 类型：uint8\_t * 类型：uint8\_t
@ -294,7 +307,8 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### tips 属性 #### tips 属性
----------------------- -----------------------
> <p id="mledit_t_tips"> 输入提示。 > <p id="mledit_t_tips"> 输入提示。
* 类型：char* * 类型：char*
@ -311,7 +325,8 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### top\_margin 属性 #### top\_margin 属性
----------------------- -----------------------
> <p id="mledit_t_top_margin"> 上边距。 > <p id="mledit_t_top_margin"> 上边距。
* 类型：uint8\_t * 类型：uint8\_t
@ -325,7 +340,8 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
| 可通过widget\_set\_prop修改 | 是 | | 可通过widget\_set\_prop修改 | 是 |
#### wrap\_word 属性 #### wrap\_word 属性
----------------------- -----------------------
> <p id="mledit_t_wrap_word"> 是否自动折行。 > <p id="mledit_t_wrap_word"> 是否自动折行。
* 类型：bool\_t * 类型：bool\_t

83
docs/manual/named_value_t.md
View File

@ -1,7 +1,8 @@
## named\_value\_t ## named\_value\_t
### 概述 ### 概述
命名的值。 命名的值。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -29,10 +30,11 @@
* 函数功能： * 函数功能：
> <p id="named_value_t_named_value_cast"> > <p id="named_value_t_named_value_cast">
转换为named_value对象(供脚本语言使用)。 转换为named_value对象(供脚本语言使用)。
* 函数原型： * 函数原型：
@ -52,9 +54,10 @@ named_value_t* named_value_cast (named_value_t* nv);
* 函数功能： * 函数功能：
> <p id="named_value_t_named_value_create"> > <p id="named_value_t_named_value_create">
创建named_value对象。 创建named_value对象。
* 函数原型： * 函数原型：
@ -73,10 +76,11 @@ named_value_t* named_value_create ();
* 函数功能： * 函数功能：
> <p id="named_value_t_named_value_deinit"> > <p id="named_value_t_named_value_deinit">
重置named_value对象。 重置named_value对象。
* 函数原型： * 函数原型：
@ -96,10 +100,11 @@ ret_t named_value_deinit (named_value_t* nv);
* 函数功能： * 函数功能：
> <p id="named_value_t_named_value_destroy"> > <p id="named_value_t_named_value_destroy">
销毁named_value对象。 销毁named_value对象。
* 函数原型： * 函数原型：
@ -119,11 +124,12 @@ ret_t named_value_destroy (named_value_t* nv);
* 函数功能： * 函数功能：
> <p id="named_value_t_named_value_get_value"> > <p id="named_value_t_named_value_get_value">
获取值对象(主要给脚本语言使用)。 获取值对象(主要给脚本语言使用)。
* 函数原型： * 函数原型：
@ -143,10 +149,11 @@ value_t* named_value_get_value (named_value_t* nv);
* 函数功能： * 函数功能：
> <p id="named_value_t_named_value_init"> > <p id="named_value_t_named_value_init">
初始化。 初始化。
* 函数原型： * 函数原型：
@ -168,10 +175,11 @@ ret_t named_value_init (named_value_t* nv, const char* name, const value_t* valu
* 函数功能： * 函数功能：
> <p id="named_value_t_named_value_set_name"> > <p id="named_value_t_named_value_set_name">
设置名称。 设置名称。
* 函数原型： * 函数原型：
@ -192,10 +200,11 @@ ret_t named_value_set_name (named_value_t* nv, const char* name);
* 函数功能： * 函数功能：
> <p id="named_value_t_named_value_set_value"> > <p id="named_value_t_named_value_set_value">
设置值。 设置值。
* 函数原型： * 函数原型：
@ -213,7 +222,8 @@ ret_t named_value_set_value (named_value_t* nv, const value_t* value);
| value | const value\_t* | 值。 | | value | const value\_t* | 值。 |
#### name 属性 #### name 属性
----------------------- -----------------------
> <p id="named_value_t_name"> 名称。 > <p id="named_value_t_name"> 名称。
* 类型：char* * 类型：char*
@ -225,7 +235,8 @@ ret_t named_value_set_value (named_value_t* nv, const value_t* value);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### value 属性 #### value 属性
----------------------- -----------------------
> <p id="named_value_t_value"> 值。 > <p id="named_value_t_value"> 值。
* 类型：value\_t * 类型：value\_t

36
docs/manual/native_window_t.md
View File

@ -2,8 +2,9 @@
### 概述 ### 概述
![image](images/native_window_t_0.png) ![image](images/native_window_t_0.png)
原生窗口。 原生窗口。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -21,8 +22,9 @@
* 函数功能： * 函数功能：
> <p id="native_window_t_native_window_create"> 创建win对象。 > <p id="native_window_t_native_window_create"> 创建win对象。
* 函数原型： * 函数原型：
@ -42,9 +44,10 @@ native_window_t* native_window_create (const char* params);
* 函数功能： * 函数功能：
> <p id="native_window_t_native_window_get_canvas"> 获取canvas。 > <p id="native_window_t_native_window_get_canvas"> 获取canvas。
* 函数原型： * 函数原型：
@ -64,8 +67,9 @@ canvas_t native_window_get_canvas (native_window_t* win);
* 函数功能： * 函数功能：
> <p id="native_window_t_native_window_invalidate"> 请求重绘指定区域。 > <p id="native_window_t_native_window_invalidate"> 请求重绘指定区域。
* 函数原型： * 函数原型：
@ -86,9 +90,10 @@ ret_t native_window_invalidate (native_window_t* win, rect_t* r);
* 函数功能： * 函数功能：
> <p id="native_window_t_native_window_move"> 移动窗口。 > <p id="native_window_t_native_window_move"> 移动窗口。
* 函数原型： * 函数原型：
@ -111,9 +116,10 @@ ret_t native_window_move (native_window_t* win, xy_t x, xy_t y, bool_t force);
* 函数功能： * 函数功能：
> <p id="native_window_t_native_window_resize"> 调整窗口大小。 > <p id="native_window_t_native_window_resize"> 调整窗口大小。
* 函数原型： * 函数原型：

76
docs/manual/object_array_t.md
View File

@ -2,14 +2,15 @@
### 概述 ### 概述
![image](images/object_array_t_0.png) ![image](images/object_array_t_0.png)
简单的动态数组，内部存放value对象。 简单的动态数组，内部存放value对象。
访问时属性名称为： 访问时属性名称为：
* "size"/"length" 用于获取数组的长度。 * "size"/"length" 用于获取数组的长度。
* index 用于访问属性，-1可以用来追加新元素。 * index 用于访问属性，-1可以用来追加新元素。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -34,11 +35,12 @@
* 函数功能： * 函数功能：
> <p id="object_array_t_object_array_clear_props"> > <p id="object_array_t_object_array_clear_props">
清除全部属性。 清除全部属性。
* 函数原型： * 函数原型：
@ -58,11 +60,12 @@ ret_t object_array_clear_props (object_t* obj);
* 函数功能： * 函数功能：
> <p id="object_array_t_object_array_create"> > <p id="object_array_t_object_array_create">
创建对象。 创建对象。
* 函数原型： * 函数原型：
@ -81,11 +84,12 @@ object_t* object_array_create ();
* 函数功能： * 函数功能：
> <p id="object_array_t_object_array_create"> > <p id="object_array_t_object_array_create">
克隆对象。 克隆对象。
* 函数原型： * 函数原型：
@ -105,11 +109,12 @@ object_t* object_array_create (object_array_t* o);
* 函数功能： * 函数功能：
> <p id="object_array_t_object_array_unref"> > <p id="object_array_t_object_array_unref">
for script gc for script gc
* 函数原型： * 函数原型：
@ -126,8 +131,9 @@ ret_t object_array_unref (object_t* obj);
| obj | object\_t* | 对象。 | | obj | object\_t* | 对象。 |
#### props 属性 #### props 属性
----------------------- -----------------------
> <p id="object_array_t_props"> 属性数组。 > <p id="object_array_t_props"> 属性数组。
* 类型：value\_t * 类型：value\_t
@ -138,8 +144,9 @@ ret_t object_array_unref (object_t* obj);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### props\_capacity 属性 #### props\_capacity 属性
----------------------- -----------------------
> <p id="object_array_t_props_capacity"> 属性数组的容量。 > <p id="object_array_t_props_capacity"> 属性数组的容量。
* 类型：uint32\_t * 类型：uint32\_t
@ -150,8 +157,9 @@ ret_t object_array_unref (object_t* obj);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### props\_size 属性 #### props\_size 属性
----------------------- -----------------------
> <p id="object_array_t_props_size"> 属性个数。 > <p id="object_array_t_props_size"> 属性个数。
* 类型：uint32\_t * 类型：uint32\_t

81
docs/manual/object_default_t.md
View File

@ -2,11 +2,12 @@
### 概述 ### 概述
![image](images/object_default_t_0.png) ![image](images/object_default_t_0.png)
对象接口的缺省实现。 对象接口的缺省实现。
内部使用有序数组保存所有属性，可以快速查找指定名称的属性。 内部使用有序数组保存所有属性，可以快速查找指定名称的属性。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -32,11 +33,12 @@
* 函数功能： * 函数功能：
> <p id="object_default_t_object_default_clear_props"> > <p id="object_default_t_object_default_clear_props">
清除全部属性。 清除全部属性。
* 函数原型： * 函数原型：
@ -56,11 +58,12 @@ ret_t object_default_clear_props (object_t* obj);
* 函数功能： * 函数功能：
> <p id="object_default_t_object_default_create"> > <p id="object_default_t_object_default_create">
创建对象。 创建对象。
* 函数原型： * 函数原型：
@ -79,11 +82,12 @@ object_t* object_default_create ();
* 函数功能： * 函数功能：
> <p id="object_default_t_object_default_create"> > <p id="object_default_t_object_default_create">
克隆对象。 克隆对象。
* 函数原型： * 函数原型：
@ -103,11 +107,12 @@ object_t* object_default_create (object_default_t* o);
* 函数功能： * 函数功能：
> <p id="object_default_t_object_default_find_prop"> > <p id="object_default_t_object_default_find_prop">
查找满足条件的属性，并返回它的值。 查找满足条件的属性，并返回它的值。
* 函数原型： * 函数原型：
@ -129,11 +134,12 @@ value_t* object_default_find_prop (object_t* obj, tk_compare_t cmp, const void*
* 函数功能： * 函数功能：
> <p id="object_default_t_object_default_unref"> > <p id="object_default_t_object_default_unref">
for script gc for script gc
* 函数原型： * 函数原型：
@ -150,8 +156,9 @@ ret_t object_default_unref (object_t* obj);
| obj | object\_t* | 对象。 | | obj | object\_t* | 对象。 |
#### props 属性 #### props 属性
----------------------- -----------------------
> <p id="object_default_t_props"> 属性数组。 > <p id="object_default_t_props"> 属性数组。
* 类型：named\_value\_t * 类型：named\_value\_t
@ -162,8 +169,9 @@ ret_t object_default_unref (object_t* obj);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### props\_capacity 属性 #### props\_capacity 属性
----------------------- -----------------------
> <p id="object_default_t_props_capacity"> 属性数组的容量。 > <p id="object_default_t_props_capacity"> 属性数组的容量。
* 类型：uint32\_t * 类型：uint32\_t
@ -174,8 +182,9 @@ ret_t object_default_unref (object_t* obj);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### props\_size 属性 #### props\_size 属性
----------------------- -----------------------
> <p id="object_default_t_props_size"> 属性个数。 > <p id="object_default_t_props_size"> 属性个数。
* 类型：uint32\_t * 类型：uint32\_t

281
docs/manual/object_t.md
View File

@ -2,9 +2,10 @@
### 概述 ### 概述
![image](images/object_t_0.png) ![image](images/object_t_0.png)
对象接口。 对象接口。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -62,9 +63,10 @@
* 函数功能： * 函数功能：
> <p id="object_t_object_can_exec"> 检查是否可以执行指定的命令。 > <p id="object_t_object_can_exec"> 检查是否可以执行指定的命令。
* 函数原型： * 函数原型：
@ -86,9 +88,10 @@ bool_t object_can_exec (object_t* obj, const char* name, const char* args);
* 函数功能： * 函数功能：
> <p id="object_t_object_compare"> 比较两个对象。 > <p id="object_t_object_compare"> 比较两个对象。
* 函数原型： * 函数原型：
@ -109,9 +112,10 @@ int object_compare (object_t* obj, object_t* other);
* 函数功能： * 函数功能：
> <p id="object_t_object_copy_prop"> 拷贝指定的属性。 > <p id="object_t_object_copy_prop"> 拷贝指定的属性。
* 函数原型： * 函数原型：
@ -133,11 +137,12 @@ ret_t object_copy_prop (object_t* obj, object_t* src, const char* name);
* 函数功能： * 函数功能：
> <p id="object_t_object_create"> 创建对象。 > <p id="object_t_object_create"> 创建对象。
> 仅供子类调用。 > 仅供子类调用。
* 函数原型： * 函数原型：
@ -157,9 +162,10 @@ ret_t object_create (const object_vtable_t* vt);
* 函数功能： * 函数功能：
> <p id="object_t_object_eval"> 计算一个表达式，表达式中引用的变量从prop中获取。 > <p id="object_t_object_eval"> 计算一个表达式，表达式中引用的变量从prop中获取。
* 函数原型： * 函数原型：
@ -181,8 +187,9 @@ ret_t object_eval (object_t* obj, const char* expr, value_t* v);
* 函数功能： * 函数功能：
> <p id="object_t_object_exec"> 执行指定的命令。 > <p id="object_t_object_exec"> 执行指定的命令。
* 函数原型： * 函数原型：
@ -204,9 +211,10 @@ ret_t object_exec (object_t* obj, const char* name, const char* args);
* 函数功能： * 函数功能：
> <p id="object_t_object_foreach_prop"> 遍历所有属性。 > <p id="object_t_object_foreach_prop"> 遍历所有属性。
* 函数原型： * 函数原型：
@ -228,9 +236,10 @@ ret_t object_foreach_prop (object_t* obj, tk_visit_t on_prop, void* ctx);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_desc"> 获取对象的描述信息。 > <p id="object_t_object_get_desc"> 获取对象的描述信息。
* 函数原型： * 函数原型：
@ -250,9 +259,10 @@ const char* object_get_desc (object_t* obj);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop"> 获取指定属性的值。 > <p id="object_t_object_get_prop"> 获取指定属性的值。
* 函数原型： * 函数原型：
@ -274,9 +284,10 @@ ret_t object_get_prop (object_t* obj, const char* name, value_t* v);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_bool"> 获取指定属性的bool类型的值。 > <p id="object_t_object_get_prop_bool"> 获取指定属性的bool类型的值。
* 函数原型： * 函数原型：
@ -298,9 +309,10 @@ bool_t object_get_prop_bool (object_t* obj, const char* name, bool_t defval);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_bool_by_path"> 获取指定属性的bool类型的值。 > <p id="object_t_object_get_prop_bool_by_path"> 获取指定属性的bool类型的值。
* 函数原型： * 函数原型：
@ -322,9 +334,10 @@ bool_t object_get_prop_bool_by_path (object_t* obj, const char* path, bool_t def
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_by_path"> 获取指定path属性的值。 > <p id="object_t_object_get_prop_by_path"> 获取指定path属性的值。
* 函数原型： * 函数原型：
@ -346,9 +359,10 @@ ret_t object_get_prop_by_path (object_t* obj, const char* path, value_t* v);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_float"> 获取指定属性的浮点数类型的值。 > <p id="object_t_object_get_prop_float"> 获取指定属性的浮点数类型的值。
* 函数原型： * 函数原型：
@ -370,9 +384,10 @@ float_t object_get_prop_float (object_t* obj, const char* name, float_t defval);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_float_by_path"> 获取指定属性的浮点数类型的值。 > <p id="object_t_object_get_prop_float_by_path"> 获取指定属性的浮点数类型的值。
* 函数原型： * 函数原型：
@ -394,9 +409,10 @@ float_t object_get_prop_float_by_path (object_t* obj, const char* path, float_t
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_int"> 获取指定属性的整数类型的值。 > <p id="object_t_object_get_prop_int"> 获取指定属性的整数类型的值。
* 函数原型： * 函数原型：
@ -418,9 +434,10 @@ int32_t object_get_prop_int (object_t* obj, const char* name, int32_t defval);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_int_by_path"> 获取指定属性的整数类型的值。 > <p id="object_t_object_get_prop_int_by_path"> 获取指定属性的整数类型的值。
* 函数原型： * 函数原型：
@ -442,9 +459,10 @@ int32_t object_get_prop_int_by_path (object_t* obj, const char* path, int32_t de
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_object"> 获取指定属性的object类型的值。 > <p id="object_t_object_get_prop_object"> 获取指定属性的object类型的值。
* 函数原型： * 函数原型：
@ -465,9 +483,10 @@ object_t* object_get_prop_object (object_t* obj, const char* name);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_object_by_path"> 获取指定属性的object类型的值。 > <p id="object_t_object_get_prop_object_by_path"> 获取指定属性的object类型的值。
* 函数原型： * 函数原型：
@ -488,9 +507,10 @@ object_t* object_get_prop_object_by_path (object_t* obj, const char* path);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_pointer"> 获取指定属性的指针类型的值。 > <p id="object_t_object_get_prop_pointer"> 获取指定属性的指针类型的值。
* 函数原型： * 函数原型：
@ -511,9 +531,10 @@ void* object_get_prop_pointer (object_t* obj, const char* name);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_pointer_by_path"> 获取指定属性的指针类型的值。 > <p id="object_t_object_get_prop_pointer_by_path"> 获取指定属性的指针类型的值。
* 函数原型： * 函数原型：
@ -534,9 +555,10 @@ void* object_get_prop_pointer_by_path (object_t* obj, const char* path);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_str"> 获取指定属性的字符串类型的值。 > <p id="object_t_object_get_prop_str"> 获取指定属性的字符串类型的值。
* 函数原型： * 函数原型：
@ -557,9 +579,10 @@ const char* object_get_prop_str (object_t* obj, const char* name);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_prop_str_by_path"> 获取指定属性的字符串类型的值。 > <p id="object_t_object_get_prop_str_by_path"> 获取指定属性的字符串类型的值。
* 函数原型： * 函数原型：
@ -580,9 +603,10 @@ const char* object_get_prop_str_by_path (object_t* obj, const char* path);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_size"> 获取对象占用内存的大小。 > <p id="object_t_object_get_size"> 获取对象占用内存的大小。
* 函数原型： * 函数原型：
@ -602,9 +626,10 @@ uint32_t object_get_size (object_t* obj);
* 函数功能： * 函数功能：
> <p id="object_t_object_get_type"> 获取对象的类型名称。 > <p id="object_t_object_get_type"> 获取对象的类型名称。
* 函数原型： * 函数原型：
@ -624,9 +649,10 @@ const char* object_get_type (object_t* obj);
* 函数功能： * 函数功能：
> <p id="object_t_object_has_prop"> 检查是否存在指定的属性。 > <p id="object_t_object_has_prop"> 检查是否存在指定的属性。
* 函数原型： * 函数原型：
@ -647,9 +673,10 @@ bool_t object_has_prop (object_t* obj, const char* name);
* 函数功能： * 函数功能：
> <p id="object_t_object_is_collection"> 判断对象是否是集合。 > <p id="object_t_object_is_collection"> 判断对象是否是集合。
* 函数原型： * 函数原型：
@ -669,9 +696,10 @@ bool_t object_is_collection (object_t* obj);
* 函数功能： * 函数功能：
> <p id="object_t_object_notify_changed"> 触发EVT_PROPS_CHANGED事件。 > <p id="object_t_object_notify_changed"> 触发EVT_PROPS_CHANGED事件。
* 函数原型： * 函数原型：
@ -691,9 +719,10 @@ ret_t object_notify_changed (object_t* obj);
* 函数功能： * 函数功能：
> <p id="object_t_object_ref"> 引用计数加1。 > <p id="object_t_object_ref"> 引用计数加1。
* 函数原型： * 函数原型：
@ -713,9 +742,10 @@ object_t* object_ref (object_t* obj);
* 函数功能： * 函数功能：
> <p id="object_t_object_remove_prop"> 删除指定属性。 > <p id="object_t_object_remove_prop"> 删除指定属性。
* 函数原型： * 函数原型：
@ -736,9 +766,10 @@ ret_t object_remove_prop (object_t* obj, const char* name);
* 函数功能： * 函数功能：
> <p id="object_t_object_set_name"> 设置对象的名称。 > <p id="object_t_object_set_name"> 设置对象的名称。
* 函数原型： * 函数原型：
@ -759,9 +790,10 @@ ret_t object_set_name (object_t* obj, const char* name);
* 函数功能： * 函数功能：
> <p id="object_t_object_set_prop"> 设置指定属性的值。 > <p id="object_t_object_set_prop"> 设置指定属性的值。
* 函数原型： * 函数原型：
@ -783,9 +815,10 @@ ret_t object_set_prop (object_t* obj, const char* name, value_t* value);
* 函数功能： * 函数功能：
> <p id="object_t_object_set_prop_bool"> 设置指定属性的bool类型的值。 > <p id="object_t_object_set_prop_bool"> 设置指定属性的bool类型的值。
* 函数原型： * 函数原型：
@ -807,9 +840,10 @@ ret_t object_set_prop_bool (object_t* obj, const char* name, bool_t value);
* 函数功能： * 函数功能：
> <p id="object_t_object_set_prop_float"> 设置指定属性的浮点数类型的值。 > <p id="object_t_object_set_prop_float"> 设置指定属性的浮点数类型的值。
* 函数原型： * 函数原型：
@ -831,9 +865,10 @@ ret_t object_set_prop_float (object_t* obj, const char* name, float_t value);
* 函数功能： * 函数功能：
> <p id="object_t_object_set_prop_int"> 设置指定属性的整数类型的值。 > <p id="object_t_object_set_prop_int"> 设置指定属性的整数类型的值。
* 函数原型： * 函数原型：
@ -855,9 +890,10 @@ ret_t object_set_prop_int (object_t* obj, const char* name, int32_t value);
* 函数功能： * 函数功能：
> <p id="object_t_object_set_prop_object"> 设置指定属性的object类型的值。 > <p id="object_t_object_set_prop_object"> 设置指定属性的object类型的值。
* 函数原型： * 函数原型：
@ -879,9 +915,10 @@ ret_t object_set_prop_object (object_t* obj, const char* name, object_t* value);
* 函数功能： * 函数功能：
> <p id="object_t_object_set_prop_pointer"> 设置指定属性的指针类型的值。 > <p id="object_t_object_set_prop_pointer"> 设置指定属性的指针类型的值。
* 函数原型： * 函数原型：
@ -903,9 +940,10 @@ ret_t object_set_prop_pointer (object_t* obj, const char* name, void* value);
* 函数功能： * 函数功能：
> <p id="object_t_object_set_prop_str"> 设置指定属性的字符串类型的值。 > <p id="object_t_object_set_prop_str"> 设置指定属性的字符串类型的值。
* 函数原型： * 函数原型：
@ -927,9 +965,10 @@ ret_t object_set_prop_str (object_t* obj, const char* name, const char* value);
* 函数功能： * 函数功能：
> <p id="object_t_object_unref"> 引用计数减1。引用计数为0时，销毁对象。 > <p id="object_t_object_unref"> 引用计数减1。引用计数为0时，销毁对象。
* 函数原型： * 函数原型：
@ -946,7 +985,8 @@ ret_t object_unref (object_t* obj);
| obj | object\_t* | object对象。 | | obj | object\_t* | object对象。 |
#### name 属性 #### name 属性
----------------------- -----------------------
> <p id="object_t_name"> 对象的名称。 > <p id="object_t_name"> 对象的名称。
* 类型：char* * 类型：char*
@ -958,7 +998,8 @@ ret_t object_unref (object_t* obj);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### ref\_count 属性 #### ref\_count 属性
----------------------- -----------------------
> <p id="object_t_ref_count"> 引用计数。 > <p id="object_t_ref_count"> 引用计数。
* 类型：int32\_t * 类型：int32\_t

16
docs/manual/orientation_event_t.md
View File

@ -2,7 +2,8 @@
### 概述 ### 概述
![image](images/orientation_event_t_0.png) ![image](images/orientation_event_t_0.png)
滚轮事件。 滚轮事件。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -23,8 +24,9 @@
* 函数功能： * 函数功能：
> <p id="orientation_event_t_orientation_event_cast"> 把event对象转orientation_event_t对象，主要给脚本语言使用。 > <p id="orientation_event_t_orientation_event_cast"> 把event对象转orientation_event_t对象，主要给脚本语言使用。
* 函数原型： * 函数原型：
@ -44,8 +46,9 @@ orientation_event_t* orientation_event_cast (event_t* event);
* 函数功能： * 函数功能：
> <p id="orientation_event_t_orientation_event_init"> 初始化事件。 > <p id="orientation_event_t_orientation_event_init"> 初始化事件。
* 函数原型： * 函数原型：
@ -65,7 +68,8 @@ event_t* orientation_event_init (orientation_event_t* event, void* target, uint3
| dy | int32\_t | 滚轮的y值。 | | dy | int32\_t | 滚轮的y值。 |
#### orientation 属性 #### orientation 属性
----------------------- -----------------------
> <p id="orientation_event_t_orientation"> 屏幕方向。 > <p id="orientation_event_t_orientation"> 屏幕方向。
* 类型：int32\_t * 类型：int32\_t

87
docs/manual/overlay_t.md
View File

@ -2,44 +2,45 @@
### 概述 ### 概述
![image](images/overlay_t_0.png) ![image](images/overlay_t_0.png)
overlay窗口。 overlay窗口。
overlay窗口有点类似于非模态的dialog，但是它位置和大小是完全自由的，窗口管理器不会对它做任何限制。 overlay窗口有点类似于非模态的dialog，但是它位置和大小是完全自由的，窗口管理器不会对它做任何限制。
如果overlay窗口有透明或半透效果，则不支持窗口动画，但可以通过移动窗口位置来实现类似动画的效果。 如果overlay窗口有透明或半透效果，则不支持窗口动画，但可以通过移动窗口位置来实现类似动画的效果。
overlay\_t是[window\_base\_t](window_base_t.md)的子类控件，window\_base\_t的函数均适用于overlay\_t控件。 overlay\_t是[window\_base\_t](window_base_t.md)的子类控件，window\_base\_t的函数均适用于overlay\_t控件。
在xml中使用"overlay"标签创建窗口。需要指定坐标和大小，可以指定主题和动画名称。如： 在xml中使用"overlay"标签创建窗口。需要指定坐标和大小，可以指定主题和动画名称。如：
```xml ```xml
<overlay theme="basic" x="100" y="100" w="200" h="300"> <overlay theme="basic" x="100" y="100" w="200" h="300">
... ...
</overlay> </overlay>
``` ```
> >
更多用法请参考：[overlay.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/) 更多用法请参考：[overlay.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/)
在c代码中使用函数overlay\_create创建窗口。如： 在c代码中使用函数overlay\_create创建窗口。如：
```c ```c
widget_t* overlay = overlay_create(NULL, 100, 100, 200, 300); widget_t* overlay = overlay_create(NULL, 100, 100, 200, 300);
``` ```
> 完整示例请参考：[overlay > 完整示例请参考：[overlay
demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/) demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/)
可用通过style来设置窗口的风格，如背景颜色或图片等。如： 可用通过style来设置窗口的风格，如背景颜色或图片等。如：
```xml ```xml
<style name="bricks"> <style name="bricks">
<normal bg_image="bricks" bg_image_draw_type="repeat"/> <normal bg_image="bricks" bg_image_draw_type="repeat"/>
</style> </style>
``` ```
> 更多用法请参考：[theme > 更多用法请参考：[theme
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L0) default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L0)
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -54,8 +55,9 @@
* 函数功能： * 函数功能：
> <p id="overlay_t_overlay_cast"> 转换为overlay对象(供脚本语言使用)。 > <p id="overlay_t_overlay_cast"> 转换为overlay对象(供脚本语言使用)。
* 函数原型： * 函数原型：
@ -75,8 +77,9 @@ widget_t* overlay_cast (widget_t* widget);
* 函数功能： * 函数功能：
> <p id="overlay_t_overlay_create"> 创建overlay对象 > <p id="overlay_t_overlay_create"> 创建overlay对象
* 函数原型： * 函数原型：

16
docs/manual/paint_event_t.md
View File

@ -2,7 +2,8 @@
### 概述 ### 概述
![image](images/paint_event_t_0.png) ![image](images/paint_event_t_0.png)
绘制事件。 绘制事件。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -23,8 +24,9 @@
* 函数功能： * 函数功能：
> <p id="paint_event_t_paint_event_cast"> 把event对象转paint_event_t对象。主要给脚本语言使用。 > <p id="paint_event_t_paint_event_cast"> 把event对象转paint_event_t对象。主要给脚本语言使用。
* 函数原型： * 函数原型：
@ -44,8 +46,9 @@ paint_event_t* paint_event_cast (event_t* event);
* 函数功能： * 函数功能：
> <p id="paint_event_t_paint_event_init"> 初始化事件。 > <p id="paint_event_t_paint_event_init"> 初始化事件。
* 函数原型： * 函数原型：
@ -65,7 +68,8 @@ event_t* paint_event_init (paint_event_t* event, void* target, uint32_t type, ca
| c | canvas\_t* | canvas对象。 | | c | canvas\_t* | canvas对象。 |
#### c 属性 #### c 属性
----------------------- -----------------------
> <p id="paint_event_t_c"> canvas。 > <p id="paint_event_t_c"> canvas。
* 类型：canvas\_t* * 类型：canvas\_t*

9
docs/manual/point_t.md
View File

@ -1,6 +1,7 @@
## point\_t ## point\_t
### 概述 ### 概述
点。包括一个x坐标和一个y坐标。 点。包括一个x坐标和一个y坐标。
---------------------------------- ----------------------------------
### 属性 ### 属性
@ -12,7 +13,8 @@
| <a href="#point_t_y">y</a> | xy\_t | y坐标。 | | <a href="#point_t_y">y</a> | xy\_t | y坐标。 |
#### x 属性 #### x 属性
----------------------- -----------------------
> <p id="point_t_x"> x坐标。 > <p id="point_t_x"> x坐标。
* 类型：xy\_t * 类型：xy\_t
@ -23,7 +25,8 @@
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### y 属性 #### y 属性
----------------------- -----------------------
> <p id="point_t_y"> y坐标。 > <p id="point_t_y"> y坐标。
* 类型：xy\_t * 类型：xy\_t

40
docs/manual/pointer_event_t.md
View File

@ -2,7 +2,8 @@
### 概述 ### 概述
![image](images/pointer_event_t_0.png) ![image](images/pointer_event_t_0.png)
指针事件。 指针事件。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -31,8 +32,9 @@
* 函数功能： * 函数功能：
> <p id="pointer_event_t_pointer_event_cast"> 把event对象转pointer_event_t对象，主要给脚本语言使用。 > <p id="pointer_event_t_pointer_event_cast"> 把event对象转pointer_event_t对象，主要给脚本语言使用。
* 函数原型： * 函数原型：
@ -52,8 +54,9 @@ pointer_event_t* pointer_event_cast (event_t* event);
* 函数功能： * 函数功能：
> <p id="pointer_event_t_pointer_event_init"> 初始化事件。 > <p id="pointer_event_t_pointer_event_init"> 初始化事件。
* 函数原型： * 函数原型：
@ -74,7 +77,8 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
| y | int32\_t | y的值。 | | y | int32\_t | y的值。 |
#### alt 属性 #### alt 属性
----------------------- -----------------------
> <p id="pointer_event_t_alt"> alt键是否按下。 > <p id="pointer_event_t_alt"> alt键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -86,7 +90,8 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### button 属性 #### button 属性
----------------------- -----------------------
> <p id="pointer_event_t_button"> button。 > <p id="pointer_event_t_button"> button。
* 类型：uint8\_t * 类型：uint8\_t
@ -98,7 +103,8 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### cmd 属性 #### cmd 属性
----------------------- -----------------------
> <p id="pointer_event_t_cmd"> cmd键是否按下。 > <p id="pointer_event_t_cmd"> cmd键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -110,7 +116,8 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### ctrl 属性 #### ctrl 属性
----------------------- -----------------------
> <p id="pointer_event_t_ctrl"> ctrl键是否按下。 > <p id="pointer_event_t_ctrl"> ctrl键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -122,7 +129,8 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### menu 属性 #### menu 属性
----------------------- -----------------------
> <p id="pointer_event_t_menu"> menu键是否按下。 > <p id="pointer_event_t_menu"> menu键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -134,7 +142,8 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### pressed 属性 #### pressed 属性
----------------------- -----------------------
> <p id="pointer_event_t_pressed"> 指针是否按下。 > <p id="pointer_event_t_pressed"> 指针是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -146,7 +155,8 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### shift 属性 #### shift 属性
----------------------- -----------------------
> <p id="pointer_event_t_shift"> shift键是否按下。 > <p id="pointer_event_t_shift"> shift键是否按下。
* 类型：bool\_t * 类型：bool\_t
@ -158,7 +168,8 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### x 属性 #### x 属性
----------------------- -----------------------
> <p id="pointer_event_t_x"> x坐标。 > <p id="pointer_event_t_x"> x坐标。
* 类型：xy\_t * 类型：xy\_t
@ -170,7 +181,8 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### y 属性 #### y 属性
----------------------- -----------------------
> <p id="pointer_event_t_y"> y坐标。 > <p id="pointer_event_t_y"> y坐标。
* 类型：xy\_t * 类型：xy\_t

3
docs/manual/preload_res_t.md
View File

@ -1,5 +1,6 @@
## preload\_res\_t ## preload\_res\_t
### 概述 ### 概述
预加载资源的描述信息。 预加载资源的描述信息。
---------------------------------- ----------------------------------

14
docs/manual/prop_change_event_t.md
View File

@ -2,7 +2,8 @@
### 概述 ### 概述
![image](images/prop_change_event_t_0.png) ![image](images/prop_change_event_t_0.png)
对象属性变化事件。 对象属性变化事件。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -23,8 +24,9 @@
* 函数功能： * 函数功能：
> <p id="prop_change_event_t_prop_change_event_cast"> 把event对象转prop_change_event_t对象，主要给脚本语言使用。 > <p id="prop_change_event_t_prop_change_event_cast"> 把event对象转prop_change_event_t对象，主要给脚本语言使用。
* 函数原型： * 函数原型：
@ -41,7 +43,8 @@ prop_change_event_t* prop_change_event_cast (event_t* event);
| event | event\_t* | event对象。 | | event | event\_t* | event对象。 |
#### name 属性 #### name 属性
----------------------- -----------------------
> <p id="prop_change_event_t_name"> 属性的名称。 > <p id="prop_change_event_t_name"> 属性的名称。
* 类型：const char* * 类型：const char*
@ -53,7 +56,8 @@ prop_change_event_t* prop_change_event_cast (event_t* event);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### value 属性 #### value 属性
----------------------- -----------------------
> <p id="prop_change_event_t_value"> 属性的值。 > <p id="prop_change_event_t_value"> 属性的值。
* 类型：const value\_t* * 类型：const value\_t*

3
docs/manual/prop_desc_flags_t.md
View File

@ -1,6 +1,7 @@
## prop\_desc\_flags\_t ## prop\_desc\_flags\_t
### 概述 ### 概述
属性描述范围常量定义。 属性描述范围常量定义。
### 常量 ### 常量
<p id="prop_desc_flags_t_consts"> <p id="prop_desc_flags_t_consts">

102
docs/manual/rbuffer_t.md
View File

@ -1,21 +1,22 @@
## rbuffer\_t ## rbuffer\_t
### 概述 ### 概述
Read Buffer。用于数据解包。 Read Buffer。用于数据解包。
示例： 示例：
```c ```c
uint8_t buff[128]; uint8_t buff[128];
wbuffer_t wbuffer; wbuffer_t wbuffer;
rbuffer_t rbuffer; rbuffer_t rbuffer;
const char* str = NULL; const char* str = NULL;
wbuffer_init(&wbuffer, buff, sizeof(buff)); wbuffer_init(&wbuffer, buff, sizeof(buff));
wbuffer_write_string(&wbuffer, "hello awtk"); wbuffer_write_string(&wbuffer, "hello awtk");
rbuffer_init(&rbuffer, wbuffer.data, wbuffer.cursor); rbuffer_init(&rbuffer, wbuffer.data, wbuffer.cursor);
rbuffer_read_string(&rbuffer, &str); rbuffer_read_string(&rbuffer, &str);
``` ```
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -48,8 +49,9 @@
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_has_more"> 判断是否还有数据可读。 > <p id="rbuffer_t_rbuffer_has_more"> 判断是否还有数据可读。
* 函数原型： * 函数原型：
@ -69,8 +71,9 @@ bool_t rbuffer_has_more (rbuffer_t* rbuffer);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_init"> 初始rbuffer对象。 > <p id="rbuffer_t_rbuffer_init"> 初始rbuffer对象。
* 函数原型： * 函数原型：
@ -92,8 +95,9 @@ rbuffer_t* rbuffer_init (rbuffer_t* rbuffer, uint8_t* data, uint16_t capacity);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_peek_uint16"> 读取uint16数据，但不改变cursor的位置。 > <p id="rbuffer_t_rbuffer_peek_uint16"> 读取uint16数据，但不改变cursor的位置。
* 函数原型： * 函数原型：
@ -114,8 +118,9 @@ ret_t rbuffer_peek_uint16 (rbuffer_t* rbuffer, uint16_t* value);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_peek_uint32"> 读取uint32数据，但不改变cursor的位置。 > <p id="rbuffer_t_rbuffer_peek_uint32"> 读取uint32数据，但不改变cursor的位置。
* 函数原型： * 函数原型：
@ -136,8 +141,9 @@ ret_t rbuffer_peek_uint32 (rbuffer_t* rbuffer, uint32_t* value);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_peek_uint8"> 读取uint8数据，但不改变cursor的位置。 > <p id="rbuffer_t_rbuffer_peek_uint8"> 读取uint8数据，但不改变cursor的位置。
* 函数原型： * 函数原型：
@ -158,8 +164,9 @@ ret_t rbuffer_peek_uint8 (rbuffer_t* rbuffer, uint8_t* value);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_read_binary"> 读取指定长度的二进制数据。 > <p id="rbuffer_t_rbuffer_read_binary"> 读取指定长度的二进制数据。
* 函数原型： * 函数原型：
@ -181,8 +188,9 @@ ret_t rbuffer_read_binary (rbuffer_t* rbuffer, void* data, uint32_t size);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_read_float"> 读取float数据。 > <p id="rbuffer_t_rbuffer_read_float"> 读取float数据。
* 函数原型： * 函数原型：
@ -203,8 +211,9 @@ ret_t rbuffer_read_float (rbuffer_t* rbuffer, float_t* value);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_read_string"> 读取字符串。 > <p id="rbuffer_t_rbuffer_read_string"> 读取字符串。
* 函数原型： * 函数原型：
@ -225,8 +234,9 @@ ret_t rbuffer_read_string (rbuffer_t* rbuffer, char** str);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_read_uint16"> 读取uint16数据。 > <p id="rbuffer_t_rbuffer_read_uint16"> 读取uint16数据。
* 函数原型： * 函数原型：
@ -247,8 +257,9 @@ ret_t rbuffer_read_uint16 (rbuffer_t* rbuffer, uint16_t* value);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_read_uint32"> 读取uint32数据。 > <p id="rbuffer_t_rbuffer_read_uint32"> 读取uint32数据。
* 函数原型： * 函数原型：
@ -269,8 +280,9 @@ ret_t rbuffer_read_uint32 (rbuffer_t* rbuffer, uint32_t* value);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_read_uint8"> 读取uint8数据。 > <p id="rbuffer_t_rbuffer_read_uint8"> 读取uint8数据。
* 函数原型： * 函数原型：
@ -291,8 +303,9 @@ ret_t rbuffer_read_uint8 (rbuffer_t* rbuffer, uint8_t* value);
* 函数功能： * 函数功能：
> <p id="rbuffer_t_rbuffer_skip"> 跳过指定的长度。 > <p id="rbuffer_t_rbuffer_skip"> 跳过指定的长度。
* 函数原型： * 函数原型：
@ -310,7 +323,8 @@ ret_t rbuffer_skip (rbuffer_t* rbuffer, int32_t offset);
| offset | int32\_t | 跳过的偏移量，正数往前负数往回跳。 | | offset | int32\_t | 跳过的偏移量，正数往前负数往回跳。 |
#### capacity 属性 #### capacity 属性
----------------------- -----------------------
> <p id="rbuffer_t_capacity"> 缓存区最大容量。 > <p id="rbuffer_t_capacity"> 缓存区最大容量。
* 类型：uint32\_t * 类型：uint32\_t
@ -321,7 +335,8 @@ ret_t rbuffer_skip (rbuffer_t* rbuffer, int32_t offset);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### cursor 属性 #### cursor 属性
----------------------- -----------------------
> <p id="rbuffer_t_cursor"> 当前读取位置。 > <p id="rbuffer_t_cursor"> 当前读取位置。
* 类型：uint32\_t * 类型：uint32\_t
@ -332,7 +347,8 @@ ret_t rbuffer_skip (rbuffer_t* rbuffer, int32_t offset);
| 可直接修改 | 否 | | 可直接修改 | 否 |
#### data 属性 #### data 属性
----------------------- -----------------------
> <p id="rbuffer_t_data"> 缓存区。 > <p id="rbuffer_t_data"> 缓存区。
* 类型：uint8\_t* * 类型：uint8\_t*

57
docs/manual/rect_t.md
View File

@ -1,6 +1,7 @@
## rect\_t ## rect\_t
### 概述 ### 概述
矩形。包括一个x坐标、y坐标、宽度和高度。 矩形。包括一个x坐标、y坐标、宽度和高度。
---------------------------------- ----------------------------------
### 函数 ### 函数
@ -26,10 +27,11 @@
* 函数功能： * 函数功能：
> <p id="rect_t_rect_cast"> 转换为rect对象。 > <p id="rect_t_rect_cast"> 转换为rect对象。
> 供脚本语言使用。 > 供脚本语言使用。
* 函数原型： * 函数原型：
@ -49,11 +51,12 @@ rect_t* rect_cast (rect_t* rect);
* 函数功能： * 函数功能：
> <p id="rect_t_rect_create"> 创建rect对象。 > <p id="rect_t_rect_create"> 创建rect对象。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -76,11 +79,12 @@ rect_t* rect_create (xy_t x, xy_t y, wh_t w, wh_t h);
* 函数功能： * 函数功能：
> <p id="rect_t_rect_destroy"> > <p id="rect_t_rect_destroy">
销毁rect对象。 销毁rect对象。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -100,11 +104,12 @@ ret_t rect_destroy (rect_t* r);
* 函数功能： * 函数功能：
> <p id="rect_t_rect_set"> 设置rect对象的xywh。 > <p id="rect_t_rect_set"> 设置rect对象的xywh。
> 主要供脚本语言使用。 > 主要供脚本语言使用。
* 函数原型： * 函数原型：
@ -125,7 +130,8 @@ rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
| h | wh\_t | 高度。 | | h | wh\_t | 高度。 |
#### h 属性 #### h 属性
----------------------- -----------------------
> <p id="rect_t_h"> 高度。 > <p id="rect_t_h"> 高度。
* 类型：wh\_t * 类型：wh\_t
@ -137,7 +143,8 @@ rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### w 属性 #### w 属性
----------------------- -----------------------
> <p id="rect_t_w"> 宽度。 > <p id="rect_t_w"> 宽度。
* 类型：wh\_t * 类型：wh\_t
@ -149,7 +156,8 @@ rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### x 属性 #### x 属性
----------------------- -----------------------
> <p id="rect_t_x"> x坐标。 > <p id="rect_t_x"> x坐标。
* 类型：xy\_t * 类型：xy\_t
@ -161,7 +169,8 @@ rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
| 可脚本化 | 是 | | 可脚本化 | 是 |
#### y 属性 #### y 属性
----------------------- -----------------------
> <p id="rect_t_y"> y坐标。 > <p id="rect_t_y"> y坐标。
* 类型：xy\_t * 类型：xy\_t

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