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

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
* 增加fs\_file\_eof。
* 增加tk\_iostream\_noisy。

1
docs/manual/arg_desc_flags_t.md
View File

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

1
docs/manual/asset_data_type_t.md
View File

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

1
docs/manual/asset_font_type_t.md
View File

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

1
docs/manual/asset_image_type_t.md
View File

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

7
docs/manual/asset_info_t.md
View File

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

1
docs/manual/asset_script_type_t.md
View File

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

1
docs/manual/asset_type_t.md
View File

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

1
docs/manual/asset_ui_type_t.md
View File

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

17
docs/manual/assets_manager_t.md
View File

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

1
docs/manual/bitmap_flag_t.md
View File

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

1
docs/manual/bitmap_format_t.md
View File

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

17
docs/manual/bitmap_t.md
View File

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

3
docs/manual/children_layouter_default_t.md
View File

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

7
docs/manual/children_layouter_factory_t.md
View File

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

2
docs/manual/children_layouter_list_view_t.md
View File

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

11
docs/manual/children_layouter_t.md
View File

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

1
docs/manual/clip_board_data_type_t.md
View File

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

9
docs/manual/clip_board_t.md
View File

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

2
docs/manual/color_parser_t.md
View File

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

12
docs/manual/color_t.md
View File

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

2
docs/manual/combo_box_ex_t.md
View File

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

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* | 解压之后的数据。 |

22
docs/manual/darray_t.md
View File

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

12
docs/manual/date_time_t.md
View File

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

4
docs/manual/dialog_highlighter_default_t.md
View File

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

7
docs/manual/dialog_highlighter_factory_t.md
View File

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

10
docs/manual/dialog_highlighter_t.md
View File

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

1
docs/manual/dialog_highlighter_type_t.md
View File

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

17
docs/manual/dialog_t.md
View File

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

1
docs/manual/easing_type_t.md
View File

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

18
docs/manual/emitter_t.md
View File

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

1
docs/manual/event_base_type_t.md
View File

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

2
docs/manual/event_source_fd_t.md
View File

@ -6,6 +6,7 @@
fd事件源。
----------------------------------
### 函数
<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事件源。
----------------------------------
### 函数
<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">
@ -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返回下次唤醒的时间。
----------------------------------
### 函数
<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事件源。
----------------------------------
### 函数
<p id="event_source_timer_t_methods">
@ -25,6 +26,7 @@
* 函数原型：
```

8
docs/manual/event_t.md
View File

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

1
docs/manual/event_type_t.md
View File

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

2
docs/manual/font_loader_bitmap_t.md
View File

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

2
docs/manual/font_loader_stb_t.md
View File

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

2
docs/manual/font_loader_t.md
View File

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

11
docs/manual/font_manager_t.md
View File

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

5
docs/manual/font_t.md
View File

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

4
docs/manual/fs_dir_t.md
View File

@ -4,6 +4,7 @@
文件夹接口。
----------------------------------
### 函数
<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">
@ -11,6 +12,7 @@
| 函数名称 | 说明 |
| -------- | ------------ |
| <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_seek">fs\_file\_seek</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表示成功，否则表示失败。 |
| 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 函数
-----------------------
@ -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 @@
文件系统接口。
----------------------------------

5
docs/manual/func_call_parser_t.md
View File

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

6
docs/manual/func_desc_t.md
View File

@ -2,6 +2,7 @@
### 概述
函数描述。
----------------------------------
### 属性
<p id="func_desc_t_properties">
@ -18,6 +19,7 @@
> <p id="func_desc_t_args"> 函数参数描述。
* 类型：arg\_desc\_t**
| 特性 | 是否支持 |
@ -29,6 +31,7 @@
> <p id="func_desc_t_desc"> 描述。
* 类型：const char*
| 特性 | 是否支持 |
@ -40,6 +43,7 @@
> <p id="func_desc_t_exec"> 函数指针。
* 类型：func\_exec\_t
| 特性 | 是否支持 |
@ -51,6 +55,7 @@
> <p id="func_desc_t_name"> 名称。
* 类型：const char*
| 特性 | 是否支持 |
@ -62,6 +67,7 @@
> <p id="func_desc_t_return_value"> 函数返回值描述。
* 类型：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控件。
在xml中使用"gif\_image"标签创建GIF图片控件。如：
在xml中使用"gif"标签创建GIF图片控件。如：
```xml
<gif_image image="bee"/>
<gif image="bee"/>
```
>更多用法请参考：

8
docs/manual/global_t.md
View File

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

1
docs/manual/glyph_format_t.md
View File

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

28
docs/manual/glyph_t.md
View File

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

10
docs/manual/guage_pointer_t.md
View File

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

20
docs/manual/hscroll_label_t.md
View File

@ -30,6 +30,7 @@ https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/mledit.xml)
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml)
----------------------------------
### 函数
<p id="hscroll_label_t_methods">
@ -69,6 +70,7 @@ https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml)
* 函数原型：
```
@ -90,6 +92,7 @@ widget_t* hscroll_label_cast (widget_t* widget);
* 函数原型：
```
@ -115,6 +118,7 @@ widget_t* hscroll_label_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h
* 函数原型：
```
@ -137,6 +141,7 @@ ret_t hscroll_label_set_duration (widget_t* widget, int32_t duration);
* 函数原型：
```
@ -159,6 +164,7 @@ ret_t hscroll_label_set_ellipses (widget_t* widget, bool_t ellipses);
* 函数原型：
```
@ -181,6 +187,7 @@ ret_t hscroll_label_set_loop (widget_t* widget, bool_t loop);
* 函数原型：
```
@ -203,6 +210,7 @@ ret_t hscroll_label_set_lull (widget_t* widget, int32_t lull);
* 函数原型：
```
@ -225,6 +233,7 @@ ret_t hscroll_label_set_only_focus (widget_t* widget, bool_t only_focus);
* 函数原型：
```
@ -247,6 +256,7 @@ ret_t hscroll_label_set_xoffset (widget_t* widget, int32_t xoffset);
* 函数原型：
```
@ -269,6 +279,7 @@ ret_t hscroll_label_set_yoyo (widget_t* widget, bool_t yoyo);
* 函数原型：
```
@ -290,6 +301,7 @@ ret_t hscroll_label_start (widget_t* widget);
* 函数原型：
```
@ -307,6 +319,7 @@ ret_t hscroll_label_stop (widget_t* widget);
> <p id="hscroll_label_t_duration"> 完整的滚动一次需要的时间(ms)，缺省5000ms。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -323,6 +336,7 @@ ret_t hscroll_label_stop (widget_t* widget);
文本显示不下时，在行尾显示ellipses(缺省FALSE)。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -341,6 +355,7 @@ ret_t hscroll_label_stop (widget_t* widget);
loop是否循环滚动(缺省FALSE)。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -359,6 +374,7 @@ ret_t hscroll_label_stop (widget_t* widget);
滚动之间的间歇时间(ms)，缺省3000ms。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -377,6 +393,7 @@ ret_t hscroll_label_stop (widget_t* widget);
只有处于focus时才滚动(缺省否)。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -394,6 +411,7 @@ ret_t hscroll_label_stop (widget_t* widget);
> <p id="hscroll_label_t_text_w"> 文本的宽度。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -409,6 +427,7 @@ ret_t hscroll_label_stop (widget_t* widget);
> <p id="hscroll_label_t_xoffset"> 偏移量。
* 类型：int32\_t
| 特性 | 是否支持 |
@ -425,6 +444,7 @@ ret_t hscroll_label_stop (widget_t* widget);
是否往返滚动(缺省FALSE)。
* 类型：bool\_t
| 特性 | 是否支持 |

1
docs/manual/hscrollable_t.md
View File

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

7
docs/manual/idle_info_t.md
View File

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

6
docs/manual/idle_t.md
View File

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

3
docs/manual/im_action_button_info_event_t.md
View File

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

3
docs/manual/im_candidates_event_t.md
View File

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

3
docs/manual/im_commit_event_t.md
View File

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

2
docs/manual/image_draw_type_t.md
View File

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

2
docs/manual/image_loader_stb_t.md
View File

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

5
docs/manual/image_loader_t.md
View File

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

12
docs/manual/image_manager_t.md
View File

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

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

1
docs/manual/indicator_default_paint_t.md
View File

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

2
docs/manual/input_engine_null_t.md
View File

@ -9,6 +9,7 @@
----------------------------------
### 函数
<p id="input_engine_null_t_methods">
@ -27,6 +28,7 @@
* 函数原型：
```

2
docs/manual/input_engine_pinyin_t.md
View File

@ -9,6 +9,7 @@
----------------------------------
### 函数
<p id="input_engine_pinyin_t_methods">
@ -27,6 +28,7 @@
* 函数原型：
```

5
docs/manual/input_engine_t.md
View File

@ -11,6 +11,7 @@
![image](images/input_engine_t_0.png)
----------------------------------
### 函数
<p id="input_engine_t_methods">
@ -35,6 +36,7 @@
* 函数原型：
```
@ -55,6 +57,7 @@ input_engine_t* input_engine_create ();
* 函数原型：
```
@ -76,6 +79,7 @@ ret_t input_engine_destroy (input_engine_t* engine);
* 函数原型：
```
@ -98,6 +102,7 @@ ret_t input_engine_input (input_engine_t* engine, int key);
* 函数原型：
```

2
docs/manual/input_method_default_t.md
View File

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

2
docs/manual/input_method_null_t.md
View File

@ -9,6 +9,7 @@
----------------------------------
### 函数
<p id="input_method_null_t_methods">
@ -27,6 +28,7 @@
* 函数原型：
```

3
docs/manual/input_method_sdl_t.md
View File

@ -9,6 +9,7 @@
----------------------------------
### 函数
<p id="input_method_sdl_t_methods">
@ -26,6 +27,7 @@
* 函数原型：
```
@ -48,6 +50,7 @@ ret_t children_layouter_register_builtins ();
* 函数原型：
```

19
docs/manual/input_method_t.md
View File

@ -16,6 +16,7 @@
> 输入类型请参考：[input\_type](input_type_t.md)
----------------------------------
### 函数
<p id="input_method_t_methods">
@ -54,6 +55,7 @@
* 函数原型：
```
@ -74,6 +76,7 @@ input_method_t* input_method ();
* 函数原型：
```
@ -96,6 +99,7 @@ ret_t input_method_commit_text (input_method_t* im, char* text);
* 函数原型：
```
@ -119,6 +123,7 @@ ret_t input_method_commit_text_ex (input_method_t* im, bool_t replace, char* tex
* 函数原型：
```
@ -139,6 +144,7 @@ input_method_t* input_method_create ();
* 函数原型：
```
@ -160,6 +166,7 @@ ret_t input_method_destroy (input_method_t* im);
* 函数原型：
```
@ -182,6 +189,7 @@ ret_t input_method_dispatch (input_method_t* im, event_t* e);
* 函数原型：
```
@ -203,6 +211,7 @@ ret_t input_method_dispatch_action (input_method_t* im);
* 函数原型：
```
@ -226,6 +235,7 @@ ret_t input_method_dispatch_candidates (input_method_t* im, char* strs, uint32_t
* 函数原型：
```
@ -248,6 +258,7 @@ ret_t input_method_dispatch_key (input_method_t* im, uint32_t key);
* 函数原型：
```
@ -270,6 +281,7 @@ ret_t input_method_dispatch_to_widget (input_method_t* im, event_t* e);
* 函数原型：
```
@ -292,6 +304,7 @@ ret_t input_method_off (input_method_t* im, uint32_t id);
* 函数原型：
```
@ -316,6 +329,7 @@ uint32_t input_method_on (input_method_t* im, event_type_t type, event_func_t on
* 函数原型：
```
@ -338,6 +352,7 @@ ret_t input_method_request (input_method_t* im, widget_t* widget);
* 函数原型：
```
@ -359,6 +374,7 @@ ret_t input_method_set (input_method_t* im);
* 函数原型：
```
@ -378,6 +394,7 @@ ret_t input_method_update_action_button_info (input_method_t* im, char* text, bo
> <p id="input_method_t_action_button_enable"> 软键盘的上的action按钮是否可用。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -389,6 +406,7 @@ ret_t input_method_update_action_button_info (input_method_t* im, char* text, bo
> <p id="input_method_t_action_button_enable"> 软键盘的上的action按钮文本。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -400,6 +418,7 @@ ret_t input_method_update_action_button_info (input_method_t* im, char* text, bo
> <p id="input_method_t_input_type"> 当前输入的类型。
* 类型：input\_type\_t
| 特性 | 是否支持 |

1
docs/manual/input_type_t.md
View File

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

1
docs/manual/key_code_t.md
View File

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

16
docs/manual/key_event_t.md
View File

@ -4,6 +4,7 @@
按键事件。
----------------------------------
### 函数
<p id="key_event_t_methods">
@ -39,6 +40,7 @@
* 函数原型：
```
@ -60,6 +62,7 @@ key_event_t* key_event_cast (event_t* event);
* 函数原型：
```
@ -80,6 +83,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_alt"> alt键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -92,6 +96,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_capslock"> capslock键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -105,6 +110,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
cmd/win键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -118,6 +124,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
ctrl键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -130,6 +137,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_key"> 键值。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -142,6 +150,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_lalt"> left alt键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -154,6 +163,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_lctrl"> left ctrl键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -166,6 +176,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_lshift"> left shift键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -178,6 +189,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_menu"> menu键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -190,6 +202,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_ralt"> right alt键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -202,6 +215,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_rctrl"> right ctrl键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -214,6 +228,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_rshift"> right shift键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -226,6 +241,7 @@ event_t* key_event_init (key_event_t* event, void* target, uint32_t type, int32_
> <p id="key_event_t_shift"> shift键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |

7
docs/manual/line_number_t.md
View File

@ -35,6 +35,7 @@ https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/mledit.xml)
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L556)
----------------------------------
### 函数
<p id="line_number_t_methods">
@ -56,6 +57,7 @@ https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#
* 函数原型：
```
@ -77,6 +79,7 @@ widget_t* line_number_cast (widget_t* widget);
* 函数原型：
```
@ -102,6 +105,7 @@ widget_t* line_number_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
* 函数原型：
```
@ -124,6 +128,7 @@ ret_t line_number_set_bottom_margin (widget_t* widget, int32_t bottom_margin);
* 函数原型：
```
@ -146,6 +151,7 @@ ret_t line_number_set_line_height (widget_t* widget, int32_t line_height);
* 函数原型：
```
@ -168,6 +174,7 @@ ret_t line_number_set_top_margin (widget_t* widget, int32_t top_margin);
* 函数原型：
```

12
docs/manual/locale_info_t.md
View File

@ -3,6 +3,7 @@
本地化信息。提供字符串翻译数据管理，当前语言改变的事件通知等等。
----------------------------------
### 函数
<p id="locale_info_t_methods">
@ -34,6 +35,7 @@
* 函数原型：
```
@ -54,6 +56,7 @@ locale_info_t* locale_info ();
* 函数原型：
```
@ -77,6 +80,7 @@ ret_t locale_info_change (locale_info_t* locale_info, char* language, char* coun
* 函数原型：
```
@ -99,6 +103,7 @@ locale_info_t* locale_info_create (char* language, char* country);
* 函数原型：
```
@ -120,6 +125,7 @@ ret_t locale_info_destroy (locale_info_t* locale_info);
* 函数原型：
```
@ -142,6 +148,7 @@ ret_t locale_info_off (locale_info_t* locale_info, uint32_t id);
* 函数原型：
```
@ -166,6 +173,7 @@ uint32_t locale_info_on (locale_info_t* locale_info, event_type_t type, event_fu
* 函数原型：
```
@ -188,6 +196,7 @@ ret_t locale_info_set (locale_info_t* locale_info);
* 函数原型：
```
@ -210,6 +219,7 @@ ret_t locale_info_set_assets_manager (locale_info_t* locale_info, assets_manager
* 函数原型：
```
@ -228,6 +238,7 @@ char* locale_info_tr (locale_info_t* locale_info, char* text);
> <p id="locale_info_t_country;"> 国家或地区。如：CN
* 类型：char*
| 特性 | 是否支持 |
@ -239,6 +250,7 @@ char* locale_info_tr (locale_info_t* locale_info, char* text);
> <p id="locale_info_t_language"> 语言。如：zh
* 类型：char*
| 特性 | 是否支持 |

16
docs/manual/mledit_t.md
View File

@ -27,6 +27,7 @@
time\_clock一般不需要设置style。
----------------------------------
### 函数
<p id="mledit_t_methods">
@ -69,6 +70,7 @@
* 函数原型：
```
@ -90,6 +92,7 @@ widget_t* mledit_cast (widget_t* widget);
* 函数原型：
```
@ -115,6 +118,7 @@ widget_t* mledit_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
* 函数原型：
```
@ -137,6 +141,7 @@ ret_t mledit_set_focus (widget_t* widget, bool_t focus);
* 函数原型：
```
@ -159,6 +164,7 @@ ret_t mledit_set_input_tips (widget_t* widget, char* tips);
* 函数原型：
```
@ -181,6 +187,7 @@ ret_t mledit_set_max_lines (widget_t* widget, uint32_t max_lines);
* 函数原型：
```
@ -203,6 +210,7 @@ ret_t mledit_set_readonly (widget_t* widget, bool_t readonly);
* 函数原型：
```
@ -221,6 +229,7 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
> <p id="mledit_t_bottom_margin"> 下边距。
* 类型：uint8\_t
| 特性 | 是否支持 |
@ -235,6 +244,7 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
> <p id="mledit_t_left_margin"> 左边距。
* 类型：uint8\_t
| 特性 | 是否支持 |
@ -249,6 +259,7 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
> <p id="mledit_t_max_lines"> 最大行数。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -266,6 +277,7 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
> <p id="mledit_t_readonly"> 编辑器是否为只读。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -283,6 +295,7 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
> <p id="mledit_t_right_margin"> 右边距。
* 类型：uint8\_t
| 特性 | 是否支持 |
@ -297,6 +310,7 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
> <p id="mledit_t_tips"> 输入提示。
* 类型：char*
| 特性 | 是否支持 |
@ -314,6 +328,7 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
> <p id="mledit_t_top_margin"> 上边距。
* 类型：uint8\_t
| 特性 | 是否支持 |
@ -328,6 +343,7 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
> <p id="mledit_t_wrap_word"> 是否自动折行。
* 类型：bool\_t
| 特性 | 是否支持 |

11
docs/manual/named_value_t.md
View File

@ -3,6 +3,7 @@
命名的值。
----------------------------------
### 函数
<p id="named_value_t_methods">
@ -35,6 +36,7 @@
* 函数原型：
```
@ -57,6 +59,7 @@ named_value_t* named_value_cast (named_value_t* nv);
* 函数原型：
```
@ -79,6 +82,7 @@ named_value_t* named_value_create ();
* 函数原型：
```
@ -102,6 +106,7 @@ ret_t named_value_deinit (named_value_t* nv);
* 函数原型：
```
@ -126,6 +131,7 @@ ret_t named_value_destroy (named_value_t* nv);
* 函数原型：
```
@ -149,6 +155,7 @@ value_t* named_value_get_value (named_value_t* nv);
* 函数原型：
```
@ -174,6 +181,7 @@ ret_t named_value_init (named_value_t* nv, const char* name, const value_t* valu
* 函数原型：
```
@ -198,6 +206,7 @@ ret_t named_value_set_name (named_value_t* nv, const char* name);
* 函数原型：
```
@ -216,6 +225,7 @@ ret_t named_value_set_value (named_value_t* nv, const value_t* value);
> <p id="named_value_t_name"> 名称。
* 类型：char*
| 特性 | 是否支持 |
@ -228,6 +238,7 @@ ret_t named_value_set_value (named_value_t* nv, const value_t* value);
> <p id="named_value_t_value"> 值。
* 类型：value\_t
| 特性 | 是否支持 |

6
docs/manual/native_window_t.md
View File

@ -5,6 +5,7 @@
原生窗口。
----------------------------------
### 函数
<p id="native_window_t_methods">
@ -25,6 +26,7 @@
* 函数原型：
```
@ -47,6 +49,7 @@ native_window_t* native_window_create (const char* params);
* 函数原型：
```
@ -68,6 +71,7 @@ canvas_t native_window_get_canvas (native_window_t* win);
* 函数原型：
```
@ -91,6 +95,7 @@ ret_t native_window_invalidate (native_window_t* win, rect_t* r);
* 函数原型：
```
@ -116,6 +121,7 @@ ret_t native_window_move (native_window_t* win, xy_t x, xy_t y, bool_t force);
* 函数原型：
```

8
docs/manual/object_array_t.md
View File

@ -11,6 +11,7 @@
* index 用于访问属性，-1可以用来追加新元素。
----------------------------------
### 函数
<p id="object_array_t_methods">
@ -41,6 +42,7 @@
* 函数原型：
```
@ -65,6 +67,7 @@ ret_t object_array_clear_props (object_t* obj);
* 函数原型：
```
@ -88,6 +91,7 @@ object_t* object_array_create ();
* 函数原型：
```
@ -112,6 +116,7 @@ object_t* object_array_create (object_array_t* o);
* 函数原型：
```
@ -130,6 +135,7 @@ ret_t object_array_unref (object_t* obj);
* 类型：value\_t
| 特性 | 是否支持 |
@ -142,6 +148,7 @@ ret_t object_array_unref (object_t* obj);
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -154,6 +161,7 @@ ret_t object_array_unref (object_t* obj);
* 类型：uint32\_t
| 特性 | 是否支持 |

9
docs/manual/object_default_t.md
View File

@ -8,6 +8,7 @@
内部使用有序数组保存所有属性，可以快速查找指定名称的属性。
----------------------------------
### 函数
<p id="object_default_t_methods">
@ -39,6 +40,7 @@
* 函数原型：
```
@ -63,6 +65,7 @@ ret_t object_default_clear_props (object_t* obj);
* 函数原型：
```
@ -86,6 +89,7 @@ object_t* object_default_create ();
* 函数原型：
```
@ -110,6 +114,7 @@ object_t* object_default_create (object_default_t* o);
* 函数原型：
```
@ -136,6 +141,7 @@ value_t* object_default_find_prop (object_t* obj, tk_compare_t cmp, const void*
* 函数原型：
```
@ -154,6 +160,7 @@ ret_t object_default_unref (object_t* obj);
* 类型：named\_value\_t
| 特性 | 是否支持 |
@ -166,6 +173,7 @@ ret_t object_default_unref (object_t* obj);
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -178,6 +186,7 @@ ret_t object_default_unref (object_t* obj);
* 类型：uint32\_t
| 特性 | 是否支持 |

41
docs/manual/object_t.md
View File

@ -6,6 +6,7 @@
对象接口。
----------------------------------
### 函数
<p id="object_t_methods">
@ -67,6 +68,7 @@
* 函数原型：
```
@ -91,6 +93,7 @@ bool_t object_can_exec (object_t* obj, const char* name, const char* args);
* 函数原型：
```
@ -114,6 +117,7 @@ int object_compare (object_t* obj, object_t* other);
* 函数原型：
```
@ -140,6 +144,7 @@ ret_t object_copy_prop (object_t* obj, object_t* src, const char* name);
* 函数原型：
```
@ -162,6 +167,7 @@ ret_t object_create (const object_vtable_t* vt);
* 函数原型：
```
@ -185,6 +191,7 @@ ret_t object_eval (object_t* obj, const char* expr, value_t* v);
* 函数原型：
```
@ -209,6 +216,7 @@ ret_t object_exec (object_t* obj, const char* name, const char* args);
* 函数原型：
```
@ -233,6 +241,7 @@ ret_t object_foreach_prop (object_t* obj, tk_visit_t on_prop, void* ctx);
* 函数原型：
```
@ -255,6 +264,7 @@ const char* object_get_desc (object_t* obj);
* 函数原型：
```
@ -279,6 +289,7 @@ ret_t object_get_prop (object_t* obj, const char* name, value_t* v);
* 函数原型：
```
@ -303,6 +314,7 @@ bool_t object_get_prop_bool (object_t* obj, const char* name, bool_t defval);
* 函数原型：
```
@ -327,6 +339,7 @@ bool_t object_get_prop_bool_by_path (object_t* obj, const char* path, bool_t def
* 函数原型：
```
@ -351,6 +364,7 @@ ret_t object_get_prop_by_path (object_t* obj, const char* path, value_t* v);
* 函数原型：
```
@ -375,6 +389,7 @@ float_t object_get_prop_float (object_t* obj, const char* name, float_t defval);
* 函数原型：
```
@ -399,6 +414,7 @@ float_t object_get_prop_float_by_path (object_t* obj, const char* path, float_t
* 函数原型：
```
@ -423,6 +439,7 @@ int32_t object_get_prop_int (object_t* obj, const char* name, int32_t defval);
* 函数原型：
```
@ -447,6 +464,7 @@ int32_t object_get_prop_int_by_path (object_t* obj, const char* path, int32_t de
* 函数原型：
```
@ -470,6 +488,7 @@ object_t* object_get_prop_object (object_t* obj, const char* name);
* 函数原型：
```
@ -493,6 +512,7 @@ object_t* object_get_prop_object_by_path (object_t* obj, const char* path);
* 函数原型：
```
@ -516,6 +536,7 @@ void* object_get_prop_pointer (object_t* obj, const char* name);
* 函数原型：
```
@ -539,6 +560,7 @@ void* object_get_prop_pointer_by_path (object_t* obj, const char* path);
* 函数原型：
```
@ -562,6 +584,7 @@ const char* object_get_prop_str (object_t* obj, const char* name);
* 函数原型：
```
@ -585,6 +608,7 @@ const char* object_get_prop_str_by_path (object_t* obj, const char* path);
* 函数原型：
```
@ -607,6 +631,7 @@ uint32_t object_get_size (object_t* obj);
* 函数原型：
```
@ -629,6 +654,7 @@ const char* object_get_type (object_t* obj);
* 函数原型：
```
@ -652,6 +678,7 @@ bool_t object_has_prop (object_t* obj, const char* name);
* 函数原型：
```
@ -674,6 +701,7 @@ bool_t object_is_collection (object_t* obj);
* 函数原型：
```
@ -696,6 +724,7 @@ ret_t object_notify_changed (object_t* obj);
* 函数原型：
```
@ -718,6 +747,7 @@ object_t* object_ref (object_t* obj);
* 函数原型：
```
@ -741,6 +771,7 @@ ret_t object_remove_prop (object_t* obj, const char* name);
* 函数原型：
```
@ -764,6 +795,7 @@ ret_t object_set_name (object_t* obj, const char* name);
* 函数原型：
```
@ -788,6 +820,7 @@ ret_t object_set_prop (object_t* obj, const char* name, value_t* value);
* 函数原型：
```
@ -812,6 +845,7 @@ ret_t object_set_prop_bool (object_t* obj, const char* name, bool_t value);
* 函数原型：
```
@ -836,6 +870,7 @@ ret_t object_set_prop_float (object_t* obj, const char* name, float_t value);
* 函数原型：
```
@ -860,6 +895,7 @@ ret_t object_set_prop_int (object_t* obj, const char* name, int32_t value);
* 函数原型：
```
@ -884,6 +920,7 @@ ret_t object_set_prop_object (object_t* obj, const char* name, object_t* value);
* 函数原型：
```
@ -908,6 +945,7 @@ ret_t object_set_prop_pointer (object_t* obj, const char* name, void* value);
* 函数原型：
```
@ -932,6 +970,7 @@ ret_t object_set_prop_str (object_t* obj, const char* name, const char* value);
* 函数原型：
```
@ -949,6 +988,7 @@ ret_t object_unref (object_t* obj);
> <p id="object_t_name"> 对象的名称。
* 类型：char*
| 特性 | 是否支持 |
@ -961,6 +1001,7 @@ ret_t object_unref (object_t* obj);
> <p id="object_t_ref_count"> 引用计数。
* 类型：int32\_t
| 特性 | 是否支持 |

4
docs/manual/orientation_event_t.md
View File

@ -4,6 +4,7 @@
滚轮事件。
----------------------------------
### 函数
<p id="orientation_event_t_methods">
@ -27,6 +28,7 @@
* 函数原型：
```
@ -48,6 +50,7 @@ orientation_event_t* orientation_event_cast (event_t* event);
* 函数原型：
```
@ -68,6 +71,7 @@ event_t* orientation_event_init (orientation_event_t* event, void* target, uint3
> <p id="orientation_event_t_orientation"> 屏幕方向。
* 类型：int32\_t
| 特性 | 是否支持 |

3
docs/manual/overlay_t.md
View File

@ -41,6 +41,7 @@
> 更多用法请参考：[theme
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L0)
----------------------------------
### 函数
<p id="overlay_t_methods">
@ -58,6 +59,7 @@
* 函数原型：
```
@ -79,6 +81,7 @@ widget_t* overlay_cast (widget_t* widget);
* 函数原型：
```

4
docs/manual/paint_event_t.md
View File

@ -4,6 +4,7 @@
绘制事件。
----------------------------------
### 函数
<p id="paint_event_t_methods">
@ -27,6 +28,7 @@
* 函数原型：
```
@ -48,6 +50,7 @@ paint_event_t* paint_event_cast (event_t* event);
* 函数原型：
```
@ -68,6 +71,7 @@ event_t* paint_event_init (paint_event_t* event, void* target, uint32_t type, ca
> <p id="paint_event_t_c"> canvas。
* 类型：canvas\_t*
| 特性 | 是否支持 |

3
docs/manual/point_t.md
View File

@ -2,6 +2,7 @@
### 概述
点。包括一个x坐标和一个y坐标。
----------------------------------
### 属性
<p id="point_t_properties">
@ -15,6 +16,7 @@
> <p id="point_t_x"> x坐标。
* 类型：xy\_t
| 特性 | 是否支持 |
@ -26,6 +28,7 @@
> <p id="point_t_y"> y坐标。
* 类型：xy\_t
| 特性 | 是否支持 |

12
docs/manual/pointer_event_t.md
View File

@ -4,6 +4,7 @@
指针事件。
----------------------------------
### 函数
<p id="pointer_event_t_methods">
@ -35,6 +36,7 @@
* 函数原型：
```
@ -56,6 +58,7 @@ pointer_event_t* pointer_event_cast (event_t* event);
* 函数原型：
```
@ -77,6 +80,7 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
> <p id="pointer_event_t_alt"> alt键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -89,6 +93,7 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
> <p id="pointer_event_t_button"> button。
* 类型：uint8\_t
| 特性 | 是否支持 |
@ -101,6 +106,7 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
> <p id="pointer_event_t_cmd"> cmd键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -113,6 +119,7 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
> <p id="pointer_event_t_ctrl"> ctrl键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -125,6 +132,7 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
> <p id="pointer_event_t_menu"> menu键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -137,6 +145,7 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
> <p id="pointer_event_t_pressed"> 指针是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -149,6 +158,7 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
> <p id="pointer_event_t_shift"> shift键是否按下。
* 类型：bool\_t
| 特性 | 是否支持 |
@ -161,6 +171,7 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
> <p id="pointer_event_t_x"> x坐标。
* 类型：xy\_t
| 特性 | 是否支持 |
@ -173,6 +184,7 @@ event_t* pointer_event_init (pointer_event_t* event, void* target, uint32_t type
> <p id="pointer_event_t_y"> y坐标。
* 类型：xy\_t
| 特性 | 是否支持 |

1
docs/manual/preload_res_t.md
View File

@ -2,4 +2,5 @@
### 概述
预加载资源的描述信息。
----------------------------------

4
docs/manual/prop_change_event_t.md
View File

@ -4,6 +4,7 @@
对象属性变化事件。
----------------------------------
### 函数
<p id="prop_change_event_t_methods">
@ -27,6 +28,7 @@
* 函数原型：
```
@ -44,6 +46,7 @@ prop_change_event_t* prop_change_event_cast (event_t* event);
> <p id="prop_change_event_t_name"> 属性的名称。
* 类型：const char*
| 特性 | 是否支持 |
@ -56,6 +59,7 @@ prop_change_event_t* prop_change_event_cast (event_t* event);
> <p id="prop_change_event_t_value"> 属性的值。
* 类型：const value\_t*
| 特性 | 是否支持 |

1
docs/manual/prop_desc_flags_t.md
View File

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

16
docs/manual/rbuffer_t.md
View File

@ -17,6 +17,7 @@
rbuffer_read_string(&rbuffer, &str);
```
----------------------------------
### 函数
<p id="rbuffer_t_methods">
@ -52,6 +53,7 @@
* 函数原型：
```
@ -73,6 +75,7 @@ bool_t rbuffer_has_more (rbuffer_t* rbuffer);
* 函数原型：
```
@ -96,6 +99,7 @@ rbuffer_t* rbuffer_init (rbuffer_t* rbuffer, uint8_t* data, uint16_t capacity);
* 函数原型：
```
@ -118,6 +122,7 @@ ret_t rbuffer_peek_uint16 (rbuffer_t* rbuffer, uint16_t* value);
* 函数原型：
```
@ -140,6 +145,7 @@ ret_t rbuffer_peek_uint32 (rbuffer_t* rbuffer, uint32_t* value);
* 函数原型：
```
@ -162,6 +168,7 @@ ret_t rbuffer_peek_uint8 (rbuffer_t* rbuffer, uint8_t* value);
* 函数原型：
```
@ -185,6 +192,7 @@ ret_t rbuffer_read_binary (rbuffer_t* rbuffer, void* data, uint32_t size);
* 函数原型：
```
@ -207,6 +215,7 @@ ret_t rbuffer_read_float (rbuffer_t* rbuffer, float_t* value);
* 函数原型：
```
@ -229,6 +238,7 @@ ret_t rbuffer_read_string (rbuffer_t* rbuffer, char** str);
* 函数原型：
```
@ -251,6 +261,7 @@ ret_t rbuffer_read_uint16 (rbuffer_t* rbuffer, uint16_t* value);
* 函数原型：
```
@ -273,6 +284,7 @@ ret_t rbuffer_read_uint32 (rbuffer_t* rbuffer, uint32_t* value);
* 函数原型：
```
@ -295,6 +307,7 @@ ret_t rbuffer_read_uint8 (rbuffer_t* rbuffer, uint8_t* value);
* 函数原型：
```
@ -313,6 +326,7 @@ ret_t rbuffer_skip (rbuffer_t* rbuffer, int32_t offset);
> <p id="rbuffer_t_capacity"> 缓存区最大容量。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -324,6 +338,7 @@ ret_t rbuffer_skip (rbuffer_t* rbuffer, int32_t offset);
> <p id="rbuffer_t_cursor"> 当前读取位置。
* 类型：uint32\_t
| 特性 | 是否支持 |
@ -335,6 +350,7 @@ ret_t rbuffer_skip (rbuffer_t* rbuffer, int32_t offset);
> <p id="rbuffer_t_data"> 缓存区。
* 类型：uint8\_t*
| 特性 | 是否支持 |

9
docs/manual/rect_t.md
View File

@ -2,6 +2,7 @@
### 概述
矩形。包括一个x坐标、y坐标、宽度和高度。
----------------------------------
### 函数
<p id="rect_t_methods">
@ -32,6 +33,7 @@
* 函数原型：
```
@ -56,6 +58,7 @@ rect_t* rect_cast (rect_t* rect);
* 函数原型：
```
@ -83,6 +86,7 @@ rect_t* rect_create (xy_t x, xy_t y, wh_t w, wh_t h);
* 函数原型：
```
@ -107,6 +111,7 @@ ret_t rect_destroy (rect_t* r);
* 函数原型：
```
@ -128,6 +133,7 @@ rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
> <p id="rect_t_h"> 高度。
* 类型：wh\_t
| 特性 | 是否支持 |
@ -140,6 +146,7 @@ rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
> <p id="rect_t_w"> 宽度。
* 类型：wh\_t
| 特性 | 是否支持 |
@ -152,6 +159,7 @@ rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
> <p id="rect_t_x"> x坐标。
* 类型：xy\_t
| 特性 | 是否支持 |
@ -164,6 +172,7 @@ rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h);
> <p id="rect_t_y"> y坐标。
* 类型：xy\_t
| 特性 | 是否支持 |

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