update idl/docs

This commit is contained in:
xianjimli 2020-04-07 09:44:59 +08:00
parent d0dd0c6bd6
commit e169bb0405
17 changed files with 10108 additions and 9267 deletions

View File

@ -24,6 +24,8 @@ darray_destroy(darray);
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#darray_t_darray_bsearch">darray\_bsearch</a> | 二分查找(确保数组有序)。 |
| <a href="#darray_t_darray_bsearch_index">darray\_bsearch\_index</a> | 二分查找(确保数组有序)。 |
| <a href="#darray_t_darray_clear">darray\_clear</a> | 清除全部元素。 |
| <a href="#darray_t_darray_count">darray\_count</a> | 返回满足条件元素的个数。 |
| <a href="#darray_t_darray_create">darray\_create</a> | 创建darray对象。 |
@ -53,6 +55,48 @@ darray_destroy(darray);
| <a href="#darray_t_destroy">destroy</a> | tk\_destroy\_t | 元素销毁函数。 |
| <a href="#darray_t_elms">elms</a> | void** | 数组中的元素。 |
| <a href="#darray_t_size">size</a> | uint32\_t | 数组中元素的个数。 |
#### darray\_bsearch 函数
-----------------------
* 函数功能:
> <p id="darray_t_darray_bsearch">二分查找(确保数组有序)。
* 函数原型:
```
void* darray_bsearch (darray_t* darray, tk_compare_t cmp, void* ctx);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void* | 如果找到返回满足条件的对象否则返回NULL。 |
| darray | darray\_t* | 数组对象。 |
| cmp | tk\_compare\_t | 比较函数为NULL则使用内置的比较函数。 |
| ctx | void* | 比较函数的上下文。 |
#### darray\_bsearch\_index 函数
-----------------------
* 函数功能:
> <p id="darray_t_darray_bsearch_index">二分查找(确保数组有序)。
* 函数原型:
```
int darray_bsearch_index (darray_t* darray, tk_compare_t cmp, void* ctx);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int | 如果找到,返回满足条件的对象的位置,否则返回-1。 |
| darray | darray\_t* | 数组对象。 |
| cmp | tk\_compare\_t | 比较函数为NULL则使用内置的比较函数。 |
| ctx | void* | 比较函数的上下文。 |
#### darray\_clear 函数
-----------------------

View File

@ -76,6 +76,7 @@ default](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/st
| <a href="#edit_t_edit_set_int">edit\_set\_int</a> | 设置int类型的值。 |
| <a href="#edit_t_edit_set_int_limit">edit\_set\_int\_limit</a> | 设置为整数输入及取值范围。 |
| <a href="#edit_t_edit_set_is_valid_char">edit\_set\_is\_valid\_char</a> | 设置输入字符检查函数。 |
| <a href="#edit_t_edit_set_keyboard">edit\_set\_keyboard</a> | 设置自定义软键盘名称。 |
| <a href="#edit_t_edit_set_open_im_when_focused">edit\_set\_open\_im\_when\_focused</a> | 设置编辑器是否在获得焦点时打开输入法。 |
| <a href="#edit_t_edit_set_password_visible">edit\_set\_password\_visible</a> | 当编辑器输入类型为密码时,设置密码是否可见。 |
| <a href="#edit_t_edit_set_readonly">edit\_set\_readonly</a> | 设置编辑器是否为只读。 |
@ -89,6 +90,7 @@ default](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/st
| <a href="#edit_t_auto_fix">auto\_fix</a> | bool\_t | 输入无效时,是否自动改正。 |
| <a href="#edit_t_bottom_margin">bottom\_margin</a> | uint8\_t | 下边距。 |
| <a href="#edit_t_input_type">input\_type</a> | input\_type\_t | 输入类型。 |
| <a href="#edit_t_keyboard">keyboard</a> | char* | 自定义软键盘名称。 |
| <a href="#edit_t_left_margin">left\_margin</a> | uint8\_t | 左边距。 |
| <a href="#edit_t_max">max</a> | double | 最大值或最大长度。 |
| <a href="#edit_t_min">min</a> | double | 最小值或最小长度。 |
@ -392,6 +394,26 @@ ret_t edit_set_is_valid_char (widget_t* widget, edit_is_valid_char_t is_valid_ch
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| is\_valid\_char | edit\_is\_valid\_char\_t | 检查输入字符是否有效的回调函数。 |
#### edit\_set\_keyboard 函数
-----------------------
* 函数功能:
> <p id="edit_t_edit_set_keyboard">设置自定义软键盘名称。
* 函数原型:
```
ret_t edit_set_keyboard (widget_t* widget, char* keyboard);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| keyboard | char* | 键盘名称(相应UI资源必须存在)。 |
#### edit\_set\_open\_im\_when\_focused 函数
-----------------------
@ -531,6 +553,22 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
* 类型input\_type\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### keyboard 属性
-----------------------
> <p id="edit_t_keyboard">自定义软键盘名称。
* 类型char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |

View File

@ -29,6 +29,7 @@
| <a href="#fs_t_fs_get_disk_info">fs\_get\_disk\_info</a> | 获取文件系统信息。 |
| <a href="#fs_t_fs_get_exe">fs\_get\_exe</a> | 获取可执行文件所在目录。 |
| <a href="#fs_t_fs_get_file_size">fs\_get\_file\_size</a> | 获取文件大小。 |
| <a href="#fs_t_fs_get_user_storage_path">fs\_get\_user\_storage\_path</a> | 获取home目录或者应用程序可以写入数据的目录。 |
| <a href="#fs_t_fs_open_dir">fs\_open\_dir</a> | 打开目录。 |
| <a href="#fs_t_fs_open_file">fs\_open\_file</a> | 打开文件。 |
| <a href="#fs_t_fs_remove_dir">fs\_remove\_dir</a> | 刪除目录。 |
@ -478,6 +479,26 @@ ret_t fs_get_file_size (fs_t* fs, const char* name);
| 返回值 | ret\_t | 返回不是-1表示成功否则表示失败。 |
| fs | fs\_t* | 文件系统对象一般赋值为os\_fs()。 |
| name | const char* | 文件名。 |
#### fs\_get\_user\_storage\_path 函数
-----------------------
* 函数功能:
> <p id="fs_t_fs_get_user_storage_path">获取home目录或者应用程序可以写入数据的目录。
* 函数原型:
```
ret_t fs_get_user_storage_path (fs_t* fs, char* path);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| fs | fs\_t* | 文件系统对象一般赋值为os\_fs()。 |
| path | char* | 保存路径。 |
#### fs\_open\_dir 函数
-----------------------

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.9 KiB

After

Width:  |  Height:  |  Size: 4.6 KiB

View File

@ -42,7 +42,7 @@
| -------- | ----- | ------------ |
| <a href="#input_method_t_action_button_enable">action\_button\_enable</a> | bool\_t | 软键盘的上的action按钮是否可用。 |
| <a href="#input_method_t_action_button_enable">action\_button\_enable</a> | bool\_t | 软键盘的上的action按钮文本。 |
| <a href="#input_method_t_input_type">input\_type</a> | input\_type\_t | 当前输入的类型。 |
| <a href="#input_method_t_keyboard_name">keyboard\_name</a> | char* | 软键盘资源名称。 |
#### input\_method 函数
-----------------------
@ -361,11 +361,11 @@ ret_t input_method_update_action_button_info (input_method_t* im, char* text, bo
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### input\_type 属性
#### keyboard\_name 属性
-----------------------
> <p id="input_method_t_input_type">当前输入的类型
> <p id="input_method_t_keyboard_name">软键盘资源名称
* 类型:input\_type\_t
* 类型:char*
| 特性 | 是否支持 |
| -------- | ----- |

View File

@ -46,6 +46,7 @@
| <a href="#lcd_t_font_size">font\_size</a> | uint32\_t | 字体大小。 |
| <a href="#lcd_t_global_alpha">global\_alpha</a> | uint8\_t | 全局alpha |
| <a href="#lcd_t_height">height</a> | wh\_t | 屏幕的高度 |
| <a href="#lcd_t_last_update_time">last\_update\_time</a> | uint64\_t | last update time |
| <a href="#lcd_t_ratio">ratio</a> | float\_t | 屏幕密度。 |
| <a href="#lcd_t_stroke_color">stroke\_color</a> | color\_t | 线条颜色 |
| <a href="#lcd_t_support_dirty_rect">support\_dirty\_rect</a> | bool\_t | 是否支持脏矩形。 |
@ -688,6 +689,16 @@ ret_t lcd_take_snapshot (lcd_t* lcd, bitmap_t* img, bool_t auto_rotate);
* 类型wh\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### last\_update\_time 属性
-----------------------
> <p id="lcd_t_last_update_time">last update time
* 类型uint64\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |

View File

@ -36,6 +36,7 @@ time\_clock一般不需要设置style。
| <a href="#mledit_t_mledit_set_cursor">mledit\_set\_cursor</a> | 设置编辑器光标位置。 |
| <a href="#mledit_t_mledit_set_focus">mledit\_set\_focus</a> | 设置为焦点。 |
| <a href="#mledit_t_mledit_set_input_tips">mledit\_set\_input\_tips</a> | 设置编辑器的输入提示。 |
| <a href="#mledit_t_mledit_set_keyboard">mledit\_set\_keyboard</a> | 设置自定义软键盘名称。 |
| <a href="#mledit_t_mledit_set_max_lines">mledit\_set\_max\_lines</a> | 设置编辑器的最大行数。 |
| <a href="#mledit_t_mledit_set_readonly">mledit\_set\_readonly</a> | 设置编辑器是否为只读。 |
| <a href="#mledit_t_mledit_set_scroll_line">mledit\_set\_scroll\_line</a> | 设置编辑器滚动速度。 |
@ -46,6 +47,7 @@ time\_clock一般不需要设置style。
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#mledit_t_bottom_margin">bottom\_margin</a> | uint8\_t | 下边距。 |
| <a href="#mledit_t_keyboard">keyboard</a> | char* | 自定义软键盘名称。 |
| <a href="#mledit_t_left_margin">left\_margin</a> | uint8\_t | 左边距。 |
| <a href="#mledit_t_max_lines">max\_lines</a> | uint32\_t | 最大行数。 |
| <a href="#mledit_t_readonly">readonly</a> | bool\_t | 编辑器是否为只读。 |
@ -163,6 +165,26 @@ ret_t mledit_set_input_tips (widget_t* widget, char* tips);
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| tips | char* | 输入提示。 |
#### mledit\_set\_keyboard 函数
-----------------------
* 函数功能:
> <p id="mledit_t_mledit_set_keyboard">设置自定义软键盘名称。
* 函数原型:
```
ret_t mledit_set_keyboard (widget_t* widget, char* keyboard);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| keyboard | char* | 键盘名称(相应UI资源必须存在)。 |
#### mledit\_set\_max\_lines 函数
-----------------------
@ -249,6 +271,22 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
* 类型uint8\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### keyboard 属性
-----------------------
> <p id="mledit_t_keyboard">自定义软键盘名称。
* 类型char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |

View File

@ -23,7 +23,13 @@ str_reset(&s);
| -------- | ------------ |
| <a href="#str_t_str_append">str\_append</a> | 追加字符串。 |
| <a href="#str_t_str_append_char">str\_append\_char</a> | 追加一个字符。 |
| <a href="#str_t_str_append_double">str\_append\_double</a> | 追加一个浮点数。 |
| <a href="#str_t_str_append_int">str\_append\_int</a> | 追加一个整数。 |
| <a href="#str_t_str_append_json_double_pair">str\_append\_json\_double\_pair</a> | 追加bool格式的json键值对。 |
| <a href="#str_t_str_append_json_double_pair">str\_append\_json\_double\_pair</a> | 追加doube格式的json键值对。 |
| <a href="#str_t_str_append_json_int_pair">str\_append\_json\_int\_pair</a> | 追加int格式的json键值对。 |
| <a href="#str_t_str_append_json_str">str\_append\_json\_str</a> | 追加一个字符串,字符串前后加英文双引号,字符串本身的双引号被转义为\"。 |
| <a href="#str_t_str_append_json_str_pair">str\_append\_json\_str\_pair</a> | 追加字符串格式的json键值对。 |
| <a href="#str_t_str_append_with_len">str\_append\_with\_len</a> | 追加字符串。 |
| <a href="#str_t_str_clear">str\_clear</a> | 清除字符串内容。 |
| <a href="#str_t_str_decode_xml_entity">str\_decode\_xml\_entity</a> | 对XML基本的entity进行解码目前仅支持&lt;&gt;&quota;&amp;。 |
@ -103,6 +109,27 @@ ret_t str_append_char (str_t* str, char c);
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| str | str\_t* | str对象。 |
| c | char | 要追加的字符。 |
#### str\_append\_double 函数
-----------------------
* 函数功能:
> <p id="str_t_str_append_double">追加一个浮点数。
* 函数原型:
```
ret_t str_append_double (str_t* str, const char* format, double value);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| str | str\_t* | str对象。 |
| format | const char* | 格式。 |
| value | double | 要追加的浮点数。 |
#### str\_append\_int 函数
-----------------------
@ -123,6 +150,110 @@ ret_t str_append_int (str_t* str, int32_t value);
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| str | str\_t* | str对象。 |
| value | int32\_t | 要追加的整数。 |
#### str\_append\_json\_double\_pair 函数
-----------------------
* 函数功能:
> <p id="str_t_str_append_json_double_pair">追加bool格式的json键值对。
* 函数原型:
```
ret_t str_append_json_double_pair (str_t* str, const char* key, bool_t value);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| str | str\_t* | str对象。 |
| key | const char* | 键。 |
| value | bool\_t | 值。 |
#### str\_append\_json\_double\_pair 函数
-----------------------
* 函数功能:
> <p id="str_t_str_append_json_double_pair">追加doube格式的json键值对。
* 函数原型:
```
ret_t str_append_json_double_pair (str_t* str, const char* key, double value);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| str | str\_t* | str对象。 |
| key | const char* | 键。 |
| value | double | 值。 |
#### str\_append\_json\_int\_pair 函数
-----------------------
* 函数功能:
> <p id="str_t_str_append_json_int_pair">追加int格式的json键值对。
* 函数原型:
```
ret_t str_append_json_int_pair (str_t* str, const char* key, int32_t value);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| str | str\_t* | str对象。 |
| key | const char* | 键。 |
| value | int32\_t | 值。 |
#### str\_append\_json\_str 函数
-----------------------
* 函数功能:
> <p id="str_t_str_append_json_str">追加一个字符串,字符串前后加英文双引号,字符串本身的双引号被转义为\"。
* 函数原型:
```
ret_t str_append_json_str (str_t* str, const char* json_str);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| str | str\_t* | str对象。 |
| json\_str | const char* | 待追加的字符串。 |
#### str\_append\_json\_str\_pair 函数
-----------------------
* 函数功能:
> <p id="str_t_str_append_json_str_pair">追加字符串格式的json键值对。
* 函数原型:
```
ret_t str_append_json_str_pair (str_t* str, const char* key, const char* value);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| str | str\_t* | str对象。 |
| key | const char* | 键。 |
| value | const char* | 值。 |
#### str\_append\_with\_len 函数
-----------------------

View File

@ -23,6 +23,7 @@
| <a href="#utils_t_tk_str_toupper">tk\_str\_toupper</a> | 将小写字母转换为大写字母。 |
| <a href="#utils_t_tk_strcpy">tk\_strcpy</a> | 将src所指向的字符串复制到dst。 |
| <a href="#utils_t_tk_strdup">tk\_strdup</a> | 字符串拷贝函数。 |
| <a href="#utils_t_tk_strlen">tk\_strlen</a> | 获取字符串的长度。str为空时返回0。 |
| <a href="#utils_t_tk_strncpy">tk\_strncpy</a> | 将src所指向的字符串复制到dst最多复制len个字符串。 |
| <a href="#utils_t_tk_strndup">tk\_strndup</a> | 字符串拷贝函数最多复制len个字符串。 |
| <a href="#utils_t_tk_strtol">tk\_strtol</a> | 将字符串转换为长整形。 |
@ -347,6 +348,25 @@ char* tk_strdup (const char* str);
| -------- | ----- | --------- |
| 返回值 | char* | 返回指向的复制字符串指针如果失败则返回NULL。 |
| str | const char* | 原字符串。 |
#### tk\_strlen 函数
-----------------------
* 函数功能:
> <p id="utils_t_tk_strlen">获取字符串的长度。str为空时返回0。
* 函数原型:
```
uint32_t tk_strlen (const char* str);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 返回字符串的长度。 |
| str | const char* | 字符串。 |
#### tk\_strncpy 函数
-----------------------

View File

@ -12,7 +12,7 @@
| <a href="#value_desc_double_t_defvalue">defvalue</a> | double | 缺省值。 |
| <a href="#value_desc_double_t_max">max</a> | double | 最大值。 |
| <a href="#value_desc_double_t_min">min</a> | double | 最小值。 |
| <a href="#value_desc_double_t_step">step</a> | double\_t | 步长。 |
| <a href="#value_desc_double_t_step">step</a> | double | 步长。 |
| <a href="#value_desc_double_t_unit">unit</a> | const char* | 单位。 |
#### defvalue 属性
-----------------------
@ -48,7 +48,7 @@
-----------------------
> <p id="value_desc_double_t_step">步长。
* 类型double\_t
* 类型double
| 特性 | 是否支持 |
| -------- | ----- |

View File

@ -67,10 +67,6 @@ value_set_int(&v, 100);
| <a href="#value_t_value_uint64">value\_uint64</a> | 获取类型为uint64的值。 |
| <a href="#value_t_value_uint8">value\_uint8</a> | 获取类型为uint8的值。 |
| <a href="#value_t_value_wstr">value\_wstr</a> | 获取类型为宽字符串的值。 |
| <a href="#value_t_waitable_action_queue_create">waitable\_action\_queue\_create</a> | 创建waitable_action_queue对象。 |
| <a href="#value_t_waitable_action_queue_destroy">waitable\_action\_queue\_destroy</a> | 销毁。 |
| <a href="#value_t_waitable_action_queue_recv">waitable\_action\_queue\_recv</a> | 接收一个请求。 |
| <a href="#value_t_waitable_action_queue_send">waitable\_action\_queue\_send</a> | 发送一个请求。 |
#### value\_binary\_data 函数
-----------------------
@ -1071,83 +1067,3 @@ const wchar_t* value_wstr (value_t* v);
| -------- | ----- | --------- |
| 返回值 | const wchar\_t* | 值。 |
| v | value\_t* | value对象。 |
#### waitable\_action\_queue\_create 函数
-----------------------
* 函数功能:
> <p id="value_t_waitable_action_queue_create">创建waitable_action_queue对象。
* 函数原型:
```
waitable_action_queue_t* waitable_action_queue_create (uint32_t capacity);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | waitable\_action\_queue\_t* | waitable\_action\_queue对象。 |
| capacity | uint32\_t | action的容量。 |
#### waitable\_action\_queue\_destroy 函数
-----------------------
* 函数功能:
> <p id="value_t_waitable_action_queue_destroy">销毁。
* 函数原型:
```
ret_t waitable_action_queue_destroy (waitable_action_queue_t* q);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| q | waitable\_action\_queue\_t* | waitable\_action\_queue对象。 |
#### waitable\_action\_queue\_recv 函数
-----------------------
* 函数功能:
> <p id="value_t_waitable_action_queue_recv">接收一个请求。
* 函数原型:
```
ret_t waitable_action_queue_recv (waitable_action_queue_t* q, qaction_t** action, uint32_t timeout_ms);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| q | waitable\_action\_queue\_t* | waitable\_action\_queue对象。 |
| action | qaction\_t** | 用于返回action对象。 |
| timeout\_ms | uint32\_t | 超时时间(ms) |
#### waitable\_action\_queue\_send 函数
-----------------------
* 函数功能:
> <p id="value_t_waitable_action_queue_send">发送一个请求。
* 函数原型:
```
ret_t waitable_action_queue_send (waitable_action_queue_t* q, qaction_t* action, uint32_t timeout_ms);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| q | waitable\_action\_queue\_t* | waitable\_action\_queue对象。 |
| action | qaction\_t* | action对象。 |
| timeout\_ms | uint32\_t | 超时时间(ms) |

View File

@ -32,6 +32,13 @@ view\_t是[widget\_t](widget_t.md)的子类控件widget\_t的函数均适用
| -------- | ------------ |
| <a href="#view_t_view_cast">view\_cast</a> | 转换为view对象(供脚本语言使用)。 |
| <a href="#view_t_view_create">view\_create</a> | 创建view对象 |
| <a href="#view_t_view_set_default_focused_child">view\_set\_default\_focused\_child</a> | 设置缺省获得焦点的子控件(可用控件名或类型)。 |
### 属性
<p id="view_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#view_t_default_focused_child">default\_focused\_child</a> | char* | 缺省获得焦点的子控件(可用控件名或类型)。 |
#### view\_cast 函数
-----------------------
@ -74,3 +81,43 @@ widget_t* view_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
#### view\_set\_default\_focused\_child 函数
-----------------------
* 函数功能:
> <p id="view_t_view_set_default_focused_child">设置缺省获得焦点的子控件(可用控件名或类型)。
* 函数原型:
```
ret_t view_set_default_focused_child (widget_t* widget, const char* default_focused_child);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| default\_focused\_child | const char* | 缺省获得焦点的子控件(可用控件名或类型)。 |
#### default\_focused\_child 属性
-----------------------
> <p id="view_t_default_focused_child">缺省获得焦点的子控件(可用控件名或类型)。
> view作为pages/slideview的直接子控件才需要设置。
> 正常情况下,一个窗口只能指定一个初始焦点。
> 但是对于pages/slideview来说可能希望每一个页面都有一个初始焦点此时可用default\_focused\_child来指定。
* 类型char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |

View File

@ -0,0 +1,93 @@
## waitable\_action\_queue\_t
### 概述
waitable actionqueue
----------------------------------
### 函数
<p id="waitable_action_queue_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#waitable_action_queue_t_waitable_action_queue_create">waitable\_action\_queue\_create</a> | 创建waitable_action_queue对象。 |
| <a href="#waitable_action_queue_t_waitable_action_queue_destroy">waitable\_action\_queue\_destroy</a> | 销毁。 |
| <a href="#waitable_action_queue_t_waitable_action_queue_recv">waitable\_action\_queue\_recv</a> | 接收一个请求。 |
| <a href="#waitable_action_queue_t_waitable_action_queue_send">waitable\_action\_queue\_send</a> | 发送一个请求。 |
#### waitable\_action\_queue\_create 函数
-----------------------
* 函数功能:
> <p id="waitable_action_queue_t_waitable_action_queue_create">创建waitable_action_queue对象。
* 函数原型:
```
waitable_action_queue_t* waitable_action_queue_create (uint32_t capacity);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | waitable\_action\_queue\_t* | waitable\_action\_queue对象。 |
| capacity | uint32\_t | action的容量。 |
#### waitable\_action\_queue\_destroy 函数
-----------------------
* 函数功能:
> <p id="waitable_action_queue_t_waitable_action_queue_destroy">销毁。
* 函数原型:
```
ret_t waitable_action_queue_destroy (waitable_action_queue_t* q);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| q | waitable\_action\_queue\_t* | waitable\_action\_queue对象。 |
#### waitable\_action\_queue\_recv 函数
-----------------------
* 函数功能:
> <p id="waitable_action_queue_t_waitable_action_queue_recv">接收一个请求。
* 函数原型:
```
ret_t waitable_action_queue_recv (waitable_action_queue_t* q, qaction_t** action, uint32_t timeout_ms);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| q | waitable\_action\_queue\_t* | waitable\_action\_queue对象。 |
| action | qaction\_t** | 用于返回action对象。 |
| timeout\_ms | uint32\_t | 超时时间(ms) |
#### waitable\_action\_queue\_send 函数
-----------------------
* 函数功能:
> <p id="waitable_action_queue_t_waitable_action_queue_send">发送一个请求。
* 函数原型:
```
ret_t waitable_action_queue_send (waitable_action_queue_t* q, qaction_t* action, uint32_t timeout_ms);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| q | waitable\_action\_queue\_t* | waitable\_action\_queue对象。 |
| action | qaction\_t* | action对象。 |
| timeout\_ms | uint32\_t | 超时时间(ms) |

View File

@ -0,0 +1,96 @@
## waitable\_ring\_buffer\_t
### 概述
waitable ring buffer
----------------------------------
### 函数
<p id="waitable_ring_buffer_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#waitable_ring_buffer_t_waitable_ring_buffer_create">waitable\_ring\_buffer\_create</a> | 创建waitable_ring_buffer对象。 |
| <a href="#waitable_ring_buffer_t_waitable_ring_buffer_destroy">waitable\_ring\_buffer\_destroy</a> | 销毁。 |
| <a href="#waitable_ring_buffer_t_waitable_ring_buffer_read">waitable\_ring\_buffer\_read</a> | 读取数据。 |
| <a href="#waitable_ring_buffer_t_waitable_ring_buffer_write">waitable\_ring\_buffer\_write</a> | 写入数据。 |
#### waitable\_ring\_buffer\_create 函数
-----------------------
* 函数功能:
> <p id="waitable_ring_buffer_t_waitable_ring_buffer_create">创建waitable_ring_buffer对象。
* 函数原型:
```
waitable_ring_buffer_t* waitable_ring_buffer_create (uint32_t capacity, uint32_t block_size);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | waitable\_ring\_buffer\_t* | waitable\_ring\_buffer对象。 |
| capacity | uint32\_t | 容量。 |
| block\_size | uint32\_t | 块的大小。 |
#### waitable\_ring\_buffer\_destroy 函数
-----------------------
* 函数功能:
> <p id="waitable_ring_buffer_t_waitable_ring_buffer_destroy">销毁。
* 函数原型:
```
ret_t waitable_ring_buffer_destroy (waitable_ring_buffer_t* rb);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| rb | waitable\_ring\_buffer\_t* | waitable\_ring\_buffer对象。 |
#### waitable\_ring\_buffer\_read 函数
-----------------------
* 函数功能:
> <p id="waitable_ring_buffer_t_waitable_ring_buffer_read">读取数据。
* 函数原型:
```
ret_t waitable_ring_buffer_read (waitable_ring_buffer_t* rb, void* buff, uint32_t size, uint32_t timeout_ms);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| rb | waitable\_ring\_buffer\_t* | waitable\_ring\_buffer对象。 |
| buff | void* | 接收数据的buff。 |
| size | uint32\_t | 读取数据的长度(必须等于 block\_size)。 |
| timeout\_ms | uint32\_t | 超时时间(ms) |
#### waitable\_ring\_buffer\_write 函数
-----------------------
* 函数功能:
> <p id="waitable_ring_buffer_t_waitable_ring_buffer_write">写入数据。
* 函数原型:
```
ret_t waitable_ring_buffer_write (waitable_ring_buffer_t* rb, const void* buff, uint32_t size, uint32_t timeout_ms);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| rb | waitable\_ring\_buffer\_t* | waitable\_ring\_buffer对象。 |
| buff | const void* | 要写入的数据。 |
| size | uint32\_t | 数据的长度(必须等于 block\_size)。 |
| timeout\_ms | uint32\_t | 超时时间(ms) |

View File

@ -57,6 +57,8 @@
| WIDGET\_PROP\_MIN | 最小值。 |
| WIDGET\_PROP\_TIPS | 提示信息。 |
| WIDGET\_PROP\_INPUT\_TYPE | 输入类型。 |
| WIDGET\_PROP\_KEYBOARD | 自定义软键盘资源名称。 |
| WIDGET\_PROP\_DEFAULT\_FOCUSED\_CHILD | 缺省获得焦点的子控件(可用控件名或类型)。 |
| WIDGET\_PROP\_READONLY | 只读模式。 |
| WIDGET\_PROP\_PASSWORD\_VISIBLE | 密码是否可见。 |
| WIDGET\_PROP\_ACTIVE | 是否处于active状态。 |

View File

@ -119,6 +119,8 @@ widget_on(button, EVT_CLICK, on_click, NULL);
| <a href="#widget_t_widget_restack">widget\_restack</a> | 调整控件在父控件中的位置序数。 |
| <a href="#widget_t_widget_set_animation">widget\_set\_animation</a> | 设置控件的动画参数(仅用于在UI文件使用)。 |
| <a href="#widget_t_widget_set_animator_time_scale">widget\_set\_animator\_time\_scale</a> | 设置动画的时间倍率,<0: 时间倒退<1: 时间变慢>1 时间变快。 |
| <a href="#widget_t_widget_set_child_text_utf8">widget\_set\_child\_text\_utf8</a> | 设置子控件的文本。 |
| <a href="#widget_t_widget_set_child_text_with_double">widget\_set\_child\_text\_with\_double</a> | 用一个浮点数去设置子控件的文本。 |
| <a href="#widget_t_widget_set_children_layout">widget\_set\_children\_layout</a> | 设置子控件的布局参数。 |
| <a href="#widget_t_widget_set_dirty_rect_tolerance">widget\_set\_dirty\_rect\_tolerance</a> | 设置控件脏矩形超出控件本身大小的最大范围(一般不用指定)。 |
| <a href="#widget_t_widget_set_enable">widget\_set\_enable</a> | 设置控件的可用性。 |
@ -1702,6 +1704,51 @@ ret_t widget_set_animator_time_scale (widget_t* widget, const char* name, float_
| widget | widget\_t* | 控件对象。 |
| name | const char* | 动画名称。 |
| time\_scale | float\_t | 时间倍率。 |
#### widget\_set\_child\_text\_utf8 函数
-----------------------
* 函数功能:
> <p id="widget_t_widget_set_child_text_utf8">设置子控件的文本。
只是对widget\_set\_prop的包装文本的意义由子类控件决定。
* 函数原型:
```
ret_t widget_set_child_text_utf8 (widget_t* widget, const char* name, const char* text);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| name | const char* | 子控件的名称。 |
| text | const char* | 文本。 |
#### widget\_set\_child\_text\_with\_double 函数
-----------------------
* 函数功能:
> <p id="widget_t_widget_set_child_text_with_double">用一个浮点数去设置子控件的文本。
只是对widget\_set\_prop的包装文本的意义由子类控件决定。
* 函数原型:
```
ret_t widget_set_child_text_with_double (widget_t* widget, const char* name, const char* format, double value);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| name | const char* | 子控件的名称。 |
| format | const char* | 格式字符串(如:"%2.2lf")。 |
| value | double | 浮点数值。 |
#### widget\_set\_children\_layout 函数
-----------------------

File diff suppressed because it is too large Load Diff