mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-12-01 19:49:11 +08:00
update api docs
This commit is contained in:
lixianjing
parent
c95df6bb6a
commit
ea521291e6
@ -3,6 +3,7 @@
|
||||
2023/09/24
|
||||
* 增加函数tk\_iostream\_tcp\_create\_client
|
||||
* 增加函数hash\_table\_size
|
||||
* 更新API文档。
|
||||
|
||||
2023/09/23
|
||||
* 完善socket\_helper
|
||||
|
||||
@ -9,3 +9,4 @@
|
||||
| APP\_MOBILE | 嵌入式或移动APP |
|
||||
| APP\_SIMULATOR | 模拟器。 |
|
||||
| APP\_DESKTOP | 桌面应用程序。 |
|
||||
| APP\_CONSOLE | 控制台（没有界面）。 |
|
||||
|
||||
12
docs/manual/bytesize_t.md
Normal file
12
docs/manual/bytesize_t.md
Normal file
@ -0,0 +1,12 @@
|
||||
## bytesize\_t
|
||||
### 概述
|
||||
串口字节位数。
|
||||
### 常量
|
||||
<p id="bytesize_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| fivebits | 每字节5位。 |
|
||||
| sixbits | 每字节6位。 |
|
||||
| sevenbits | 每字节7位。 |
|
||||
| eightbits | 每字节8位。 |
|
||||
@ -10,6 +10,7 @@
|
||||
| <a href="#cmd_args_t_cmd_args_init">cmd\_args\_init</a> | 初始化。 |
|
||||
| <a href="#cmd_args_t_cmd_args_process">cmd\_args\_process</a> | 处理。 |
|
||||
| <a href="#cmd_args_t_cmd_args_process_str">cmd\_args\_process\_str</a> | 处理。 |
|
||||
| <a href="#cmd_args_t_cmd_args_process_wstr">cmd\_args\_process\_wstr</a> | 处理。 |
|
||||
| <a href="#cmd_args_t_cmd_args_show_help">cmd\_args\_show\_help</a> | 显示帮助信息。 |
|
||||
#### cmd\_args\_init 函数
|
||||
-----------------------
|
||||
@ -76,6 +77,27 @@ ret_t cmd_args_process_str (cmd_args_t* args, const char* cmd_line);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| args | cmd\_args\_t* | args对象。 |
|
||||
| cmd\_line | const char* | 字符串格式的参数(适用于Windows)。 |
|
||||
#### cmd\_args\_process\_wstr 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="cmd_args_t_cmd_args_process_wstr">处理。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t cmd_args_process_wstr (cmd_args_t* args, int argc, wchar_t** argv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| args | cmd\_args\_t* | args对象。 |
|
||||
| argc | int | 参数个数。 |
|
||||
| argv | wchar\_t** | 参数数组。 |
|
||||
#### cmd\_args\_show\_help 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -39,12 +39,14 @@
|
||||
| <a href="#conf_doc_t_conf_doc_set_int">conf\_doc\_set\_int</a> | 设置指定路径节点的值。 |
|
||||
| <a href="#conf_doc_t_conf_doc_set_node_prop">conf\_doc\_set\_node\_prop</a> | 设置节点的属性。 |
|
||||
| <a href="#conf_doc_t_conf_doc_set_str">conf\_doc\_set\_str</a> | 设置指定路径节点的值。 |
|
||||
| <a href="#conf_doc_t_conf_doc_use_extend_type">conf\_doc\_use\_extend\_type</a> | 使用拓展类型。 |
|
||||
### 属性
|
||||
<p id="conf_doc_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#conf_doc_t_root">root</a> | conf\_node\_t* | 根节点。 |
|
||||
| <a href="#conf_doc_t_use_extend_type">use\_extend\_type</a> | bool\_t | 使用拓展类型。 |
|
||||
#### conf\_doc\_add\_child 函数
|
||||
-----------------------
|
||||
|
||||
@ -705,9 +707,35 @@ ret_t conf_doc_set_str (conf_doc_t* doc, const char* path, const char* v);
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| path | const char* | 节点的路径。 |
|
||||
| v | const char* | 值。 |
|
||||
#### conf\_doc\_use\_extend\_type 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_use_extend_type">使用拓展类型。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_use_extend_type (conf_doc_t* doc, bool_t use);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| use | bool\_t | 是否使用拓展类型。 |
|
||||
#### root 属性
|
||||
-----------------------
|
||||
> <p id="conf_doc_t_root">根节点。
|
||||
|
||||
* 类型：conf\_node\_t*
|
||||
|
||||
#### use\_extend\_type 属性
|
||||
-----------------------
|
||||
> <p id="conf_doc_t_use_extend_type">使用拓展类型。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
|
||||
@ -9,11 +9,34 @@ conf json对象。
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_json_t_conf_doc_save_json_ex">conf\_doc\_save\_json\_ex</a> | 功能描述 |
|
||||
| <a href="#conf_json_t_conf_json_create">conf\_json\_create</a> | 创建一个空的conf对象。 |
|
||||
| <a href="#conf_json_t_conf_json_load">conf\_json\_load</a> | 从指定URL加载JSON对象。 |
|
||||
| <a href="#conf_json_t_conf_json_load_ex">conf\_json\_load\_ex</a> | 从指定URL加载JSON对象。 |
|
||||
| <a href="#conf_json_t_conf_json_load_from_buff">conf\_json\_load\_from\_buff</a> | 从内存加载JSON对象。 |
|
||||
| <a href="#conf_json_t_conf_json_save_as">conf\_json\_save\_as</a> | 将doc对象保存到指定URL。 |
|
||||
| <a href="#conf_json_t_conf_json_save_to_buff">conf\_json\_save\_to\_buff</a> | 将obj保存为JSON格式到内存。 |
|
||||
#### conf\_doc\_save\_json\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_json_t_conf_doc_save_json_ex">功能描述
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_save_json_ex (conf_doc_t* doc, str_t* str, uint32_t indent);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回 ret\_t值 |
|
||||
| doc | conf\_doc\_t* | doc对象 |
|
||||
| str | str\_t* | 保存结果 |
|
||||
| indent | uint32\_t | 缩进 |
|
||||
#### conf\_json\_create 函数
|
||||
-----------------------
|
||||
|
||||
@ -52,6 +75,27 @@ tk_object_t* conf_json_load (const char* url, bool_t create_if_not_exist);
|
||||
| 返回值 | tk\_object\_t* | 返回配置对象。 |
|
||||
| url | const char* | 路径(通常是文件路径)。 |
|
||||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||||
#### conf\_json\_load\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_json_t_conf_json_load_ex">从指定URL加载JSON对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
tk_object_t* conf_json_load_ex (const char* url, bool_t create_if_not_exist, bool_t use_extend_type);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | tk\_object\_t* | 返回配置对象。 |
|
||||
| url | const char* | 路径(通常是文件路径)。 |
|
||||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||||
| use\_extend\_type | bool\_t | 是否使用拓展类型。 |
|
||||
#### conf\_json\_load\_from\_buff 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
## conf\_node\_value\_t
|
||||
### 概述
|
||||
节点值得类型。
|
||||
节点值的类型。
|
||||
### 常量
|
||||
<p id="conf_node_value_t_consts">
|
||||
|
||||
|
||||
@ -10,6 +10,7 @@ conf对象。
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_obj_t_conf_obj_create">conf\_obj\_create</a> | |
|
||||
| <a href="#conf_obj_t_conf_obj_create_ex">conf\_obj\_create\_ex</a> | |
|
||||
| <a href="#conf_obj_t_conf_obj_create_sub_object">conf\_obj\_create\_sub\_object</a> | 根据路径创建一个子对象。 |
|
||||
| <a href="#conf_obj_t_conf_obj_get_doc">conf\_obj\_get\_doc</a> | 获取doc对象，用于更高级的操作。 |
|
||||
| <a href="#conf_obj_t_conf_obj_save">conf\_obj\_save</a> | 保存文档。 |
|
||||
@ -36,6 +37,29 @@ tk_object_t* conf_obj_create (conf_doc_save_t save, conf_doc_load_t load, const
|
||||
| load | conf\_doc\_load\_t | 加载函数。 |
|
||||
| url | const char* | 路径。 |
|
||||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||||
#### conf\_obj\_create\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_obj_t_conf_obj_create_ex">
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
tk_object_t* conf_obj_create_ex (conf_doc_save_t save, conf_doc_load_t load, const char* url, bool_t create_if_not_exist, bool_t use_extend_type);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | tk\_object\_t* | 返回配置对象。 |
|
||||
| save | conf\_doc\_save\_t | 保存函数。 |
|
||||
| load | conf\_doc\_load\_t | 加载函数。 |
|
||||
| url | const char* | 路径。 |
|
||||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||||
| use\_extend\_type | bool\_t | 是否使用拓展类型。 |
|
||||
#### conf\_obj\_create\_sub\_object 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
11
docs/manual/flowcontrol_t.md
Normal file
11
docs/manual/flowcontrol_t.md
Normal file
@ -0,0 +1,11 @@
|
||||
## flowcontrol\_t
|
||||
### 概述
|
||||
串口流控。
|
||||
### 常量
|
||||
<p id="flowcontrol_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| flowcontrol\_none | 无。 |
|
||||
| flowcontrol\_software | 软件。 |
|
||||
| flowcontrol\_hardware | 硬件。 |
|
||||
@ -8,9 +8,31 @@
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#font_managers_t_font_manager_fallback_get_font_default">font\_manager\_fallback\_get\_font\_default</a> | |
|
||||
| <a href="#font_managers_t_font_managers_ref">font\_managers\_ref</a> | 获取指定小应用程序(applet)的字体管理器。 |
|
||||
| <a href="#font_managers_t_font_managers_unload_all">font\_managers\_unload\_all</a> | 卸载全部字体。 |
|
||||
| <a href="#font_managers_t_font_managers_unref">font\_managers\_unref</a> | 释放指定小应用程序(applet)的字体管理器。 |
|
||||
#### font\_manager\_fallback\_get\_font\_default 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_managers_t_font_manager_fallback_get_font_default">
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
font_t* font_manager_fallback_get_font_default (void* ctx, const char* name, font_size_t size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | font\_t* | 返回字体对象。 |
|
||||
| ctx | void* | 上下文。 |
|
||||
| name | const char* | 名称。 |
|
||||
| size | font\_size\_t | 大小。 |
|
||||
#### font\_managers\_ref 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -37,6 +37,7 @@ hash_table_destroy(hash_table);
|
||||
| <a href="#hash_table_t_hash_table_init">hash\_table\_init</a> | 初始化hash_table对象。 |
|
||||
| <a href="#hash_table_t_hash_table_remove">hash\_table\_remove</a> | 删除第一个满足条件的元素。 |
|
||||
| <a href="#hash_table_t_hash_table_remove_all">hash\_table\_remove\_all</a> | 删除全部满足条件的元素。 |
|
||||
| <a href="#hash_table_t_hash_table_size">hash\_table\_size</a> | 返回全部元素个数。 |
|
||||
### 属性
|
||||
<p id="hash_table_t_properties">
|
||||
|
||||
@ -104,7 +105,7 @@ int32_t hash_table_count (hash_table_t* hash_table, tk_compare_t cmp, void* ctx)
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回元素个数。 |
|
||||
| hash\_table | hash\_table\_t* | 单向链表对象。 |
|
||||
| hash\_table | hash\_table\_t* | 哈希表对象。 |
|
||||
| cmp | tk\_compare\_t | 比较函数，为NULL则使用内置的比较函数。 |
|
||||
| ctx | void* | 比较函数的上下文。 |
|
||||
#### hash\_table\_create 函数
|
||||
@ -312,6 +313,25 @@ ret_t hash_table_remove_all (hash_table_t* hash_table, tk_compare_t cmp, void* c
|
||||
| hash\_table | hash\_table\_t* | 哈希表对象。 |
|
||||
| cmp | tk\_compare\_t | 比较函数，为NULL则使用内置的比较函数。 |
|
||||
| ctx | void* | 比较函数的上下文。 |
|
||||
#### hash\_table\_size 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="hash_table_t_hash_table_size">返回全部元素个数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t hash_table_size (hash_table_t* hash_table);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回元素个数。 |
|
||||
| hash\_table | hash\_table\_t* | 哈希表对象。 |
|
||||
#### buckets 属性
|
||||
-----------------------
|
||||
> <p id="hash_table_t_buckets">buckets。
|
||||
|
||||
@ -30,6 +30,7 @@ idle_add(something_on_idle, edit);
|
||||
| <a href="#idle_t_idle_add">idle\_add</a> | 增加一个idle。 |
|
||||
| <a href="#idle_t_idle_count">idle\_count</a> | 返回idle的个数。 |
|
||||
| <a href="#idle_t_idle_dispatch">idle\_dispatch</a> | 调用全部idle的函数。 |
|
||||
| <a href="#idle_t_idle_exist">idle\_exist</a> | idle是否存在。 |
|
||||
| <a href="#idle_t_idle_find">idle\_find</a> | 查找指定ID的idle。 |
|
||||
| <a href="#idle_t_idle_queue">idle\_queue</a> | 用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。 |
|
||||
| <a href="#idle_t_idle_queue_ex">idle\_queue\_ex</a> | 用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。 |
|
||||
@ -92,6 +93,26 @@ ret_t idle_dispatch ();
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### idle\_exist 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="idle_t_idle_exist">idle是否存在。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t idle_exist (idle_func_t on_idle, void* ctx);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回TRUE表示存在，否则表示不存在。 |
|
||||
| on\_idle | idle\_func\_t | idle回调函数。 |
|
||||
| ctx | void* | idle回调函数的上下文。 |
|
||||
#### idle\_find 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -52,6 +52,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L1
|
||||
| <a href="#label_t_label_create">label\_create</a> | 创建label对象 |
|
||||
| <a href="#label_t_label_get_widget_vtable">label\_get\_widget\_vtable</a> | 获取 label 虚表。 |
|
||||
| <a href="#label_t_label_resize_to_content">label\_resize\_to\_content</a> | 根据文本内容调节控件大小。 |
|
||||
| <a href="#label_t_label_set_ellipses">label\_set\_ellipses</a> | 是否开启缩写，开启后，当文字长度操作控件长度后，自动变为... |
|
||||
| <a href="#label_t_label_set_length">label\_set\_length</a> | 设置显示字符的个数(小余0时全部显示)。 |
|
||||
| <a href="#label_t_label_set_line_wrap">label\_set\_line\_wrap</a> | 设置是否自动换行。 |
|
||||
| <a href="#label_t_label_set_max_w">label\_set\_max\_w</a> | 设置max_w。 |
|
||||
@ -61,6 +62,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L1
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#label_t_ellipses">ellipses</a> | bool\_t | 是否开启缩写，开启后，当文字长度操作控件长度后，自动变为... |
|
||||
| <a href="#label_t_length">length</a> | int32\_t | 显示字符的个数(小余0时全部显示)。 |
|
||||
| <a href="#label_t_line_wrap">line\_wrap</a> | bool\_t | 是否自动换行(默认FALSE)。 |
|
||||
| <a href="#label_t_max_w">max\_w</a> | int32\_t | 当auto_adjust_size为TRUE时，用于控制控件的最大宽度，超出该宽度后才自动换行。 |
|
||||
@ -148,6 +150,26 @@ ret_t label_resize_to_content (widget_t* widget, uint32_t min_w, uint32_t max_w,
|
||||
| max\_w | uint32\_t | 最大宽度。 |
|
||||
| min\_h | uint32\_t | 最小高度。 |
|
||||
| max\_h | uint32\_t | 最大高度。 |
|
||||
#### label\_set\_ellipses 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="label_t_label_set_ellipses">是否开启缩写，开启后，当文字长度操作控件长度后，自动变为...
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t label_set_ellipses (widget_t* widget, bool_t ellipses);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| ellipses | bool\_t | 是否开启缩写。 |
|
||||
#### label\_set\_length 函数
|
||||
-----------------------
|
||||
|
||||
@ -228,6 +250,23 @@ ret_t label_set_word_wrap (widget_t* widget, bool_t word_wrap);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| word\_wrap | bool\_t | 是否允许整个单词换行。 |
|
||||
#### ellipses 属性
|
||||
-----------------------
|
||||
> <p id="label_t_ellipses">是否开启缩写，开启后，当文字长度操作控件长度后，自动变为...
|
||||
> 和换行是冲突的，换行后，该属性不生效
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### length 属性
|
||||
-----------------------
|
||||
> <p id="label_t_length">显示字符的个数(小余0时全部显示)。
|
||||
|
||||
@ -9,6 +9,7 @@
|
||||
| -------- | ------------ |
|
||||
| <a href="#main_loop_t_main_loop">main\_loop</a> | 获取当前main_loop对象 |
|
||||
| <a href="#main_loop_t_main_loop_add_event_source">main\_loop\_add\_event\_source</a> | 添加event_source。 |
|
||||
| <a href="#main_loop_t_main_loop_get_event_source_manager">main\_loop\_get\_event\_source\_manager</a> | 获取event source manager |
|
||||
| <a href="#main_loop_t_main_loop_remove_event_source">main\_loop\_remove\_event\_source</a> | 删除event_source。 |
|
||||
| <a href="#main_loop_t_main_loop_remove_event_source_by_tag">main\_loop\_remove\_event\_source\_by\_tag</a> | 删除event_source。 |
|
||||
| <a href="#main_loop_t_main_loop_step">main\_loop\_step</a> | 执行一次迭代。 |
|
||||
@ -50,6 +51,25 @@ ret_t main_loop_add_event_source (main_loop_t* l, event_source_t* source);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| l | main\_loop\_t* | main\_loop对象。 |
|
||||
| source | event\_source\_t* | event\_source对象。 |
|
||||
#### main\_loop\_get\_event\_source\_manager 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="main_loop_t_main_loop_get_event_source_manager">获取event source manager
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
event_source_manager_t* main_loop_get_event_source_manager (main_loop_t* l);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | event\_source\_manager\_t* | 返回event source manager对象。 |
|
||||
| l | main\_loop\_t* | main\_loop对象。 |
|
||||
#### main\_loop\_remove\_event\_source 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
13
docs/manual/parity_t.md
Normal file
13
docs/manual/parity_t.md
Normal file
@ -0,0 +1,13 @@
|
||||
## parity\_t
|
||||
### 概述
|
||||
串口奇偶校验。
|
||||
### 常量
|
||||
<p id="parity_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| parity\_none | 无。 |
|
||||
| parity\_odd | 奇校验。 |
|
||||
| parity\_even | 偶校验。 |
|
||||
| parity\_mark | 校验位的电平保持为逻辑 "1"。 |
|
||||
| parity\_space | 校验位的电平保持为逻辑 "0"。 |
|
||||
@ -8,6 +8,8 @@
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#path_t_path_abs">path\_abs</a> | 返回绝对路径。 |
|
||||
| <a href="#path_t_path_abs_normalize">path\_abs\_normalize</a> | 将相对路径转换为绝对路径并规范路径字符形式。 |
|
||||
| <a href="#path_t_path_abs_normalize_with_root">path\_abs\_normalize\_with\_root</a> | 将相对路径转换为绝对路径并规范路径字符形式。 |
|
||||
| <a href="#path_t_path_app_root">path\_app\_root</a> | 获取app所在目录。 |
|
||||
| <a href="#path_t_path_app_root_ex">path\_app\_root\_ex</a> | 获取app所在目录，并追加subpath到后面。 |
|
||||
| <a href="#path_t_path_basename">path\_basename</a> | 返回文件名。 |
|
||||
@ -46,6 +48,48 @@ ret_t path_abs (const char* path, char* result, int32_t size);
|
||||
| path | const char* | 路径。 |
|
||||
| result | char* | 用于返回绝对路径。 |
|
||||
| size | int32\_t | 缓冲区大小。 |
|
||||
#### path\_abs\_normalize 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="path_t_path_abs_normalize">将相对路径转换为绝对路径并规范路径字符形式。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t path_abs_normalize (const char* filename, char* result, int32_t size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| filename | const char* | 相对路径。 |
|
||||
| result | char* | 用于返回绝对路径。 |
|
||||
| size | int32\_t | 缓冲区大小。 |
|
||||
#### path\_abs\_normalize\_with\_root 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="path_t_path_abs_normalize_with_root">将相对路径转换为绝对路径并规范路径字符形式。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* path_abs_normalize_with_root (const char* root, const char* rel_filename, char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回绝对路径。 |
|
||||
| root | const char* | 根目录。 |
|
||||
| rel\_filename | const char* | 相对路径。 |
|
||||
| filename | char* | 用于返回绝对路径。 |
|
||||
#### path\_app\_root 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
70
docs/manual/romfs_t.md
Normal file
70
docs/manual/romfs_t.md
Normal file
@ -0,0 +1,70 @@
|
||||
## romfs\_t
|
||||
### 概述
|
||||
一个简单的ROMFS(目前用于WEB加载配置文件)
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="romfs_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#romfs_t_romfs_deinit">romfs\_deinit</a> | ~初始化。 |
|
||||
| <a href="#romfs_t_romfs_get">romfs\_get</a> | 获取fs对象。 |
|
||||
| <a href="#romfs_t_romfs_init">romfs\_init</a> | 初始化。 |
|
||||
#### romfs\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="romfs_t_romfs_deinit">~初始化。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t romfs_deinit ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### romfs\_get 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="romfs_t_romfs_get">获取fs对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
fs_t* romfs_get ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | fs\_t* | 返回fs对象。 |
|
||||
#### romfs\_init 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="romfs_t_romfs_init">初始化。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t romfs_init (const uint8_t* header_data, uint32_t header_size, const uint8_t* body_data, uint32_t body_size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| header\_data | const uint8\_t* | 文件信息数据。 |
|
||||
| header\_size | uint32\_t | 文件信息数据长度。 |
|
||||
| body\_data | const uint8\_t* | 文件数据。 |
|
||||
| body\_size | uint32\_t | 文件数据长度。 |
|
||||
300
docs/manual/serial_t.md
Normal file
300
docs/manual/serial_t.md
Normal file
@ -0,0 +1,300 @@
|
||||
## serial\_t
|
||||
### 概述
|
||||
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="serial_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#serial_t_serial_bytesize_from_str">serial\_bytesize\_from\_str</a> | 字符串转bytesize |
|
||||
| <a href="#serial_t_serial_close">serial\_close</a> | 关闭串口 |
|
||||
| <a href="#serial_t_serial_config">serial\_config</a> | 配置串口 |
|
||||
| <a href="#serial_t_serial_flowcontrol_from_str">serial\_flowcontrol\_from\_str</a> | 字符串转flowcontrol |
|
||||
| <a href="#serial_t_serial_handle_get_dev">serial\_handle\_get\_dev</a> | 获取设备句柄。 |
|
||||
| <a href="#serial_t_serial_handle_get_fd">serial\_handle\_get\_fd</a> | 获取文件描述符。 |
|
||||
| <a href="#serial_t_serial_iflush">serial\_iflush</a> | 刷新input缓冲区。 |
|
||||
| <a href="#serial_t_serial_oflush">serial\_oflush</a> | 刷新output缓冲区。 |
|
||||
| <a href="#serial_t_serial_open">serial\_open</a> | 打开串口 |
|
||||
| <a href="#serial_t_serial_parity_from_str">serial\_parity\_from\_str</a> | 字符串转parity |
|
||||
| <a href="#serial_t_serial_read">serial\_read</a> | 串口读数据 |
|
||||
| <a href="#serial_t_serial_stopbits_from_str">serial\_stopbits\_from\_str</a> | 字符串转stopbits |
|
||||
| <a href="#serial_t_serial_wait_for_data">serial\_wait\_for\_data</a> | 等待数据。 |
|
||||
| <a href="#serial_t_serial_write">serial\_write</a> | 串口写数据 |
|
||||
#### serial\_bytesize\_from\_str 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_bytesize_from_str">字符串转bytesize
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bytesize_t serial_bytesize_from_str (const char* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bytesize\_t | 返回bytesize。 |
|
||||
| str | const char* | 字符串。 |
|
||||
#### serial\_close 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_close">关闭串口
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t serial_close (serial_handle_t handle);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| handle | serial\_handle\_t | 串口句柄。 |
|
||||
#### serial\_config 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_config">配置串口
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t serial_config (serial_handle_t handle, uint32_t baudrate, bytesize_t bytesize, stopbits_t stopbits, flowcontrol_t flowcontrol, parity_t parity);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| handle | serial\_handle\_t | 串口句柄。 |
|
||||
| baudrate | uint32\_t | 波特率。 |
|
||||
| bytesize | bytesize\_t | 数据位。 |
|
||||
| stopbits | stopbits\_t | 停止位 |
|
||||
| flowcontrol | flowcontrol\_t | 流控。 |
|
||||
| parity | parity\_t | 校验位。 |
|
||||
#### serial\_flowcontrol\_from\_str 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_flowcontrol_from_str">字符串转flowcontrol
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
flowcontrol_t serial_flowcontrol_from_str (const char* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | flowcontrol\_t | 返回flowcontrol。 |
|
||||
| str | const char* | 字符串。 |
|
||||
#### serial\_handle\_get\_dev 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_handle_get_dev">获取设备句柄。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
serial_dev_t serial_handle_get_dev (serial_handle_t handle);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | serial\_dev\_t | 返回设备句柄。 |
|
||||
| handle | serial\_handle\_t | 串口句柄。 |
|
||||
#### serial\_handle\_get\_fd 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_handle_get_fd">获取文件描述符。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int serial_handle_get_fd (serial_handle_t handle);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回文件描述符。 |
|
||||
| handle | serial\_handle\_t | 串口句柄。 |
|
||||
#### serial\_iflush 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_iflush">刷新input缓冲区。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t serial_iflush (serial_handle_t handle);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| handle | serial\_handle\_t | 串口句柄。 |
|
||||
#### serial\_oflush 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_oflush">刷新output缓冲区。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t serial_oflush (serial_handle_t handle);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| handle | serial\_handle\_t | 串口句柄。 |
|
||||
#### serial\_open 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_open">打开串口
|
||||
> Windows下，需要在应用程序初始化时，调用 tk_socket_init。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
serial_handle_t serial_open (const char* port);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | serial\_handle\_t | 失败返回NULL。 |
|
||||
| port | const char* | 串口号。 |
|
||||
#### serial\_parity\_from\_str 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_parity_from_str">字符串转parity
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
parity_t serial_parity_from_str (const char* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | parity\_t | 返回parity。 |
|
||||
| str | const char* | 字符串。 |
|
||||
#### serial\_read 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_read">串口读数据
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t serial_read (serial_handle_t handle, uint8_t* buff, uint32_t max_size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回实际读取的字节数。 |
|
||||
| handle | serial\_handle\_t | 串口句柄。 |
|
||||
| buff | uint8\_t* | 数据缓冲区。 |
|
||||
| max\_size | uint32\_t | 数据长度。 |
|
||||
#### serial\_stopbits\_from\_str 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_stopbits_from_str">字符串转stopbits
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
stopbits_t serial_stopbits_from_str (const char* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | stopbits\_t | 返回stopbits。 |
|
||||
| str | const char* | 字符串。 |
|
||||
#### serial\_wait\_for\_data 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_wait_for_data">等待数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t serial_wait_for_data (serial_handle_t handle, uint32_t timeout_ms);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| handle | serial\_handle\_t | 串口句柄。 |
|
||||
| timeout\_ms | uint32\_t | 等待时间(ms)。 |
|
||||
#### serial\_write 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="serial_t_serial_write">串口写数据
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t serial_write (serial_handle_t handle, const uint8_t* buff, uint32_t max_size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回实际写入的字节数。 |
|
||||
| handle | serial\_handle\_t | 串口句柄。 |
|
||||
| buff | const uint8\_t* | 数据缓冲区。 |
|
||||
| max\_size | uint32\_t | 数据长度。 |
|
||||
11
docs/manual/stopbits_t.md
Normal file
11
docs/manual/stopbits_t.md
Normal file
@ -0,0 +1,11 @@
|
||||
## stopbits\_t
|
||||
### 概述
|
||||
串口停止位。
|
||||
### 常量
|
||||
<p id="stopbits_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| stopbits\_one | 1位。 |
|
||||
| stopbits\_two | 2位。 |
|
||||
| stopbits\_one\_point\_five | 1.5位。 |
|
||||
@ -37,6 +37,7 @@ str_reset(&s);
|
||||
| <a href="#str_t_str_append_json_str_pair">str\_append\_json\_str\_pair</a> | 追加字符串格式的json键值对。 |
|
||||
| <a href="#str_t_str_append_more">str\_append\_more</a> | 追加多个字符串。以NULL结束。 |
|
||||
| <a href="#str_t_str_append_n_chars">str\_append\_n\_chars</a> | 同一个字符追加n次。 |
|
||||
| <a href="#str_t_str_append_uint32">str\_append\_uint32</a> | 追加一个uint32整数。 |
|
||||
| <a href="#str_t_str_append_uint64">str\_append\_uint64</a> | 追加一个uint64整数。 |
|
||||
| <a href="#str_t_str_append_unescape">str\_append\_unescape</a> | 对字符串s进行反转义，并追加到str对象。 |
|
||||
| <a href="#str_t_str_append_with_len">str\_append\_with\_len</a> | 追加字符串。 |
|
||||
@ -55,6 +56,7 @@ str_reset(&s);
|
||||
| <a href="#str_t_str_encode_xml_entity_with_len">str\_encode\_xml\_entity\_with\_len</a> | 对XML基本的entity进行编码，目前仅支持<>"a;&。 |
|
||||
| <a href="#str_t_str_end_with">str\_end\_with</a> | 判断字符串是否以指定的子串结尾。 |
|
||||
| <a href="#str_t_str_eq">str\_eq</a> | 判断两个字符串是否相等。 |
|
||||
| <a href="#str_t_str_equal">str\_equal</a> | 判断两个字符是否相同。 |
|
||||
| <a href="#str_t_str_expand_vars">str\_expand\_vars</a> | 将字符串中的变量展开为obj中对应的属性值。 |
|
||||
| <a href="#str_t_str_extend">str\_extend</a> | 扩展字符串到指定的容量。 |
|
||||
| <a href="#str_t_str_format">str\_format</a> | 通过格式设置字符串。 |
|
||||
@ -413,6 +415,26 @@ ret_t str_append_n_chars (str_t* str, char c, uint32_t n);
|
||||
| str | str\_t* | str对象。 |
|
||||
| c | char | 要追加的字符。 |
|
||||
| n | uint32\_t | 字符的个数。 |
|
||||
#### str\_append\_uint32 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="str_t_str_append_uint32">追加一个uint32整数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t str_append_uint32 (str_t* str, uint32_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| str | str\_t* | str对象。 |
|
||||
| value | uint32\_t | 要追加的整数。 |
|
||||
#### str\_append\_uint64 函数
|
||||
-----------------------
|
||||
|
||||
@ -681,6 +703,7 @@ ret_t str_decode_xml_entity_with_len (str_t* str, const char* text, uint32_t len
|
||||
* 函数功能：
|
||||
|
||||
> <p id="str_t_str_destroy">销毁str对象
|
||||
备注：最后调用str\_destroy释放内存。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -797,6 +820,26 @@ bool_t str_eq (str_t* str, const char* text);
|
||||
| 返回值 | bool\_t | 返回是否相等。 |
|
||||
| str | str\_t* | str对象。 |
|
||||
| text | const char* | 待比较的字符串。 |
|
||||
#### str\_equal 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="str_t_str_equal">判断两个字符是否相同。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t str_equal (str_t* str, str_t* other);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回TRUE表示相同，否则表示不同。 |
|
||||
| str | str\_t* | str对象。 |
|
||||
| other | str\_t* | str对象。 |
|
||||
#### str\_expand\_vars 函数
|
||||
-----------------------
|
||||
|
||||
@ -1032,6 +1075,7 @@ ret_t str_from_wstr_with_len (str_t* str, const wchar_t* wstr, uint32_t len);
|
||||
* 函数功能：
|
||||
|
||||
> <p id="str_t_str_init">初始化字符串对象。
|
||||
备注：最后调用str\_reset释放内存。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
|
||||
@ -55,6 +55,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L4
|
||||
| <a href="#text_selector_t_text_selector_get_widget_vtable">text\_selector\_get\_widget\_vtable</a> | 获取 text_selector 虚表。 |
|
||||
| <a href="#text_selector_t_text_selector_reset_options">text\_selector\_reset\_options</a> | 重置所有选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_animating_time">text\_selector\_set\_animating\_time</a> | 设置滚动动画播放时间。 |
|
||||
| <a href="#text_selector_t_text_selector_set_ellipses">text\_selector\_set\_ellipses</a> | 是否开启缩写，开启后，当文字长度操作控件长度后，自动变为... |
|
||||
| <a href="#text_selector_t_text_selector_set_enable_value_animator">text\_selector\_set\_enable\_value\_animator</a> | 设置是否修改值时启用动画。 |
|
||||
| <a href="#text_selector_t_text_selector_set_localize_options">text\_selector\_set\_localize\_options</a> | 设置是否本地化(翻译)选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_loop_options">text\_selector\_set\_loop\_options</a> | 设置是否循环选项。 |
|
||||
@ -74,6 +75,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L4
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#text_selector_t_animating_time">animating\_time</a> | uint32\_t | 滚动动画播放时间。(单位毫秒) |
|
||||
| <a href="#text_selector_t_ellipses">ellipses</a> | bool\_t | 是否开启缩写，开启后，当文字长度操作控件长度后，自动变为... |
|
||||
| <a href="#text_selector_t_enable_value_animator">enable\_value\_animator</a> | bool\_t | 是否修改值时启用动画。 |
|
||||
| <a href="#text_selector_t_localize_options">localize\_options</a> | bool\_t | 是否本地化(翻译)选项(缺省为FALSE)。 |
|
||||
| <a href="#text_selector_t_loop_options">loop\_options</a> | bool\_t | 是否循环选项(缺省为FALSE)。 |
|
||||
@ -287,6 +289,26 @@ ret_t text_selector_set_animating_time (widget_t* widget, uint32_t animating_tim
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| animating\_time | uint32\_t | 滚动动画播放时间。(单位毫秒) |
|
||||
#### text\_selector\_set\_ellipses 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="text_selector_t_text_selector_set_ellipses">是否开启缩写，开启后，当文字长度操作控件长度后，自动变为...
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t text_selector_set_ellipses (widget_t* widget, bool_t ellipses);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| ellipses | bool\_t | 是否开启缩写。 |
|
||||
#### text\_selector\_set\_enable\_value\_animator 函数
|
||||
-----------------------
|
||||
|
||||
@ -558,6 +580,22 @@ ret_t text_selector_set_yspeed_scale (widget_t* widget, float_t yspeed_scale);
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### ellipses 属性
|
||||
-----------------------
|
||||
> <p id="text_selector_t_ellipses">是否开启缩写，开启后，当文字长度操作控件长度后，自动变为...
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -10,6 +10,7 @@
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#tk_iostream_tcp_t_tk_iostream_tcp_create">tk\_iostream\_tcp\_create</a> | 创建iostream对象。 |
|
||||
| <a href="#tk_iostream_tcp_t_tk_iostream_tcp_create_client">tk\_iostream\_tcp\_create\_client</a> | 创建iostream对象(客户端)。 |
|
||||
#### tk\_iostream\_tcp\_create 函数
|
||||
-----------------------
|
||||
|
||||
@ -29,3 +30,23 @@ tk_iostream_t* tk_iostream_tcp_create (int sock);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | tk\_iostream\_t* | 返回iostream对象。 |
|
||||
| sock | int | socket。 |
|
||||
#### tk\_iostream\_tcp\_create\_client 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_iostream_tcp_t_tk_iostream_tcp_create_client">创建iostream对象(客户端)。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
tk_iostream_t* tk_iostream_tcp_create_client (const char* host, int port);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | tk\_iostream\_t* | 返回iostream对象。 |
|
||||
| host | const char* | 服务器地址。 |
|
||||
| port | int | 服务器端口。 |
|
||||
|
||||
@ -10,11 +10,13 @@
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#tk_ostream_t_tk_ostream_flush">tk\_ostream\_flush</a> | 刷新数据。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_printf">tk\_ostream\_printf</a> | 写入格式化字符串。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_seek">tk\_ostream\_seek</a> | 设置偏移量。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_tell">tk\_ostream\_tell</a> | 获取当前读取位置。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_write">tk\_ostream\_write</a> | 写入数据。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_write_byte">tk\_ostream\_write\_byte</a> | 写入一个字节的数据。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_write_len">tk\_ostream\_write\_len</a> | 写入指定长度的数据。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_write_str">tk\_ostream\_write\_str</a> | 写入字符串。 |
|
||||
#### tk\_ostream\_flush 函数
|
||||
-----------------------
|
||||
|
||||
@ -34,6 +36,27 @@ ret_t tk_ostream_flush (tk_ostream_t* stream);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| stream | tk\_ostream\_t* | ostream对象。 |
|
||||
#### tk\_ostream\_printf 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_ostream_t_tk_ostream_printf">写入格式化字符串。
|
||||
> 长度不超过1024。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_ostream_printf (tk_ostream_t* stream, const char* format);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| stream | tk\_ostream\_t* | ostream对象。 |
|
||||
| format | const char* | 格式化字符串。 |
|
||||
#### tk\_ostream\_seek 函数
|
||||
-----------------------
|
||||
|
||||
@ -136,3 +159,23 @@ int32_t tk_ostream_write_len (tk_ostream_t* stream, const void* buff, uint32_t m
|
||||
| buff | const void* | 数据的缓冲区。 |
|
||||
| max\_size | uint32\_t | 缓冲区的大小。 |
|
||||
| timeout\_ms | uint32\_t | timeout. |
|
||||
#### tk\_ostream\_write\_str 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_ostream_t_tk_ostream_write_str">写入字符串。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_ostream_write_str (tk_ostream_t* stream, const char* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| stream | tk\_ostream\_t* | ostream对象。 |
|
||||
| str | const char* | 字符串。 |
|
||||
|
||||
373
docs/manual/tk_socket_t.md
Normal file
373
docs/manual/tk_socket_t.md
Normal file
@ -0,0 +1,373 @@
|
||||
## tk\_socket\_t
|
||||
### 概述
|
||||
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="tk_socket_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#tk_socket_t_tk_socket_bind">tk\_socket\_bind</a> | 绑定到指定端口。 |
|
||||
| <a href="#tk_socket_t_tk_socket_bind_ex">tk\_socket\_bind\_ex</a> | 绑定到指定IP和端口。 |
|
||||
| <a href="#tk_socket_t_tk_socket_close">tk\_socket\_close</a> | 关闭socket句柄。 |
|
||||
| <a href="#tk_socket_t_tk_socket_deinit">tk\_socket\_deinit</a> | tcp/udp 平台~初始化。 |
|
||||
| <a href="#tk_socket_t_tk_socket_get_client_ip">tk\_socket\_get\_client\_ip</a> | 获取客户端IP。 |
|
||||
| <a href="#tk_socket_t_tk_socket_get_client_ip_str">tk\_socket\_get\_client\_ip\_str</a> | 获取客户端IP。 |
|
||||
| <a href="#tk_socket_t_tk_socket_get_self_ip">tk\_socket\_get\_self\_ip</a> | 获取本地IP。 |
|
||||
| <a href="#tk_socket_t_tk_socket_get_self_ip_str">tk\_socket\_get\_self\_ip\_str</a> | 获取本地IP。 |
|
||||
| <a href="#tk_socket_t_tk_socket_init">tk\_socket\_init</a> | tcp/udp 平台初始化。 |
|
||||
| <a href="#tk_socket_t_tk_socket_last_io_has_error">tk\_socket\_last\_io\_has\_error</a> | 判断最后一次IO操作是否正常。 |
|
||||
| <a href="#tk_socket_t_tk_socket_recv">tk\_socket\_recv</a> | 接收数据。 |
|
||||
| <a href="#tk_socket_t_tk_socket_recvfrom">tk\_socket\_recvfrom</a> | 从指定地址接收数据。 |
|
||||
| <a href="#tk_socket_t_tk_socket_resolve">tk\_socket\_resolve</a> | 解析主机名，并初始化addr对象。 |
|
||||
| <a href="#tk_socket_t_tk_socket_send">tk\_socket\_send</a> | 发送数据。 |
|
||||
| <a href="#tk_socket_t_tk_socket_sendto">tk\_socket\_sendto</a> | 发送数据到指定地址。 |
|
||||
| <a href="#tk_socket_t_tk_socket_set_blocking">tk\_socket\_set\_blocking</a> | 设置为阻塞或非阻塞模式。 |
|
||||
| <a href="#tk_socket_t_tk_socket_wait_for_data">tk\_socket\_wait\_for\_data</a> | 等待数据。 |
|
||||
#### tk\_socket\_bind 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_bind">绑定到指定端口。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_socket_bind (int sock, int port);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| sock | int | socket句柄。 |
|
||||
| port | int | 端口号。 |
|
||||
#### tk\_socket\_bind\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_bind_ex">绑定到指定IP和端口。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_socket_bind_ex (int sock, const char* ip, int port);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| sock | int | socket句柄。 |
|
||||
| ip | const char* | IP地址(可以为NULL)。 |
|
||||
| port | int | 端口号。 |
|
||||
#### tk\_socket\_close 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_close">关闭socket句柄。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_socket_close (int sock);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| sock | int | socket句柄。 |
|
||||
#### tk\_socket\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_deinit">tcp/udp 平台~初始化。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_socket_deinit ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### tk\_socket\_get\_client\_ip 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_get_client_ip">获取客户端IP。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t tk_socket_get_client_ip (int sockfd);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回客户端IP。 |
|
||||
| sockfd | int | socket句柄。 |
|
||||
#### tk\_socket\_get\_client\_ip\_str 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_get_client_ip_str">获取客户端IP。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* tk_socket_get_client_ip_str (int sockfd, char* ip, int len);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回IP地址。 |
|
||||
| sockfd | int | socket句柄。 |
|
||||
| ip | char* | 存放IP地址的内存。 |
|
||||
| len | int | 存放IP地址的内存的长度。 |
|
||||
#### tk\_socket\_get\_self\_ip 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_get_self_ip">获取本地IP。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t tk_socket_get_self_ip (int sockfd);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回本地IP。 |
|
||||
| sockfd | int | socket句柄。 |
|
||||
#### tk\_socket\_get\_self\_ip\_str 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_get_self_ip_str">获取本地IP。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* tk_socket_get_self_ip_str (int sockfd, char* ip, int len);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回IP地址。 |
|
||||
| sockfd | int | socket句柄。 |
|
||||
| ip | char* | 存放IP地址的内存。 |
|
||||
| len | int | 存放IP地址的内存的长度。 |
|
||||
#### tk\_socket\_init 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_init">tcp/udp 平台初始化。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_socket_init ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### tk\_socket\_last\_io\_has\_error 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_last_io_has_error">判断最后一次IO操作是否正常。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t tk_socket_last_io_has_error ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回TRUE表示有错误，否则表示正常。 |
|
||||
#### tk\_socket\_recv 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_recv">接收数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t tk_socket_recv (int sock, void* buffer, uint32_t size, int flags);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回实际接收的字节数。 |
|
||||
| sock | int | socket句柄。 |
|
||||
| buffer | void* | 用于返回数据的缓冲区。 |
|
||||
| size | uint32\_t | 缓冲区大小。 |
|
||||
| flags | int | 标志。 |
|
||||
#### tk\_socket\_recvfrom 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_recvfrom">从指定地址接收数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t tk_socket_recvfrom (int sock, void* buffer, uint32_t size, int flags, struct sockaddr* dest_addr, uint32_t* dest_len);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回实际接收的字节数。 |
|
||||
| sock | int | socket句柄。 |
|
||||
| buffer | void* | 用于返回数据的缓冲区。 |
|
||||
| size | uint32\_t | 缓冲区大小。 |
|
||||
| flags | int | 标志。 |
|
||||
| dest\_addr | struct sockaddr* | 目标地址。 |
|
||||
| dest\_len | uint32\_t* | 目标地址长度。 |
|
||||
#### tk\_socket\_resolve 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_resolve">解析主机名，并初始化addr对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
struct sockaddr* tk_socket_resolve (const char* host, int port, struct sockaddr_in* addr);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | struct sockaddr* | 返回地址对象。 |
|
||||
| host | const char* | 主机名。 |
|
||||
| port | int | 端口号。 |
|
||||
| addr | struct sockaddr\_in* | 地址对象。 |
|
||||
#### tk\_socket\_send 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_send">发送数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t tk_socket_send (int sock, const void* buffer, uint32_t size, int flags);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回实际发送的字节数。 |
|
||||
| sock | int | socket句柄。 |
|
||||
| buffer | const void* | 数据缓冲区。 |
|
||||
| size | uint32\_t | 数据长度。 |
|
||||
| flags | int | 标志。 |
|
||||
#### tk\_socket\_sendto 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_sendto">发送数据到指定地址。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t tk_socket_sendto (int sock, const void* buffer, uint32_t size, int flags, const struct sockaddr* dest_addr, uint32_t dest_len);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回实际发送的字节数。 |
|
||||
| sock | int | socket句柄。 |
|
||||
| buffer | const void* | 数据缓冲区。 |
|
||||
| size | uint32\_t | 数据长度。 |
|
||||
| flags | int | 标志。 |
|
||||
| dest\_addr | const struct sockaddr* | 目标地址。 |
|
||||
| dest\_len | uint32\_t | 目标地址长度。 |
|
||||
#### tk\_socket\_set\_blocking 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_set_blocking">设置为阻塞或非阻塞模式。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_socket_set_blocking (int sock, bool_t blocking);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| sock | int | socket句柄。 |
|
||||
| blocking | bool\_t | 是否阻塞。 |
|
||||
#### tk\_socket\_wait\_for\_data 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_socket_t_tk_socket_wait_for_data">等待数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_socket_wait_for_data (int sock, uint32_t timeout_ms);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| sock | int | socket句柄。 |
|
||||
| timeout\_ms | uint32\_t | 等待时间(ms)。 |
|
||||
@ -567,7 +567,7 @@ ret_t ubjson_writer_write_kv_str_len (ubjson_writer_t* writer, const char* key,
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t ubjson_writer_write_kv_value (ubjson_writer_t* writer, const char* key, value_t* value);
|
||||
ret_t ubjson_writer_write_kv_value (ubjson_writer_t* writer, const char* key, const value_t* value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -577,7 +577,7 @@ ret_t ubjson_writer_write_kv_value (ubjson_writer_t* writer, const char* key, va
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| writer | ubjson\_writer\_t* | writer对象。 |
|
||||
| key | const char* | 键名。 |
|
||||
| value | value\_t* | 值。 |
|
||||
| value | const value\_t* | 值。 |
|
||||
#### ubjson\_writer\_write\_kv\_wstr 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -9,6 +9,7 @@
|
||||
| -------- | ------------ |
|
||||
| <a href="#udp_t_tk_udp_connect">tk\_udp\_connect</a> | 连接到指定服务器。 |
|
||||
| <a href="#udp_t_tk_udp_listen">tk\_udp\_listen</a> | 监听指定端口，成功返回sock句柄。 |
|
||||
| <a href="#udp_t_tk_udp_socket">tk\_udp\_socket</a> | 创建UDP socket。 |
|
||||
#### tk\_udp\_connect 函数
|
||||
-----------------------
|
||||
|
||||
@ -48,3 +49,21 @@ int tk_udp_listen (int port);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回sock句柄。 |
|
||||
| port | int | 端口号。 |
|
||||
#### tk\_udp\_socket 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="udp_t_tk_udp_socket">创建UDP socket。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int tk_udp_socket ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回sock句柄。 |
|
||||
|
||||
@ -7,6 +7,8 @@
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#utils_t_bits_stream_get">bits\_stream\_get</a> | 从buff中获取第index位的值。 |
|
||||
| <a href="#utils_t_bits_stream_set">bits\_stream\_set</a> | 设置buff中第index位的值。 |
|
||||
| <a href="#utils_t_compare_always_equal">compare\_always\_equal</a> | 始终返回相等。 |
|
||||
| <a href="#utils_t_data_url_copy">data\_url\_copy</a> | 将数据从源URL拷贝到目标URL。 |
|
||||
| <a href="#utils_t_default_destroy">default\_destroy</a> | 缺省的destroy函数。释放data指向的内存。 |
|
||||
@ -25,6 +27,7 @@
|
||||
| <a href="#utils_t_tk_atol">tk\_atol</a> | 将字符串转换为整型。 |
|
||||
| <a href="#utils_t_tk_atoul">tk\_atoul</a> | 将字符串转换为整型。 |
|
||||
| <a href="#utils_t_tk_eval_ratio_or_px">tk\_eval\_ratio\_or\_px</a> | 如果expr以px/PX结束，直接返回expr前面的数值。 |
|
||||
| <a href="#utils_t_tk_free_utf8_argv">tk\_free\_utf8\_argv</a> | 释放utf8字符串数组。 |
|
||||
| <a href="#utils_t_tk_ftoa">tk\_ftoa</a> | 将浮点型转换为字符串。 |
|
||||
| <a href="#utils_t_tk_is_ui_thread">tk\_is\_ui\_thread</a> | 判断当前线程是否是UI线程。 |
|
||||
| <a href="#utils_t_tk_is_valid_name">tk\_is\_valid\_name</a> | 判断是否是有效的属性名。 |
|
||||
@ -48,6 +51,7 @@
|
||||
| <a href="#utils_t_tk_skip_to_num">tk\_skip\_to\_num</a> | 跳过字符串函数，如：字符串"hello123world"，返回的结果是"123world"。 |
|
||||
| <a href="#utils_t_tk_snprintf">tk\_snprintf</a> | 将可变参数(...)按照format格式化字符串，并将字符串复制到str中。 |
|
||||
| <a href="#utils_t_tk_sscanf">tk\_sscanf</a> | 从字符串读取格式化输入。 |
|
||||
| <a href="#utils_t_tk_sscanf_simple">tk\_sscanf\_simple</a> | 从字符串读取格式化输入。 |
|
||||
| <a href="#utils_t_tk_str_append">tk\_str\_append</a> | 字符串追加函数。 |
|
||||
| <a href="#utils_t_tk_str_copy">tk\_str\_copy</a> | 字符串拷贝函数。 |
|
||||
| <a href="#utils_t_tk_str_end_with">tk\_str\_end\_with</a> | 检查字符串是否以指定的字符串appendix结尾。 |
|
||||
@ -69,7 +73,9 @@
|
||||
| <a href="#utils_t_tk_strtoi">tk\_strtoi</a> | 将字符串转换为整型。 |
|
||||
| <a href="#utils_t_tk_strtol">tk\_strtol</a> | 将字符串转换为长整型。 |
|
||||
| <a href="#utils_t_tk_strtoll">tk\_strtoll</a> | 将字符串转换为长整型。 |
|
||||
| <a href="#utils_t_tk_to_utf8_argv">tk\_to\_utf8\_argv</a> | 将宽字符串数组转换成utf8字符串数组。 |
|
||||
| <a href="#utils_t_tk_under_score_to_camel">tk\_under\_score\_to\_camel</a> | 将下划线名字转成驼峰名字。 |
|
||||
| <a href="#utils_t_tk_utf8_dup_wstr">tk\_utf8\_dup\_wstr</a> | 将UCS字符串拷贝为utf8字符串。 |
|
||||
| <a href="#utils_t_tk_vsnprintf">tk\_vsnprintf</a> | 将可变参数ap按照format格式化字符串，并将字符串复制到str中。 |
|
||||
| <a href="#utils_t_tk_watob">tk\_watob</a> | 将宽字符串转换为布尔类型。 |
|
||||
| <a href="#utils_t_tk_watof">tk\_watof</a> | 将宽字符串转换为浮点类型。 |
|
||||
@ -82,6 +88,50 @@
|
||||
| <a href="#utils_t_tk_wstrdup">tk\_wstrdup</a> | 宽字符串拷贝函数。 |
|
||||
| <a href="#utils_t_tk_wstricmp">tk\_wstricmp</a> | 字符串比较函数（不区分大小写）。 |
|
||||
| <a href="#utils_t_xml_file_expand_read">xml\_file\_expand\_read</a> | expand include process instruction to file content: <?include filename="view_me.inc" ?> |
|
||||
#### bits\_stream\_get 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_bits_stream_get">从buff中获取第index位的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t bits_stream_get (const uint8_t* buff, uint32_t size, uint32_t index, bool_t* value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| buff | const uint8\_t* | 数据。 |
|
||||
| size | uint32\_t | 数据长度。 |
|
||||
| index | uint32\_t | 位索引。 |
|
||||
| value | bool\_t* | 返回值。 |
|
||||
#### bits\_stream\_set 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_bits_stream_set">设置buff中第index位的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t bits_stream_set (uint8_t* buff, uint32_t size, uint32_t index, bool_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| buff | uint8\_t* | 数据。 |
|
||||
| size | uint32\_t | 数据长度。 |
|
||||
| index | uint32\_t | 位索引。 |
|
||||
| value | bool\_t | 值。 |
|
||||
#### compare\_always\_equal 函数
|
||||
-----------------------
|
||||
|
||||
@ -449,6 +499,26 @@ float_t tk_eval_ratio_or_px (const char* expr, int32_t value);
|
||||
| 返回值 | float\_t | 返回计算结果。 |
|
||||
| expr | const char* | 表达式(如100px, 0.5等) |
|
||||
| value | int32\_t | 值。 |
|
||||
#### tk\_free\_utf8\_argv 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_free_utf8_argv">释放utf8字符串数组。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_free_utf8_argv (int argc, char** argv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| argc | int | 参数个数。 |
|
||||
| argv | char** | 参数。 |
|
||||
#### tk\_ftoa 函数
|
||||
-----------------------
|
||||
|
||||
@ -917,6 +987,27 @@ int tk_sscanf (const char* str, const char* format);
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回成功匹配和赋值的个数。 |
|
||||
| str | const char* | 要输入的字符串。 |
|
||||
| format | const char* | 格式化字符串。 |
|
||||
#### tk\_sscanf\_simple 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_sscanf_simple">从字符串读取格式化输入。
|
||||
>TKC自己实现的，只支持几种简单的格式，在没有sscanf函数时使用。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int tk_sscanf_simple (const char* str, const char* format);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回成功匹配和赋值的个数。 |
|
||||
@ -1353,6 +1444,26 @@ int64_t tk_strtoll (const char* str, const char** end, int base);
|
||||
| str | const char* | 要转换为长整型的字符串。 |
|
||||
| end | const char** | 对类型char*的对象的引用。 |
|
||||
| base | int | 基数。 |
|
||||
#### tk\_to\_utf8\_argv 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_to_utf8_argv">将宽字符串数组转换成utf8字符串数组。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
char** tk_to_utf8_argv (int argc, wchar_t** argv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | char** | 返回utf8字符串数组。 |
|
||||
| argc | int | 参数个数。 |
|
||||
| argv | wchar\_t** | 参数。 |
|
||||
#### tk\_under\_score\_to\_camel 函数
|
||||
-----------------------
|
||||
|
||||
@ -1374,6 +1485,25 @@ const char* tk_under_score_to_camel (const char* name, char* out, uint32_t max_o
|
||||
| name | const char* | 下划线名字。 |
|
||||
| out | char* | 驼峰名字(保存结果)。 |
|
||||
| max\_out\_size | uint32\_t | 结果最大长度。 |
|
||||
#### tk\_utf8\_dup\_wstr 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_utf8_dup_wstr">将UCS字符串拷贝为utf8字符串。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
char* tk_utf8_dup_wstr (const wchar_t* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | char* | 返回UTF-8字符串(需要调用TKMEM\_FREE释放)。 |
|
||||
| str | const wchar\_t* | 字符串。 |
|
||||
#### tk\_vsnprintf 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
83
docs/manual/widget_animator_event_t.md
Normal file
83
docs/manual/widget_animator_event_t.md
Normal file
@ -0,0 +1,83 @@
|
||||
## widget\_animator\_event\_t
|
||||
### 概述
|
||||
|
||||
|
||||
控件动画事件。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="widget_animator_event_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#widget_animator_event_t_widget_animator_event_cast">widget\_animator\_event\_cast</a> | 把event对象转widget_animator_event_t对象。 |
|
||||
| <a href="#widget_animator_event_t_widget_animator_event_init">widget\_animator\_event\_init</a> | 初始化事件。 |
|
||||
### 属性
|
||||
<p id="widget_animator_event_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#widget_animator_event_t_animator">animator</a> | void* | 控件动画句柄。 |
|
||||
| <a href="#widget_animator_event_t_widget">widget</a> | widget\_t* | 控件对象。 |
|
||||
#### widget\_animator\_event\_cast 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_animator_event_t_widget_animator_event_cast">把event对象转widget_animator_event_t对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
widget_animator_event_t* widget_animator_event_cast (event_t* event);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_animator\_event\_t* | event对象。 |
|
||||
| event | event\_t* | event对象。 |
|
||||
#### widget\_animator\_event\_init 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_animator_event_t_widget_animator_event_init">初始化事件。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
event_t* widget_animator_event_init (widget_animator_event_t* event, uint32_t type, widget_t* widget, void* animator);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | event\_t* | event对象。 |
|
||||
| event | widget\_animator\_event\_t* | event对象。 |
|
||||
| type | uint32\_t | 类型。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| animator | void* | 控件动画句柄。 |
|
||||
#### animator 属性
|
||||
-----------------------
|
||||
> <p id="widget_animator_event_t_animator">控件动画句柄。
|
||||
|
||||
* 类型：void*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
#### widget 属性
|
||||
-----------------------
|
||||
> <p id="widget_animator_event_t_widget">控件对象。
|
||||
|
||||
* 类型：widget\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
@ -14,6 +14,7 @@
|
||||
| <a href="#widget_animator_t_widget_animator_pause">widget\_animator\_pause</a> | 暂停动画。 |
|
||||
| <a href="#widget_animator_t_widget_animator_set_destroy_when_done">widget\_animator\_set\_destroy\_when\_done</a> | 设置完成时是否自动销毁动画对象(缺省销毁)。 |
|
||||
| <a href="#widget_animator_t_widget_animator_set_name">widget\_animator\_set\_name</a> | 设置名称。 |
|
||||
| <a href="#widget_animator_t_widget_animator_set_relayout">widget\_animator\_set\_relayout</a> | 设置每帧是否重新布局。 |
|
||||
| <a href="#widget_animator_t_widget_animator_set_repeat">widget\_animator\_set\_repeat</a> | 设置为重复模式。 |
|
||||
| <a href="#widget_animator_t_widget_animator_set_reversed">widget\_animator\_set\_reversed</a> | 设置为逆向模式。 |
|
||||
| <a href="#widget_animator_t_widget_animator_set_time_scale">widget\_animator\_set\_time\_scale</a> | 设置时间倍率，用于实现时间加速减速和停滞的功能。 |
|
||||
@ -169,6 +170,26 @@ ret_t widget_animator_set_name (widget_animator_t* animator, const char* name);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| animator | widget\_animator\_t* | 动画对象。 |
|
||||
| name | const char* | 名称。 |
|
||||
#### widget\_animator\_set\_relayout 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_animator_t_widget_animator_set_relayout">设置每帧是否重新布局。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t widget_animator_set_relayout (widget_animator_t* animator, bool_t relayout);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| animator | widget\_animator\_t* | 动画对象。 |
|
||||
| relayout | bool\_t | 是否重新布局。 |
|
||||
#### widget\_animator\_set\_repeat 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -55,6 +55,7 @@
|
||||
| WIDGET\_PROP\_LENGTH | 长度。 |
|
||||
| WIDGET\_PROP\_LINE\_WRAP | 自动换行。 |
|
||||
| WIDGET\_PROP\_WORD\_WRAP | 是否允许单词中换行。 |
|
||||
| WIDGET\_PROP\_ELLIPSES | 是否省略。 |
|
||||
| WIDGET\_PROP\_TEXT | 文本。 |
|
||||
| WIDGET\_PROP\_TR\_TEXT | 待翻译文本。 |
|
||||
| WIDGET\_PROP\_STYLE | style。 |
|
||||
|
||||
@ -136,6 +136,7 @@ widget_on(button, EVT_CLICK, on_click, NULL);
|
||||
| <a href="#widget_t_widget_get_window_theme">widget\_get\_window\_theme</a> | 获取控件的窗体样式。 |
|
||||
| <a href="#widget_t_widget_get_with_focus_state">widget\_get\_with\_focus\_state</a> | 获取控件with_focus_state属性值。 |
|
||||
| <a href="#widget_t_widget_grab">widget\_grab</a> | 让指定子控件抓住事件。 |
|
||||
| <a href="#widget_t_widget_has_highlighter">widget\_has\_highlighter</a> | 判断widget拥有高亮属性。 |
|
||||
| <a href="#widget_t_widget_index_of">widget\_index\_of</a> | 获取控件在父控件中的索引编号。 |
|
||||
| <a href="#widget_t_widget_init">widget\_init</a> | 初始化控件。仅在子类控件构造函数中使用。 |
|
||||
| <a href="#widget_t_widget_insert_child">widget\_insert\_child</a> | 插入子控件到指定的位置。 |
|
||||
@ -2149,6 +2150,25 @@ ret_t widget_grab (widget_t* widget, widget_t* child);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| child | widget\_t* | 子控件对象。 |
|
||||
#### widget\_has\_highlighter 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_has_highlighter">判断widget拥有高亮属性。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t widget_has_highlighter (widget_t* widget);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 拥有返回 TRUE，没有返回 FALSE。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
#### widget\_index\_of 函数
|
||||
-----------------------
|
||||
|
||||
@ -3723,6 +3743,7 @@ ret_t widget_set_child_text_with_int (widget_t* widget, const char* name, const
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_set_children_layout">设置子控件的布局参数。
|
||||
备注：下一帧才会生效数据
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -4171,6 +4192,7 @@ ret_t widget_set_props (widget_t* widget, const char* params);
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_set_self_layout">设置控件自己的布局参数。
|
||||
备注：下一帧才会生效数据
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -4191,6 +4213,7 @@ ret_t widget_set_self_layout (widget_t* widget, const char* params);
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_set_self_layout_params">设置控件自己的布局(缺省布局器)参数(过时，请用widget\_set\_self\_layout)。
|
||||
备注：下一帧才会生效数据
|
||||
|
||||
* 函数原型：
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
| <a href="#window_manager_t_window_manager_begin_wait_pointer_cursor">window\_manager\_begin\_wait\_pointer\_cursor</a> | 开始等待鼠标指针。 |
|
||||
| <a href="#window_manager_t_window_manager_cast">window\_manager\_cast</a> | 转换为window_manager对象(供脚本语言使用)。 |
|
||||
| <a href="#window_manager_t_window_manager_close_all">window\_manager\_close\_all</a> | 关闭全部窗口。 |
|
||||
| <a href="#window_manager_t_window_manager_close_window_force">window\_manager\_close\_window\_force</a> | 强制立即关闭窗口。 |
|
||||
| <a href="#window_manager_t_window_manager_close_window_force">window\_manager\_close\_window\_force</a> | 强制立即关闭窗口(内部使用函数，关闭窗口请使用 window_manager_close_window)。 |
|
||||
| <a href="#window_manager_t_window_manager_destroy">window\_manager\_destroy</a> | 销毁window_manager。 |
|
||||
| <a href="#window_manager_t_window_manager_dispatch_input_event">window\_manager\_dispatch\_input\_event</a> | 分发输入事件。 |
|
||||
| <a href="#window_manager_t_window_manager_dispatch_native_window_event">window\_manager\_dispatch\_native\_window\_event</a> | 处理native window事件。 |
|
||||
@ -199,7 +199,7 @@ ret_t window_manager_close_all (widget_t* widget);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="window_manager_t_window_manager_close_window_force">强制立即关闭窗口。
|
||||
> <p id="window_manager_t_window_manager_close_window_force">强制立即关闭窗口(内部使用函数，关闭窗口请使用 window_manager_close_window)。
|
||||
|
||||
> 本函数不会执行窗口动画。
|
||||
|
||||
|
||||
@ -23,10 +23,14 @@ wstr_reset(&s);
|
||||
| <a href="#wstr_t_wstr_add_float">wstr\_add\_float</a> | 将字符串转成浮点数，加上delta，再转换回来。 |
|
||||
| <a href="#wstr_t_wstr_append">wstr\_append</a> | 追加字符串。 |
|
||||
| <a href="#wstr_t_wstr_append_int">wstr\_append\_int</a> | 追加整数到字符串。 |
|
||||
| <a href="#wstr_t_wstr_append_more">wstr\_append\_more</a> | 追加多个字符串。以NULL结束。 |
|
||||
| <a href="#wstr_t_wstr_append_with_len">wstr\_append\_with\_len</a> | 追加字符串。 |
|
||||
| <a href="#wstr_t_wstr_attach">wstr\_attach</a> | 通过附加到一个buff来初始化str。 |
|
||||
| <a href="#wstr_t_wstr_clear">wstr\_clear</a> | 清除字符串内容。 |
|
||||
| <a href="#wstr_t_wstr_count_char">wstr\_count\_char</a> | 统计指定字符的个数。 |
|
||||
| <a href="#wstr_t_wstr_create">wstr\_create</a> | 创建str对象。 |
|
||||
| <a href="#wstr_t_wstr_destroy">wstr\_destroy</a> | 销毁str对象。 |
|
||||
| <a href="#wstr_t_wstr_eq">wstr\_eq</a> | 判断两个字符串是否相等。 |
|
||||
| <a href="#wstr_t_wstr_equal">wstr\_equal</a> | 判断两个字符是否相同。 |
|
||||
| <a href="#wstr_t_wstr_from_float">wstr\_from\_float</a> | 用浮点数初始化字符串。 |
|
||||
| <a href="#wstr_t_wstr_from_int">wstr\_from\_int</a> | 用整数初始化字符串。 |
|
||||
@ -117,6 +121,38 @@ ret_t wstr_append_int (wstr_t* str, int32_t v);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| str | wstr\_t* | str对象。 |
|
||||
| v | int32\_t | 整数。 |
|
||||
#### wstr\_append\_more 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wstr_t_wstr_append_more">追加多个字符串。以NULL结束。
|
||||
|
||||
示例：
|
||||
|
||||
```c
|
||||
wstr_t s;
|
||||
wstr_init(&s, 0);
|
||||
|
||||
wstr_append_more(&s, L"abc", L"123", NULL);
|
||||
log_debug("%s\n", s.str);
|
||||
|
||||
wstr_reset(&s);
|
||||
```
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t wstr_append_more (wstr_t* str, const wchar_t* text);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| str | wstr\_t* | str对象。 |
|
||||
| text | const wchar\_t* | 要追加的字符串。 |
|
||||
#### wstr\_append\_with\_len 函数
|
||||
-----------------------
|
||||
|
||||
@ -207,6 +243,65 @@ uint32_t wstr_count_char (wstr_t* str, wchar_t c);
|
||||
| 返回值 | uint32\_t | 返回指定字符的个数。 |
|
||||
| str | wstr\_t* | str对象。 |
|
||||
| c | wchar\_t | 字符。 |
|
||||
#### wstr\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wstr_t_wstr_create">创建str对象。
|
||||
备注：最后调用wstr\_destroy释放内存
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
wstr_t* wstr_create (uint32_t capacity);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | wstr\_t* | str对象。 |
|
||||
| capacity | uint32\_t | 初始容量。 |
|
||||
#### wstr\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wstr_t_wstr_destroy">销毁str对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t wstr_destroy (wstr_t* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| str | wstr\_t* | str对象。 |
|
||||
#### wstr\_eq 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wstr_t_wstr_eq">判断两个字符串是否相等。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t wstr_eq (wstr_t* str, const wchar_t* text);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回是否相等。 |
|
||||
| str | wstr\_t* | str对象。 |
|
||||
| text | const wchar\_t* | 待比较的字符串。 |
|
||||
#### wstr\_equal 函数
|
||||
-----------------------
|
||||
|
||||
@ -334,6 +429,7 @@ ret_t wstr_get_utf8 (wstr_t* str, char* text, uint32_t size);
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wstr_t_wstr_init">初始化字符串对象。
|
||||
备注：最后调用wstr\_reset释放内存
|
||||
|
||||
* 函数原型：
|
||||
|
||||
|
||||
@ -170,11 +170,16 @@ typedef enum {
|
||||
flowcontrol_hardware
|
||||
} flowcontrol_t;
|
||||
|
||||
/**
|
||||
* @class serial_t
|
||||
* @annotation ["fake"]
|
||||
*/
|
||||
|
||||
/**
|
||||
* @method serial_open
|
||||
* 打开串口
|
||||
* > Windows下，需要在应用程序初始化时，调用 tk_socket_init。
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {const char*} port 串口号。
|
||||
*
|
||||
* @return {serial_handle_t} 失败返回NULL。
|
||||
@ -184,7 +189,7 @@ serial_handle_t serial_open(const char* port);
|
||||
/**
|
||||
* @method serial_read
|
||||
* 串口读数据
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {serial_handle_t} handle 串口句柄。
|
||||
* @param {uint8_t*} buff 数据缓冲区。
|
||||
* @param {uint32_t} max_size 数据长度。
|
||||
@ -196,7 +201,7 @@ int32_t serial_read(serial_handle_t handle, uint8_t* buff, uint32_t max_size);
|
||||
/**
|
||||
* @method serial_write
|
||||
* 串口写数据
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {serial_handle_t} handle 串口句柄。
|
||||
* @param {const uint8_t*} buff 数据缓冲区。
|
||||
* @param {uint32_t} max_size 数据长度。
|
||||
@ -208,7 +213,7 @@ int32_t serial_write(serial_handle_t handle, const uint8_t* buff, uint32_t max_s
|
||||
/**
|
||||
* @method serial_close
|
||||
* 关闭串口
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {serial_handle_t} handle 串口句柄。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功，否则表示失败。
|
||||
@ -218,7 +223,7 @@ ret_t serial_close(serial_handle_t handle);
|
||||
/**
|
||||
* @method serial_config
|
||||
* 配置串口
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {serial_handle_t} handle 串口句柄。
|
||||
* @param {uint32_t} baudrate 波特率。
|
||||
* @param {bytesize_t} bytesize 数据位。
|
||||
@ -234,7 +239,7 @@ ret_t serial_config(serial_handle_t handle, uint32_t baudrate, bytesize_t bytesi
|
||||
/**
|
||||
* @method serial_handle_get_fd
|
||||
* 获取文件描述符。
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {serial_handle_t} handle 串口句柄。
|
||||
*
|
||||
* @return {int} 返回文件描述符。
|
||||
@ -244,7 +249,7 @@ int serial_handle_get_fd(serial_handle_t handle);
|
||||
/**
|
||||
* @method serial_handle_get_dev
|
||||
* 获取设备句柄。
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {serial_handle_t} handle 串口句柄。
|
||||
*
|
||||
* @return {serial_dev_t} 返回设备句柄。
|
||||
@ -254,7 +259,7 @@ serial_dev_t serial_handle_get_dev(serial_handle_t handle);
|
||||
/**
|
||||
* @method serial_iflush
|
||||
* 刷新input缓冲区。
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {serial_handle_t} handle 串口句柄。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功，否则表示失败。
|
||||
@ -264,7 +269,7 @@ ret_t serial_iflush(serial_handle_t handle);
|
||||
/**
|
||||
* @method serial_oflush
|
||||
* 刷新output缓冲区。
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {serial_handle_t} handle 串口句柄。
|
||||
*
|
||||
* @return {ret_t} 返回RET_OK表示成功，否则表示失败。
|
||||
@ -285,7 +290,7 @@ ret_t serial_wait_for_data(serial_handle_t handle, uint32_t timeout_ms);
|
||||
/**
|
||||
* @method serial_stopbits_from_str
|
||||
* 字符串转stopbits
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {const char*} str 字符串。
|
||||
*
|
||||
* @return {stopbits_t} 返回stopbits。
|
||||
@ -295,7 +300,7 @@ stopbits_t serial_stopbits_from_str(const char* str);
|
||||
/**
|
||||
* @method serial_flowcontrol_from_str
|
||||
* 字符串转flowcontrol
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {const char*} str 字符串。
|
||||
*
|
||||
* @return {flowcontrol_t} 返回flowcontrol。
|
||||
@ -305,7 +310,7 @@ flowcontrol_t serial_flowcontrol_from_str(const char* str);
|
||||
/**
|
||||
* @method serial_parity_from_str
|
||||
* 字符串转parity
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {const char*} str 字符串。
|
||||
*
|
||||
* @return {parity_t} 返回parity。
|
||||
@ -315,7 +320,7 @@ parity_t serial_parity_from_str(const char* str);
|
||||
/**
|
||||
* @method serial_bytesize_from_str
|
||||
* 字符串转bytesize
|
||||
* @annotation ["global"]
|
||||
* @annotation ["static"]
|
||||
* @param {const char*} str 字符串。
|
||||
*
|
||||
* @return {bytesize_t} 返回bytesize。
|
||||
|
||||
Loading…
Reference in New Issue
Block a user