mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-11-29 18:48:09 +08:00
update docs
This commit is contained in:
lixianjing
parent
3ff4b53c43
commit
86406b96e1
@ -49,9 +49,11 @@ ui UI描述数据。
|
||||
| <a href="#assets_manager_t_assets_manager_get_res_root">assets\_manager\_get\_res\_root</a> | 获取资源所在的目录(其下目录结构请参考demos)。 |
|
||||
| <a href="#assets_manager_t_assets_manager_init">assets\_manager\_init</a> | 初始化资源管理器。 |
|
||||
| <a href="#assets_manager_t_assets_manager_load">assets\_manager\_load</a> | 从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH\_FS\_RES时才生效。 |
|
||||
| <a href="#assets_manager_t_assets_manager_load_ex">assets\_manager\_load\_ex</a> | 从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH\_FS\_RES时才生效。 |
|
||||
| <a href="#assets_manager_t_assets_manager_load_file">assets\_manager\_load\_file</a> | 获取path里的资源。 |
|
||||
| <a href="#assets_manager_t_assets_manager_preload">assets\_manager\_preload</a> | 从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH\_FS\_RES时才生效。 |
|
||||
| <a href="#assets_manager_t_assets_manager_ref">assets\_manager\_ref</a> | 在资源管理器的缓存中查找指定的资源并引用它，如果缓存中不存在，尝试加载该资源。 |
|
||||
| <a href="#assets_manager_t_assets_manager_ref_ex">assets\_manager\_ref\_ex</a> | 在资源管理器的缓存中查找指定的资源并引用它，如果缓存中不存在，尝试加载该资源。 |
|
||||
| <a href="#assets_manager_t_assets_manager_set">assets\_manager\_set</a> | 设置缺省资源管理器。 |
|
||||
| <a href="#assets_manager_t_assets_manager_set_custom_build_asset_dir">assets\_manager\_set\_custom\_build\_asset\_dir</a> | 设置一个函数，该函数用于生成资源路径。 |
|
||||
| <a href="#assets_manager_t_assets_manager_set_custom_load_asset">assets\_manager\_set\_custom\_load\_asset</a> | 设置一个函数，该函数用于实现自定义加载资源。 |
|
||||
@ -229,7 +231,7 @@ ret_t assets_manager_destroy (assets_manager_t* am);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
asset_info_t* assets_manager_find_in_cache (assets_manager_t* am, asset_type_t type, char* name);
|
||||
asset_info_t* assets_manager_find_in_cache (assets_manager_t* am, asset_type_t type, uint16_t subtype, char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -239,6 +241,7 @@ asset_info_t* assets_manager_find_in_cache (assets_manager_t* am, asset_type_t t
|
||||
| 返回值 | asset\_info\_t* | 返回资源。 |
|
||||
| am | assets\_manager\_t* | asset manager对象。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
| subtype | uint16\_t | 资源的子类型。 |
|
||||
| name | char* | 资源的名称。 |
|
||||
#### assets\_manager\_get\_res\_root 函数
|
||||
-----------------------
|
||||
@ -300,6 +303,28 @@ asset_info_t* assets_manager_load (assets_manager_t* am, asset_type_t type, char
|
||||
| am | assets\_manager\_t* | asset manager对象。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
| name | char* | 资源的名称。 |
|
||||
#### assets\_manager\_load\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="assets_manager_t_assets_manager_load_ex">从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH\_FS\_RES时才生效。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
asset_info_t* assets_manager_load_ex (assets_manager_t* am, asset_type_t type, asset_type_t type, char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | asset\_info\_t* | 返回资源。 |
|
||||
| am | assets\_manager\_t* | asset manager对象。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
| type | asset\_type\_t | 资源的子类型。 |
|
||||
| name | char* | 资源的名称。 |
|
||||
#### assets\_manager\_load\_file 函数
|
||||
-----------------------
|
||||
|
||||
@ -363,6 +388,28 @@ asset_info_t* assets_manager_ref (assets_manager_t* am, asset_type_t type, char*
|
||||
| am | assets\_manager\_t* | asset manager对象。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
| name | char* | 资源的名称。 |
|
||||
#### assets\_manager\_ref\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="assets_manager_t_assets_manager_ref_ex">在资源管理器的缓存中查找指定的资源并引用它，如果缓存中不存在，尝试加载该资源。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
asset_info_t* assets_manager_ref_ex (assets_manager_t* am, asset_type_t type, uint16_t subtype, char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | asset\_info\_t* | 返回资源。 |
|
||||
| am | assets\_manager\_t* | asset manager对象。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
| subtype | uint16\_t | 资源的子类型。 |
|
||||
| name | char* | 资源的名称。 |
|
||||
#### assets\_manager\_set 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#cmd_exec_event_t_args">args</a> | const char* | 命令的参数。 |
|
||||
| <a href="#cmd_exec_event_t_can_exec">can\_exec</a> | bool\_t | 执行结果(适用于CAN_EXEC)。 |
|
||||
| <a href="#cmd_exec_event_t_can_exec">can\_exec</a> | bool\_t | 标识命令是否可以执行(适用于CAN_EXEC)。 |
|
||||
| <a href="#cmd_exec_event_t_name">name</a> | const char* | 命令的名称。 |
|
||||
| <a href="#cmd_exec_event_t_result">result</a> | ret\_t | 执行结果(适用于EXECED)。 |
|
||||
#### cmd\_exec\_event\_cast 函数
|
||||
@ -74,7 +74,7 @@ event_t* cmd_exec_event_init (cmd_exec_event_t* event, uint32_t type, const char
|
||||
| 可脚本化 | 是 |
|
||||
#### can\_exec 属性
|
||||
-----------------------
|
||||
> <p id="cmd_exec_event_t_can_exec">执行结果(适用于CAN_EXEC)。
|
||||
> <p id="cmd_exec_event_t_can_exec">标识命令是否可以执行(适用于CAN_EXEC)。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
|
||||
51
docs/manual/csv_file_object_t.md
Normal file
51
docs/manual/csv_file_object_t.md
Normal file
@ -0,0 +1,51 @@
|
||||
## csv\_file\_object\_t
|
||||
### 概述
|
||||
|
||||
|
||||
将cvs file包装成object对象。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="csv_file_object_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#csv_file_object_t_csv_file_object_create">csv\_file\_object\_create</a> | 将csv_file对象包装成object。 |
|
||||
| <a href="#csv_file_object_t_csv_file_object_get_csv">csv\_file\_object\_get\_csv</a> | 获取csv对象。 |
|
||||
#### csv\_file\_object\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_object_t_csv_file_object_create">将csv_file对象包装成object。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* csv_file_object_create (csv_file_t* csv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回对象。 |
|
||||
| csv | csv\_file\_t* | csv对象(由object释放)。 |
|
||||
#### csv\_file\_object\_get\_csv 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_object_t_csv_file_object_get_csv">获取csv对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
csv_file_t* csv_file_object_get_csv (object_t* obj);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | csv\_file\_t* | 返回csv对象。 |
|
||||
| obj | object\_t* | obj对象。 |
|
||||
506
docs/manual/csv_file_t.md
Normal file
506
docs/manual/csv_file_t.md
Normal file
@ -0,0 +1,506 @@
|
||||
## csv\_file\_t
|
||||
### 概述
|
||||
操作CSV文件。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="csv_file_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#csv_file_t_csv_file_append_row">csv\_file\_append\_row</a> | 追加一行。 |
|
||||
| <a href="#csv_file_t_csv_file_clear">csv\_file\_clear</a> | 保存。 |
|
||||
| <a href="#csv_file_t_csv_file_create">csv\_file\_create</a> | 根据文件创建csv对象。 |
|
||||
| <a href="#csv_file_t_csv_file_create_empty">csv\_file\_create\_empty</a> | 创建空的csv对象。 |
|
||||
| <a href="#csv_file_t_csv_file_create_with_buff">csv\_file\_create\_with\_buff</a> | 根据buff创建csv对象。 |
|
||||
| <a href="#csv_file_t_csv_file_destroy">csv\_file\_destroy</a> | 销毁csv对象。 |
|
||||
| <a href="#csv_file_t_csv_file_get">csv\_file\_get</a> | 获取指定行列的数据。 |
|
||||
| <a href="#csv_file_t_csv_file_get_checked_rows">csv\_file\_get\_checked\_rows</a> | 获取checked行数(包括标题)。 |
|
||||
| <a href="#csv_file_t_csv_file_get_cols">csv\_file\_get\_cols</a> | 获取列数。 |
|
||||
| <a href="#csv_file_t_csv_file_get_rows">csv\_file\_get\_rows</a> | 获取行数(包括标题)。 |
|
||||
| <a href="#csv_file_t_csv_file_get_title">csv\_file\_get\_title</a> | 获取标题(不存在则返回NULL)。 |
|
||||
| <a href="#csv_file_t_csv_file_insert_row">csv\_file\_insert\_row</a> | 插入一行。 |
|
||||
| <a href="#csv_file_t_csv_file_is_row_checked">csv\_file\_is\_row\_checked</a> | 判断指定行是否勾选。 |
|
||||
| <a href="#csv_file_t_csv_file_load_buff">csv\_file\_load\_buff</a> | 从内存加载csv。 |
|
||||
| <a href="#csv_file_t_csv_file_load_file">csv\_file\_load\_file</a> | 从文件加载csv。 |
|
||||
| <a href="#csv_file_t_csv_file_load_file">csv\_file\_load\_file</a> | 保存。 |
|
||||
| <a href="#csv_file_t_csv_file_reload">csv\_file\_reload</a> | 丢弃内存中的修改，重新加载当前文件。 |
|
||||
| <a href="#csv_file_t_csv_file_remove_checked_rows">csv\_file\_remove\_checked\_rows</a> | 删除全部勾选的行。 |
|
||||
| <a href="#csv_file_t_csv_file_remove_row">csv\_file\_remove\_row</a> | 删除指定行。 |
|
||||
| <a href="#csv_file_t_csv_file_save">csv\_file\_save</a> | 保存。 |
|
||||
| <a href="#csv_file_t_csv_file_set">csv\_file\_set</a> | 修改指定行列的数据。 |
|
||||
| <a href="#csv_file_t_csv_file_set_filter">csv\_file\_set\_filter</a> | 设置过滤函数。 |
|
||||
| <a href="#csv_file_t_csv_file_set_row_checked">csv\_file\_set\_row\_checked</a> | 勾选指定行。 |
|
||||
### 属性
|
||||
<p id="csv_file_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#csv_file_t_has_title">has\_title</a> | bool\_t | 是否有标题。 |
|
||||
#### csv\_file\_append\_row 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_append_row">追加一行。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_append_row (csv_file_t* csv, const char* data);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| data | const char* | 数据。 |
|
||||
#### csv\_file\_clear 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_clear">保存。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_clear (csv_file_t* csv, const char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
#### csv\_file\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_create">根据文件创建csv对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
csv_file_t* csv_file_create (const char* filename, char sep);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | csv\_file\_t* | 返回csv对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
| sep | char | 分隔符。 |
|
||||
#### csv\_file\_create\_empty 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_create_empty">创建空的csv对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
csv_file_t* csv_file_create_empty (char sep, csv_file_filter_t filter, void* ctx);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | csv\_file\_t* | 返回csv对象。 |
|
||||
| sep | char | 分隔符。 |
|
||||
| filter | csv\_file\_filter\_t | 过滤函数。 |
|
||||
| ctx | void* | 过滤函数的上下文。 |
|
||||
#### csv\_file\_create\_with\_buff 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_create_with_buff">根据buff创建csv对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
csv_file_t csv_file_create_with_buff (const char* buff, uint32_t size, char sep);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | csv\_file\_t | 返回csv对象。 |
|
||||
| buff | const char* | 数据。 |
|
||||
| size | uint32\_t | 数据长度。 |
|
||||
| sep | char | 分隔符。 |
|
||||
#### csv\_file\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_destroy">销毁csv对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_destroy (csv_file_t* csv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
#### csv\_file\_get 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_get">获取指定行列的数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* csv_file_get (csv_file_t* csv, uint32_t row, uint32_t col);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回数据。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| row | uint32\_t | 行号。 |
|
||||
| col | uint32\_t | 列号。 |
|
||||
#### csv\_file\_get\_checked\_rows 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_get_checked_rows">获取checked行数(包括标题)。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t csv_file_get_checked_rows (csv_file_t* csv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回checked行数。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
#### csv\_file\_get\_cols 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_get_cols">获取列数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t csv_file_get_cols (csv_file_t* csv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回列数。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
#### csv\_file\_get\_rows 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_get_rows">获取行数(包括标题)。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t csv_file_get_rows (csv_file_t* csv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回行数。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
#### csv\_file\_get\_title 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_get_title">获取标题(不存在则返回NULL)。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* csv_file_get_title (csv_file_t* csv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回标题。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
#### csv\_file\_insert\_row 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_insert_row">插入一行。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_insert_row (csv_file_t* csv, uint32_t row, const char* data);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| row | uint32\_t | 行号。 |
|
||||
| data | const char* | 数据。 |
|
||||
#### csv\_file\_is\_row\_checked 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_is_row_checked">判断指定行是否勾选。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t csv_file_is_row_checked (csv_file_t* csv, uint32_t row);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回TRUE表示勾选，否则表示没勾选。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| row | uint32\_t | 行号。 |
|
||||
#### csv\_file\_load\_buff 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_load_buff">从内存加载csv。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_load_buff (csv_file_t* csv, const char* buff, uint32_t size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| buff | const char* | 数据。 |
|
||||
| size | uint32\_t | 数据长度。 |
|
||||
#### csv\_file\_load\_file 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_load_file">从文件加载csv。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_load_file (csv_file_t* csv, const char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
#### csv\_file\_load\_file 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_load_file">保存。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_load_file (csv_file_t* csv, const char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
#### csv\_file\_reload 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_reload">丢弃内存中的修改，重新加载当前文件。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_reload (csv_file_t* csv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
#### csv\_file\_remove\_checked\_rows 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_remove_checked_rows">删除全部勾选的行。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_remove_checked_rows (csv_file_t* csv);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
#### csv\_file\_remove\_row 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_remove_row">删除指定行。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_remove_row (csv_file_t* csv, uint32_t row);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| row | uint32\_t | 行号。 |
|
||||
#### csv\_file\_save 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_save">保存。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_save (csv_file_t* csv, const char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
#### csv\_file\_set 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_set">修改指定行列的数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_set (csv_file_t* csv, uint32_t row, uint32_t col, const char* value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| row | uint32\_t | 行号。 |
|
||||
| col | uint32\_t | 列号。 |
|
||||
| value | const char* | 值。 |
|
||||
#### csv\_file\_set\_filter 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_set_filter">设置过滤函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_set_filter (csv_file_t* csv, csv_file_filter_t filter, void* ctx);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| filter | csv\_file\_filter\_t | 过滤函数。 |
|
||||
| ctx | void* | 过滤函数的上下文。 |
|
||||
#### csv\_file\_set\_row\_checked 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="csv_file_t_csv_file_set_row_checked">勾选指定行。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t csv_file_set_row_checked (csv_file_t* csv, uint32_t row, bool_t checked);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| csv | csv\_file\_t* | csv对象。 |
|
||||
| row | uint32\_t | 行号。 |
|
||||
| checked | bool\_t | 是否勾选。 |
|
||||
#### has\_title 属性
|
||||
-----------------------
|
||||
> <p id="csv_file_t_has_title">是否有标题。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
@ -38,6 +38,7 @@ darray_destroy(darray);
|
||||
| <a href="#darray_t_darray_get">darray\_get</a> | 获取指定序数的元素。 |
|
||||
| <a href="#darray_t_darray_head">darray\_head</a> | 返回第一个元素。 |
|
||||
| <a href="#darray_t_darray_init">darray\_init</a> | 初始化darray对象。 |
|
||||
| <a href="#darray_t_darray_insert">darray\_insert</a> | 插入一个元素。 |
|
||||
| <a href="#darray_t_darray_pop">darray\_pop</a> | 弹出最后一个元素。 |
|
||||
| <a href="#darray_t_darray_push">darray\_push</a> | 在尾巴追加一个元素。 |
|
||||
| <a href="#darray_t_darray_remove">darray\_remove</a> | 删除第一个满足条件的元素。 |
|
||||
@ -348,6 +349,27 @@ darray_t* darray_init (darray_t* darray, uint32_t capacity, tk_destroy_t destroy
|
||||
| capacity | uint32\_t | 数组的初始容量。 |
|
||||
| destroy | tk\_destroy\_t | 元素销毁函数。 |
|
||||
| compare | tk\_compare\_t | 元素比较函数。 |
|
||||
#### darray\_insert 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="darray_t_darray_insert">插入一个元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t darray_insert (darray_t* darray, uint32_t index, void* data);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| darray | darray\_t* | 数组对象。 |
|
||||
| index | uint32\_t | 位置序数。 |
|
||||
| data | void* | 待插入的元素。 |
|
||||
#### darray\_pop 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -9,8 +9,29 @@
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#data_writer_t_data_writer_clear">data\_writer\_clear</a> | 清除指定URL的数据。 |
|
||||
| <a href="#data_writer_t_data_writer_destroy">data\_writer\_destroy</a> | 销毁writer对象。 |
|
||||
| <a href="#data_writer_t_data_writer_truncate">data\_writer\_truncate</a> | 截去指定长度之后的数据。 |
|
||||
| <a href="#data_writer_t_data_writer_write">data\_writer\_write</a> | 在指定位置写入数据。 |
|
||||
#### data\_writer\_clear 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_writer_t_data_writer_clear">清除指定URL的数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t data_writer_clear (const char* url);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| url | const char* | URL。 |
|
||||
#### data\_writer\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
@ -30,6 +51,26 @@ ret_t data_writer_destroy (data_writer_t* writer);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| writer | data\_writer\_t* | writer对象。 |
|
||||
#### data\_writer\_truncate 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_writer_t_data_writer_truncate">截去指定长度之后的数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t data_writer_truncate (data_writer_t* writer, uint64_t size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| writer | data\_writer\_t* | writer对象。 |
|
||||
| size | uint64\_t | 保留长度。 |
|
||||
#### data\_writer\_write 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -98,22 +98,18 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#edit_t_action_text">action\_text</a> | char* | 软键盘上action按钮的文本。内置取值有： |
|
||||
| <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_cancelable">cancelable</a> | bool\_t | 是否支持撤销编辑。如果为TRUE，在失去焦点之前可以撤销所有修改(恢复获得焦点之前的内容)。 |
|
||||
| <a href="#edit_t_close_im_when_blured">close\_im\_when\_blured</a> | bool\_t | 是否在失去焦点时关闭输入法(默认是)。 |
|
||||
| <a href="#edit_t_input_type">input\_type</a> | input\_type\_t | 输入类型。 |
|
||||
| <a href="#edit_t_keyboard">keyboard</a> | char* | 自定义软键盘名称。AWTK优先查找keyboard属性设置的键盘文件名（该键盘的XML文件需要在default\raw\ui目录下存在），如果keyboard为空就找input_type设置的键盘类型 |
|
||||
| <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 | 最小值或最小长度。 |
|
||||
| <a href="#edit_t_open_im_when_focused">open\_im\_when\_focused</a> | bool\_t | 获得焦点时打开输入法。 |
|
||||
| <a href="#edit_t_password_visible">password\_visible</a> | bool\_t | 密码是否可见。 |
|
||||
| <a href="#edit_t_readonly">readonly</a> | bool\_t | 编辑器是否为只读。 |
|
||||
| <a href="#edit_t_right_margin">right\_margin</a> | uint8\_t | 右边距。 |
|
||||
| <a href="#edit_t_select_none_when_focused">select\_none\_when\_focused</a> | bool\_t | 获得焦点时不选中文本。 |
|
||||
| <a href="#edit_t_step">step</a> | double | 步长。 |
|
||||
| <a href="#edit_t_tips">tips</a> | char* | 输入提示。 |
|
||||
| <a href="#edit_t_top_margin">top\_margin</a> | uint8\_t | 上边距。 |
|
||||
| <a href="#edit_t_tr_tips">tr\_tips</a> | char* | 保存用于翻译的提示信息。 |
|
||||
### 事件
|
||||
<p id="edit_t_events">
|
||||
@ -743,22 +739,6 @@ ret_t edit_set_tr_tips (widget_t* widget, const char* tr_tips);
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### bottom\_margin 属性
|
||||
-----------------------
|
||||
> <p id="edit_t_bottom_margin">下边距。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
@ -826,22 +806,6 @@ ret_t edit_set_tr_tips (widget_t* widget, const char* tr_tips);
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### left\_margin 属性
|
||||
-----------------------
|
||||
> <p id="edit_t_left_margin">左边距。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
@ -924,22 +888,6 @@ ret_t edit_set_tr_tips (widget_t* widget, const char* tr_tips);
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### right\_margin 属性
|
||||
-----------------------
|
||||
> <p id="edit_t_right_margin">右边距。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
@ -991,22 +939,6 @@ ret_t edit_set_tr_tips (widget_t* widget, const char* tr_tips);
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### top\_margin 属性
|
||||
-----------------------
|
||||
> <p id="edit_t_top_margin">上边距。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -11,6 +11,7 @@ stb主要用于加载矢量字体(如truetype)，它功能强大，体积小巧
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#font_loader_stb_t_fargs_get_data_and_size">fargs\_get\_data\_and\_size</a> | 从参数中获取数据和长度。 |
|
||||
| <a href="#font_loader_stb_t_font_loader_stb">font\_loader\_stb</a> | 获取stb字体加载器对象。 |
|
||||
| <a href="#font_loader_stb_t_font_stb_create">font\_stb\_create</a> | 创建stb字体对象。 |
|
||||
| <a href="#font_loader_stb_t_fscript_app_conf_register">fscript\_app\_conf\_register</a> | 注册app_conf函数。 |
|
||||
@ -34,6 +35,27 @@ stb主要用于加载矢量字体(如truetype)，它功能强大，体积小巧
|
||||
| <a href="#font_loader_stb_t_fscript_typed_array_register">fscript\_typed\_array\_register</a> | 注册typed array函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_wbuffer_register">fscript\_wbuffer\_register</a> | 注册wbuffer相关函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_widget_register">fscript\_widget\_register</a> | 注册widget函数。 |
|
||||
#### fargs\_get\_data\_and\_size 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fargs_get_data_and_size">从参数中获取数据和长度。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fargs_get_data_and_size (fscript_args_t* args, const uint8_t** , uint32_t* ret_size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| args | fscript\_args\_t* | 参数。 |
|
||||
| | const uint8\_t** | 。 |
|
||||
| ret\_size | uint32\_t* | 返回数据的长度。 |
|
||||
#### font\_loader\_stb 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
BIN
docs/manual/images/csv_file_object_t_0.png
Normal file
BIN
docs/manual/images/csv_file_object_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.1 KiB |
@ -53,7 +53,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L1
|
||||
| <a href="#label_t_label_resize_to_content">label\_resize\_to\_content</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_word_wrap">label\_set\_word\_wrap</a> | 设置是否允许单词中换行。(需要开启自动换行才有效果) |
|
||||
| <a href="#label_t_label_set_word_wrap">label\_set\_word\_wrap</a> | 设置是否允许整个单词换行。(需要开启自动换行才有效果) |
|
||||
### 属性
|
||||
<p id="label_t_properties">
|
||||
|
||||
@ -61,7 +61,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L1
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#label_t_length">length</a> | int32\_t | 显示字符的个数(小余0时全部显示)。 |
|
||||
| <a href="#label_t_line_wrap">line\_wrap</a> | bool\_t | 是否自动换行。 |
|
||||
| <a href="#label_t_word_wrap">word\_wrap</a> | bool\_t | 是否允许单词中换行。(需要开启自动换行才有效果) |
|
||||
| <a href="#label_t_word_wrap">word\_wrap</a> | bool\_t | 是否允许整个单词换行。(需要开启自动换行才有效果) |
|
||||
#### label\_cast 函数
|
||||
-----------------------
|
||||
|
||||
@ -172,7 +172,7 @@ ret_t label_set_line_wrap (widget_t* widget, bool_t line_wrap);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="label_t_label_set_word_wrap">设置是否允许单词中换行。(需要开启自动换行才有效果)
|
||||
> <p id="label_t_label_set_word_wrap">设置是否允许整个单词换行。(需要开启自动换行才有效果)
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -186,7 +186,7 @@ ret_t label_set_word_wrap (widget_t* widget, bool_t word_wrap);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| word\_wrap | bool\_t | 是否允许单词中换行。 |
|
||||
| word\_wrap | bool\_t | 是否允许整个单词换行。 |
|
||||
#### length 属性
|
||||
-----------------------
|
||||
> <p id="label_t_length">显示字符的个数(小余0时全部显示)。
|
||||
@ -222,7 +222,7 @@ ret_t label_set_word_wrap (widget_t* widget, bool_t word_wrap);
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### word\_wrap 属性
|
||||
-----------------------
|
||||
> <p id="label_t_word_wrap">是否允许单词中换行。(需要开启自动换行才有效果)
|
||||
> <p id="label_t_word_wrap">是否允许整个单词换行。(需要开启自动换行才有效果)
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
|
||||
@ -48,6 +48,14 @@ widget_t* list_view = list_view_create(win, 0, 0, 0, 0);
|
||||
如果需要动态修改，可以使用widget\_clone来增加列表项，使用widget\_remove\_child来移出列表项。
|
||||
|
||||
可用通过style来设置控件的显示风格，如背景颜色和边框颜色等(一般情况不需要)。
|
||||
|
||||
备注：list_view 下的 scroll_view 控件不支持遍历所有子控件的效果。
|
||||
|
||||
下面是针对 scroll_bar_d （桌面版）有效果，scroll_bar_m（移动版）没有效果。
|
||||
如果 floating_scroll_bar 属性为 TRUE 和 auto_hide_scroll_bar 属性为 TRUE，scroll_view 宽默认为 list_view 的 100% 宽，鼠标在 list_view 上滚动条才显示，不在的就自动隐藏，如果 scroll_view 的高比虚拟高要大的话，滚动条变成不可见，scroll_view 宽不会变。
|
||||
如果 floating_scroll_bar 属性为 TRUE 和 auto_hide_scroll_bar 属性为 FALSE ，scroll_view 宽默认为 list_view 的 100% 宽，滚动条不隐藏，如果 scroll_view 的高比虚拟高要大的话，滚动条变成不可见，scroll_view 宽不会变。
|
||||
如果 floating_scroll_bar 属性为 FALSE 和 auto_hide_scroll_bar 属性为 FALSE，如果 scroll_view 的高比虚拟高要大的话，滚动条变成不可用，scroll_view 宽不会变。
|
||||
如果 floating_scroll_bar 属性为 FALSE 和 auto_hide_scroll_bar 属性为 TRUE，如果 scroll_view 的高比虚拟高要大的话，滚动条变成不可见，scroll_view 宽会合并原来滚动条的宽。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="list_view_t_methods">
|
||||
@ -59,6 +67,7 @@ widget_t* list_view = list_view_create(win, 0, 0, 0, 0);
|
||||
| <a href="#list_view_t_list_view_reinit">list\_view\_reinit</a> | list_view重新初始化。 |
|
||||
| <a href="#list_view_t_list_view_set_auto_hide_scroll_bar">list\_view\_set\_auto\_hide\_scroll\_bar</a> | 设置是否自动隐藏滚动条。 |
|
||||
| <a href="#list_view_t_list_view_set_default_item_height">list\_view\_set\_default\_item\_height</a> | 设置列表项的缺省高度。 |
|
||||
| <a href="#list_view_t_list_view_set_floating_scroll_bar">list\_view\_set\_floating\_scroll\_bar</a> | 设置滚动条是否悬浮在 scroll_view 上面。 |
|
||||
| <a href="#list_view_t_list_view_set_item_height">list\_view\_set\_item\_height</a> | 设置列表项的高度。 |
|
||||
### 属性
|
||||
<p id="list_view_t_properties">
|
||||
@ -67,6 +76,7 @@ widget_t* list_view = list_view_create(win, 0, 0, 0, 0);
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#list_view_t_auto_hide_scroll_bar">auto\_hide\_scroll\_bar</a> | bool\_t | 如果不需要滚动条时，自动隐藏滚动条。 |
|
||||
| <a href="#list_view_t_default_item_height">default\_item\_height</a> | int32\_t | 列表项的缺省高度。如果item_height <= 0 而且列表项自身的高度 <= 0，则使用缺省高度。 |
|
||||
| <a href="#list_view_t_floating_scroll_bar">floating\_scroll\_bar</a> | bool\_t | 滚动条是否悬浮在 scroll_view 上面 |
|
||||
| <a href="#list_view_t_item_height">item\_height</a> | int32\_t | 列表项的高度。如果 item_height > 0，所有列表项使用固定高度，否则使用列表项自身的高度。 |
|
||||
#### list\_view\_cast 函数
|
||||
-----------------------
|
||||
@ -169,6 +179,26 @@ ret_t list_view_set_default_item_height (widget_t* widget, int32_t default_item_
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| default\_item\_height | int32\_t | 列表项的高度。 |
|
||||
#### list\_view\_set\_floating\_scroll\_bar 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="list_view_t_list_view_set_floating_scroll_bar">设置滚动条是否悬浮在 scroll_view 上面。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t list_view_set_floating_scroll_bar (widget_t* widget, bool_t floating_scroll_bar);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| floating\_scroll\_bar | bool\_t | 滚动条是否悬浮在 scroll\_view 上面。 |
|
||||
#### list\_view\_set\_item\_height 函数
|
||||
-----------------------
|
||||
|
||||
@ -211,6 +241,22 @@ ret_t list_view_set_item_height (widget_t* widget, int32_t item_height);
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### floating\_scroll\_bar 属性
|
||||
-----------------------
|
||||
> <p id="list_view_t_floating_scroll_bar">滚动条是否悬浮在 scroll_view 上面
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -50,18 +50,14 @@ time\_clock一般不需要设置style。
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#mledit_t_bottom_margin">bottom\_margin</a> | uint8\_t | 下边距。 |
|
||||
| <a href="#mledit_t_cancelable">cancelable</a> | bool\_t | 是否支持撤销编辑。如果为TRUE，在失去焦点之前可以撤销所有修改(恢复获得焦点之前的内容)。 |
|
||||
| <a href="#mledit_t_close_im_when_blured">close\_im\_when\_blured</a> | bool\_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_open_im_when_focused">open\_im\_when\_focused</a> | bool\_t | 获得焦点时打开输入法。 |
|
||||
| <a href="#mledit_t_readonly">readonly</a> | bool\_t | 编辑器是否为只读。 |
|
||||
| <a href="#mledit_t_right_margin">right\_margin</a> | uint8\_t | 右边距。 |
|
||||
| <a href="#mledit_t_scroll_line">scroll\_line</a> | uint32\_t | 鼠标一次滚动行数。 |
|
||||
| <a href="#mledit_t_tips">tips</a> | char* | 输入提示。 |
|
||||
| <a href="#mledit_t_top_margin">top\_margin</a> | uint8\_t | 上边距。 |
|
||||
| <a href="#mledit_t_tr_tips">tr\_tips</a> | char* | 保存用于翻译的提示信息。 |
|
||||
| <a href="#mledit_t_wrap_word">wrap\_word</a> | bool\_t | 是否自动折行。 |
|
||||
### 事件
|
||||
@ -356,22 +352,6 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| wrap\_word | bool\_t | 是否自动折行。 |
|
||||
#### bottom\_margin 属性
|
||||
-----------------------
|
||||
> <p id="mledit_t_bottom_margin">下边距。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### cancelable 属性
|
||||
-----------------------
|
||||
> <p id="mledit_t_cancelable">是否支持撤销编辑。如果为TRUE，在失去焦点之前可以撤销所有修改(恢复获得焦点之前的内容)。
|
||||
@ -413,22 +393,6 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### left\_margin 属性
|
||||
-----------------------
|
||||
> <p id="mledit_t_left_margin">左边距。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
@ -479,22 +443,6 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### right\_margin 属性
|
||||
-----------------------
|
||||
> <p id="mledit_t_right_margin">右边距。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
@ -527,22 +475,6 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word);
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### top\_margin 属性
|
||||
-----------------------
|
||||
> <p id="mledit_t_top_margin">上边距。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -26,7 +26,7 @@
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
mmap_t* mmap_create (mmap_t* mmap, const char* filename, bool_t writable, bool_t shared);
|
||||
mmap_t* mmap_create (const char* filename, bool_t writable, bool_t shared);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -34,7 +34,6 @@ mmap_t* mmap_create (mmap_t* mmap, const char* filename, bool_t writable, bool_t
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | mmap\_t* | mmap对象本身。 |
|
||||
| mmap | mmap\_t* | mmap对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
| writable | bool\_t | 是否可写。 |
|
||||
| shared | bool\_t | 是否共享。 |
|
||||
|
||||
304
docs/manual/network_interface_t.md
Normal file
304
docs/manual/network_interface_t.md
Normal file
@ -0,0 +1,304 @@
|
||||
## network\_interface\_t
|
||||
### 概述
|
||||
网卡接口。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="network_interface_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#network_interface_t_network_interface_create">network\_interface\_create</a> | 网卡接口创建函数。 |
|
||||
| <a href="#network_interface_t_network_interface_destroy">network\_interface\_destroy</a> | 网卡接口销毁函数。 |
|
||||
| <a href="#network_interface_t_network_interface_disable">network\_interface\_disable</a> | 网卡接口禁能函数。 |
|
||||
| <a href="#network_interface_t_network_interface_enable">network\_interface\_enable</a> | 网卡接口使能函数。 |
|
||||
| <a href="#network_interface_t_network_interface_get_ipaddr">network\_interface\_get\_ipaddr</a> | 网卡接口获取IP地址。 |
|
||||
| <a href="#network_interface_t_network_interface_get_macaddr">network\_interface\_get\_macaddr</a> | 网卡接口获取MAC地址。 |
|
||||
| <a href="#network_interface_t_network_interface_get_quality">network\_interface\_get\_quality</a> | 网卡接口获取通信质量。 |
|
||||
| <a href="#network_interface_t_network_interface_get_status">network\_interface\_get\_status</a> | 网卡接口获取状态。 |
|
||||
| <a href="#network_interface_t_network_interface_set_dhcp">network\_interface\_set\_dhcp</a> | 网卡接口设置DNS。 |
|
||||
| <a href="#network_interface_t_network_interface_set_dns">network\_interface\_set\_dns</a> | 网卡接口设置DNS。 |
|
||||
| <a href="#network_interface_t_network_interface_set_gateway">network\_interface\_set\_gateway</a> | 网卡接口设置DNS。 |
|
||||
| <a href="#network_interface_t_network_interface_set_ipaddr">network\_interface\_set\_ipaddr</a> | 网卡接口设置IP地址。 |
|
||||
| <a href="#network_interface_t_network_interface_set_wifi_ap">network\_interface\_set\_wifi\_ap</a> | 网卡接口设置WIFI AP模式。 |
|
||||
| <a href="#network_interface_t_network_interface_set_wifi_sta">network\_interface\_set\_wifi\_sta</a> | 网卡接口设置WIFI STA模式。 |
|
||||
#### network\_interface\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_create">网卡接口创建函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
network_interface_t network_interface_create (char * interface, type network_interface_type_t);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | network\_interface\_t | 网卡接口对象。 |
|
||||
| interface | char * | 网卡名。 |
|
||||
| network\_interface\_type\_t | type | 网卡接口类型。 |
|
||||
#### network\_interface\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_destroy">网卡接口销毁函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void network_interface_destroy (network_interface_t * interface);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
#### network\_interface\_disable 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_disable">网卡接口禁能函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t network_interface_disable (network_interface_t * interface);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | RET\_OK表示成功，否则失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
#### network\_interface\_enable 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_enable">网卡接口使能函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t network_interface_enable (network_interface_t * interface);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | RET\_OK表示成功，否则失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
#### network\_interface\_get\_ipaddr 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_get_ipaddr">网卡接口获取IP地址。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
char * network_interface_get_ipaddr (network_interface_t * interface);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | char * | 返回IP地址成功，NULL失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
#### network\_interface\_get\_macaddr 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_get_macaddr">网卡接口获取MAC地址。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
char * network_interface_get_macaddr (network_interface_t * interface);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | char * | 返回MAC地址成功，NULL失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
#### network\_interface\_get\_quality 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_get_quality">网卡接口获取通信质量。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int network_interface_get_quality (network_interface_t * interface);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 对于无线网络返回信号RSSI的绝对值， 对于有线网络，返回10、100、1000M带宽。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
#### network\_interface\_get\_status 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_get_status">网卡接口获取状态。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int network_interface_get_status (network_interface_t * interface);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 0表示未连接，1表示连接成功，-1表示操作失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
#### network\_interface\_set\_dhcp 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_set_dhcp">网卡接口设置DNS。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t network_interface_set_dhcp (network_interface_t * interface);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | RET\_OK表示成功，否则失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
#### network\_interface\_set\_dns 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_set_dns">网卡接口设置DNS。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t network_interface_set_dns (network_interface_t * interface, char * dns);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | RET\_OK表示成功，否则失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
| dns | char * | 网卡dns。 |
|
||||
#### network\_interface\_set\_gateway 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_set_gateway">网卡接口设置DNS。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t network_interface_set_gateway (network_interface_t * interface, char * gateway, char * dev);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | RET\_OK表示成功，否则失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
| gateway | char * | 网卡网关。 |
|
||||
| dev | char * | 出口网卡设备名。 |
|
||||
#### network\_interface\_set\_ipaddr 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_set_ipaddr">网卡接口设置IP地址。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t network_interface_set_ipaddr (network_interface_t * interface, char * ipaddr, char * netmask);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | RET\_OK表示成功，否则失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
| ipaddr | char * | 网卡IP。 |
|
||||
| netmask | char * | 网卡MASK。 |
|
||||
#### network\_interface\_set\_wifi\_ap 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_set_wifi_ap">网卡接口设置WIFI AP模式。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t network_interface_set_wifi_ap (network_interface_t * interface, char * essid, char * passwd, network_interface_wifi_auth_t auth, uint8_t channel, network_interface_wifi_freq_t freq, uint8_t hidden);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | RET\_OK表示成功，否则失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
| essid | char * | wifi帐号 。 |
|
||||
| passwd | char * | wifi密码。 |
|
||||
| auth | network\_interface\_wifi\_auth\_t | wifi认证方式。 |
|
||||
| channel | uint8\_t | wifi通道。 |
|
||||
| freq | network\_interface\_wifi\_freq\_t | wifi频段。 |
|
||||
| hidden | uint8\_t | wifi是否隐藏。 |
|
||||
#### network\_interface\_set\_wifi\_sta 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="network_interface_t_network_interface_set_wifi_sta">网卡接口设置WIFI STA模式。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t network_interface_set_wifi_sta (network_interface_t * interface, char * essid, char * passwd, network_interface_wifi_auth_t auth);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | RET\_OK表示成功，否则失败。 |
|
||||
| interface | network\_interface\_t * | 网卡对象。 |
|
||||
| essid | char * | wifi帐号 。 |
|
||||
| passwd | char * | wifi密码。 |
|
||||
| auth | network\_interface\_wifi\_auth\_t | wifi认证方式。 |
|
||||
12
docs/manual/network_interface_type_t.md
Normal file
12
docs/manual/network_interface_type_t.md
Normal file
@ -0,0 +1,12 @@
|
||||
## network\_interface\_type\_t
|
||||
### 概述
|
||||
属性描述网卡类型。
|
||||
### 常量
|
||||
<p id="network_interface_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| NETWORK\_INTERFACE\_TYPE\_ETH | 以太网。 |
|
||||
| NETWORK\_INTERFACE\_TYPE\_WIFI | WIFI。 |
|
||||
| NETWORK\_INTERFACE\_TYPE\_MOBILE | 3G/4G/5G。 |
|
||||
| NETWORK\_INTERFACE\_TYPE\_UNKNOWN | 未知类型。 |
|
||||
11
docs/manual/network_interface_wifi_auth_t.md
Normal file
11
docs/manual/network_interface_wifi_auth_t.md
Normal file
@ -0,0 +1,11 @@
|
||||
## network\_interface\_wifi\_auth\_t
|
||||
### 概述
|
||||
属性描述WIFI的认证方式。
|
||||
### 常量
|
||||
<p id="network_interface_wifi_auth_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| NETWORK\_INTERFACE\_WIFI\_AUTH\_WEP | WEP认证。 |
|
||||
| NETWORK\_INTERFACE\_WIFI\_AUTH\_WPAWPA2 | WPA/WPA2 认证。 |
|
||||
| NETWORK\_INTERFACE\_WIFI\_AUTH\_NONE | 无认证。 |
|
||||
10
docs/manual/network_interface_wifi_freq_t.md
Normal file
10
docs/manual/network_interface_wifi_freq_t.md
Normal file
@ -0,0 +1,10 @@
|
||||
## network\_interface\_wifi\_freq\_t
|
||||
### 概述
|
||||
属性描述WIFI的频段。
|
||||
### 常量
|
||||
<p id="network_interface_wifi_freq_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| NETWORK\_INTERFACE\_WIFI\_FREQ\_2\_4G | 2.4G频段。 |
|
||||
| NETWORK\_INTERFACE\_WIFI\_FREQ\_5G | 5G频段。 |
|
||||
@ -24,16 +24,25 @@
|
||||
| <a href="#object_t_object_get_prop_bool">object\_get\_prop\_bool</a> | 获取指定属性的bool类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_bool_by_path">object\_get\_prop\_bool\_by\_path</a> | 获取指定属性的bool类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_by_path">object\_get\_prop\_by\_path</a> | 获取指定path属性的值。 |
|
||||
| <a href="#object_t_object_get_prop_double">object\_get\_prop\_double</a> | 获取指定属性的浮点数类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_float">object\_get\_prop\_float</a> | 获取指定属性的浮点数类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_float_by_path">object\_get\_prop\_float\_by\_path</a> | 获取指定属性的浮点数类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_int">object\_get\_prop\_int</a> | 获取指定属性的整数类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_int_by_path">object\_get\_prop\_int\_by\_path</a> | 获取指定属性的整数类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_int16">object\_get\_prop\_int16</a> | 获取指定属性的int16类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_int32">object\_get\_prop\_int32</a> | 获取指定属性的int32类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_int64">object\_get\_prop\_int64</a> | 获取指定属性的int64类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_int8">object\_get\_prop\_int8</a> | 获取指定属性的int8类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_object">object\_get\_prop\_object</a> | 获取指定属性的object类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_object_by_path">object\_get\_prop\_object\_by\_path</a> | 获取指定属性的object类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_pointer">object\_get\_prop\_pointer</a> | 获取指定属性的指针类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_pointer_by_path">object\_get\_prop\_pointer\_by\_path</a> | 获取指定属性的指针类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_str">object\_get\_prop\_str</a> | 获取指定属性的字符串类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_str_by_path">object\_get\_prop\_str\_by\_path</a> | 获取指定属性的字符串类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_uint16">object\_get\_prop\_uint16</a> | 获取指定属性的uint16类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_uint32">object\_get\_prop\_uint32</a> | 获取指定属性的uint32类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_uint64">object\_get\_prop\_uint64</a> | 获取指定属性的uint64类型的值。 |
|
||||
| <a href="#object_t_object_get_prop_uint8">object\_get\_prop\_uint8</a> | 获取指定属性的uint8类型的值。 |
|
||||
| <a href="#object_t_object_get_size">object\_get\_size</a> | 获取对象占用内存的大小。 |
|
||||
| <a href="#object_t_object_get_type">object\_get\_type</a> | 获取对象的类型名称。 |
|
||||
| <a href="#object_t_object_has_prop">object\_has\_prop</a> | 检查是否存在指定的属性。 |
|
||||
@ -47,16 +56,25 @@
|
||||
| <a href="#object_t_object_set_prop_bool">object\_set\_prop\_bool</a> | 设置指定属性的bool类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_bool_by_path">object\_set\_prop\_bool\_by\_path</a> | 设置指定属性的bool类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_by_path">object\_set\_prop\_by\_path</a> | 设置指定属性的值。 |
|
||||
| <a href="#object_t_object_set_prop_double">object\_set\_prop\_double</a> | 设置指定属性的浮点数类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_float">object\_set\_prop\_float</a> | 设置指定属性的浮点数类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_float_by_path">object\_set\_prop\_float\_by\_path</a> | 设置指定属性的浮点数类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_int">object\_set\_prop\_int</a> | 设置指定属性的整数类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_int_by_path">object\_set\_prop\_int\_by\_path</a> | 设置指定属性的整数类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_int16">object\_set\_prop\_int16</a> | 设置指定属性的int16类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_int32">object\_set\_prop\_int32</a> | 设置指定属性的int32类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_int64">object\_set\_prop\_int64</a> | 设置指定属性的int64类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_int8">object\_set\_prop\_int8</a> | 设置指定属性的int8类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_object">object\_set\_prop\_object</a> | 设置指定属性的object类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_object_by_path">object\_set\_prop\_object\_by\_path</a> | 设置指定属性的object类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_pointer">object\_set\_prop\_pointer</a> | 设置指定属性的指针类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_pointer_by_path">object\_set\_prop\_pointer\_by\_path</a> | 设置指定属性的指针类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_str">object\_set\_prop\_str</a> | 设置指定属性的字符串类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_str_by_path">object\_set\_prop\_str\_by\_path</a> | 设置指定属性的字符串类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_uint16">object\_set\_prop\_uint16</a> | 设置指定属性的uint16类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_uint32">object\_set\_prop\_uint32</a> | 设置指定属性的uint32类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_uint64">object\_set\_prop\_uint64</a> | 设置指定属性的uint64类型的值。 |
|
||||
| <a href="#object_t_object_set_prop_uint8">object\_set\_prop\_uint8</a> | 设置指定属性的uint8类型的值。 |
|
||||
| <a href="#object_t_object_unref">object\_unref</a> | 引用计数减1。引用计数为0时，销毁对象。 |
|
||||
### 属性
|
||||
<p id="object_t_properties">
|
||||
@ -375,6 +393,27 @@ ret_t object_get_prop_by_path (object_t* obj, const char* path, value_t* v);
|
||||
| obj | object\_t* | object对象。 |
|
||||
| path | const char* | 属性的path，各级之间用.分隔。 |
|
||||
| v | value\_t* | 返回属性的值。 |
|
||||
#### object\_get\_prop\_double 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_get_prop_double">获取指定属性的浮点数类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
double object_get_prop_double (object_t* obj, const char* name, double defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | double | 返回指定属性的浮点数类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | double | 缺省值。 |
|
||||
#### object\_get\_prop\_float 函数
|
||||
-----------------------
|
||||
|
||||
@ -461,6 +500,90 @@ int32_t object_get_prop_int_by_path (object_t* obj, const char* path, int32_t de
|
||||
| obj | object\_t* | object对象。 |
|
||||
| path | const char* | 属性的path。 |
|
||||
| defval | int32\_t | 缺省值。 |
|
||||
#### object\_get\_prop\_int16 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_get_prop_int16">获取指定属性的int16类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int16_t object_get_prop_int16 (object_t* obj, const char* name, int16_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int16\_t | 返回指定属性的int16类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | int16\_t | 缺省值。 |
|
||||
#### object\_get\_prop\_int32 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_get_prop_int32">获取指定属性的int32类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t object_get_prop_int32 (object_t* obj, const char* name, int32_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回指定属性的int32类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | int32\_t | 缺省值。 |
|
||||
#### object\_get\_prop\_int64 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_get_prop_int64">获取指定属性的int64类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int64_t object_get_prop_int64 (object_t* obj, const char* name, int64_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int64\_t | 返回指定属性的int64类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | int64\_t | 缺省值。 |
|
||||
#### object\_get\_prop\_int8 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_get_prop_int8">获取指定属性的int8类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int8_t object_get_prop_int8 (object_t* obj, const char* name, int8_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int8\_t | 返回指定属性的int8类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | int8\_t | 缺省值。 |
|
||||
#### object\_get\_prop\_object 函数
|
||||
-----------------------
|
||||
|
||||
@ -581,6 +704,90 @@ const char* object_get_prop_str_by_path (object_t* obj, const char* path);
|
||||
| 返回值 | const char* | 返回指定属性的字符串类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| path | const char* | 属性的path。 |
|
||||
#### object\_get\_prop\_uint16 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_get_prop_uint16">获取指定属性的uint16类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint16_t object_get_prop_uint16 (object_t* obj, const char* name, uint16_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint16\_t | 返回指定属性的uint16类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | uint16\_t | 缺省值。 |
|
||||
#### object\_get\_prop\_uint32 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_get_prop_uint32">获取指定属性的uint32类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t object_get_prop_uint32 (object_t* obj, const char* name, uint32_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回指定属性的uint32类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | uint32\_t | 缺省值。 |
|
||||
#### object\_get\_prop\_uint64 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_get_prop_uint64">获取指定属性的uint64类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint64_t object_get_prop_uint64 (object_t* obj, const char* name, uint64_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint64\_t | 返回指定属性的uint64类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | uint64\_t | 缺省值。 |
|
||||
#### object\_get\_prop\_uint8 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_get_prop_uint8">获取指定属性的uint8类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint8_t object_get_prop_uint8 (object_t* obj, const char* name, uint8_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint8\_t | 返回指定属性的uint8类型的值。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| defval | uint8\_t | 缺省值。 |
|
||||
#### object\_get\_size 函数
|
||||
-----------------------
|
||||
|
||||
@ -840,6 +1047,27 @@ ret_t object_set_prop_by_path (object_t* obj, const char* path, value_t* value);
|
||||
| obj | object\_t* | object对象。 |
|
||||
| path | const char* | 属性的path。 |
|
||||
| value | value\_t* | 属性的值。 |
|
||||
#### object\_set\_prop\_double 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_set_prop_double">设置指定属性的浮点数类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_set_prop_double (object_t* obj, const char* name, double value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| value | double | 属性的值。 |
|
||||
#### object\_set\_prop\_float 函数
|
||||
-----------------------
|
||||
|
||||
@ -924,6 +1152,90 @@ ret_t object_set_prop_int_by_path (object_t* obj, const char* path, int32_t valu
|
||||
| obj | object\_t* | object对象。 |
|
||||
| path | const char* | 属性的path。 |
|
||||
| value | int32\_t | 属性的值。 |
|
||||
#### object\_set\_prop\_int16 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_set_prop_int16">设置指定属性的int16类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_set_prop_int16 (object_t* obj, const char* name, int16_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| value | int16\_t | 属性的值。 |
|
||||
#### object\_set\_prop\_int32 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_set_prop_int32">设置指定属性的int32类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_set_prop_int32 (object_t* obj, const char* name, int32_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| value | int32\_t | 属性的值。 |
|
||||
#### object\_set\_prop\_int64 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_set_prop_int64">设置指定属性的int64类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_set_prop_int64 (object_t* obj, const char* name, int64_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| value | int64\_t | 属性的值。 |
|
||||
#### object\_set\_prop\_int8 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_set_prop_int8">设置指定属性的int8类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_set_prop_int8 (object_t* obj, const char* name, int8_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| value | int8\_t | 属性的值。 |
|
||||
#### object\_set\_prop\_object 函数
|
||||
-----------------------
|
||||
|
||||
@ -1050,6 +1362,90 @@ ret_t object_set_prop_str_by_path (object_t* obj, const char* path, const char*
|
||||
| obj | object\_t* | object对象。 |
|
||||
| path | const char* | 属性的path。 |
|
||||
| value | const char* | 属性的值。 |
|
||||
#### object\_set\_prop\_uint16 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_set_prop_uint16">设置指定属性的uint16类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_set_prop_uint16 (object_t* obj, const char* name, uint16_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| value | uint16\_t | 属性的值。 |
|
||||
#### object\_set\_prop\_uint32 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_set_prop_uint32">设置指定属性的uint32类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_set_prop_uint32 (object_t* obj, const char* name, uint32_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| value | uint32\_t | 属性的值。 |
|
||||
#### object\_set\_prop\_uint64 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_set_prop_uint64">设置指定属性的uint64类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_set_prop_uint64 (object_t* obj, const char* name, uint64_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| value | uint64\_t | 属性的值。 |
|
||||
#### object\_set\_prop\_uint8 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_object_set_prop_uint8">设置指定属性的uint8类型的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_set_prop_uint8 (object_t* obj, const char* name, uint8_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | object对象。 |
|
||||
| name | const char* | 属性的名称。 |
|
||||
| value | uint8\_t | 属性的值。 |
|
||||
#### object\_unref 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -30,6 +30,7 @@ rbuffer_read_string(&rbuffer, &str);
|
||||
| <a href="#rbuffer_t_rbuffer_read_binary">rbuffer\_read\_binary</a> | 读取指定长度的二进制数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_double">rbuffer\_read\_double</a> | 读取double数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_float">rbuffer\_read\_float</a> | 读取float数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_int32">rbuffer\_read\_int32</a> | 读取int32数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_string">rbuffer\_read\_string</a> | 读取字符串。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_uint16">rbuffer\_read\_uint16</a> | 读取uint16数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_uint32">rbuffer\_read\_uint32</a> | 读取uint32数据。 |
|
||||
@ -206,6 +207,26 @@ ret_t rbuffer_read_float (rbuffer_t* rbuffer, float* value);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rbuffer | rbuffer\_t* | rbuffer对象。 |
|
||||
| value | float* | 返回读取的数据。 |
|
||||
#### rbuffer\_read\_int32 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="rbuffer_t_rbuffer_read_int32">读取int32数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t rbuffer_read_int32 (rbuffer_t* rbuffer, int32_t* value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rbuffer | rbuffer\_t* | rbuffer对象。 |
|
||||
| value | int32\_t* | 返回读取的数据。 |
|
||||
#### rbuffer\_read\_string 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -66,7 +66,6 @@ widget_set_self_layout_params(rich_text, "center", "middle", "100%", "100%");
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#rich_text_t_line_gap">line\_gap</a> | uint32\_t | 行间距。 |
|
||||
| <a href="#rich_text_t_margin">margin</a> | uint32\_t | 边距。 |
|
||||
| <a href="#rich_text_t_need_reset">need\_reset</a> | bool\_t | 标识控件是否需要重新绘图。 |
|
||||
| <a href="#rich_text_t_yoffset">yoffset</a> | int32\_t | y偏移。 |
|
||||
| <a href="#rich_text_t_yslidable">yslidable</a> | bool\_t | 标识控件是否允许上下拖动。 |
|
||||
@ -158,22 +157,6 @@ ret_t rich_text_set_yslidable (widget_t* widget, bool_t yslidable);
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### margin 属性
|
||||
-----------------------
|
||||
> <p id="rich_text_t_margin">边距。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -44,7 +44,10 @@ widget_t* scroll_view = scroll_view_create(win, 0, 0, 0, 0);
|
||||
| <a href="#scroll_view_t_scroll_view_create">scroll\_view\_create</a> | 创建scroll_view对象 |
|
||||
| <a href="#scroll_view_t_scroll_view_scroll_delta_to">scroll\_view\_scroll\_delta\_to</a> | 滚动到指定的偏移量。 |
|
||||
| <a href="#scroll_view_t_scroll_view_scroll_to">scroll\_view\_scroll\_to</a> | 滚动到指定的偏移量。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_move_to_page">scroll\_view\_set\_move\_to\_page</a> | 设置滚动时是否每次翻一页 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_offset">scroll\_view\_set\_offset</a> | 设置偏移量。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_recursive">scroll\_view\_set\_recursive</a> | 设置是否递归查找全部子控件。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_recursive_only">scroll\_view\_set\_recursive\_only</a> | 设置是否递归查找全部子控件。(不触发repaint和relayout)。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_snap_to_page">scroll\_view\_set\_snap\_to\_page</a> | 设置滚动时offset是否按页面对齐。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_speed_scale">scroll\_view\_set\_speed\_scale</a> | 设置偏移速度比例。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_virtual_h">scroll\_view\_set\_virtual\_h</a> | 设置虚拟高度。 |
|
||||
@ -56,6 +59,8 @@ widget_t* scroll_view = scroll_view_create(win, 0, 0, 0, 0);
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#scroll_view_t_move_to_page">move\_to\_page</a> | bool\_t | 是否每次翻一页（当 move_to_page 为ture 的时候才有效果，主要用于区分一次翻一页还是一次翻多页）。 |
|
||||
| <a href="#scroll_view_t_recursive">recursive</a> | bool\_t | 是否递归查找全部子控件。 |
|
||||
| <a href="#scroll_view_t_snap_to_page">snap\_to\_page</a> | bool\_t | 滚动时offset是否按页面对齐。 |
|
||||
| <a href="#scroll_view_t_virtual_h">virtual\_h</a> | wh\_t | 虚拟高度。 |
|
||||
| <a href="#scroll_view_t_virtual_w">virtual\_w</a> | wh\_t | 虚拟宽度。 |
|
||||
@ -159,6 +164,27 @@ ret_t scroll_view_scroll_to (widget_t* widget, int32_t xoffset_end, int32_t yoff
|
||||
| xoffset\_end | int32\_t | x偏移量。 |
|
||||
| yoffset\_end | int32\_t | y偏移量。 |
|
||||
| duration | int32\_t | 时间。 |
|
||||
#### scroll\_view\_set\_move\_to\_page 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="scroll_view_t_scroll_view_set_move_to_page">设置滚动时是否每次翻一页
|
||||
备注：当 snap_to_page 为ture 的时候才有效果，主要用于区分一次翻一页还是一次翻多页。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t scroll_view_set_move_to_page (widget_t* widget, bool_t move_to_page);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| move\_to\_page | bool\_t | 是否每次翻一页。 |
|
||||
#### scroll\_view\_set\_offset 函数
|
||||
-----------------------
|
||||
|
||||
@ -180,6 +206,46 @@ ret_t scroll_view_set_offset (widget_t* widget, int32_t xoffset, int32_t yoffset
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| xoffset | int32\_t | x偏移量。 |
|
||||
| yoffset | int32\_t | y偏移量。 |
|
||||
#### scroll\_view\_set\_recursive 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="scroll_view_t_scroll_view_set_recursive">设置是否递归查找全部子控件。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t scroll_view_set_recursive (widget_t* widget, bool_t recursive);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| recursive | bool\_t | 是否递归查找全部子控件。 |
|
||||
#### scroll\_view\_set\_recursive\_only 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="scroll_view_t_scroll_view_set_recursive_only">设置是否递归查找全部子控件。(不触发repaint和relayout)。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t scroll_view_set_recursive_only (widget_t* widget, bool_t recursive);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| recursive | bool\_t | 是否递归查找全部子控件。 |
|
||||
#### scroll\_view\_set\_snap\_to\_page 函数
|
||||
-----------------------
|
||||
|
||||
@ -301,6 +367,38 @@ ret_t scroll_view_set_yslidable (widget_t* widget, bool_t yslidable);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| yslidable | bool\_t | 是否允许滑动。 |
|
||||
#### move\_to\_page 属性
|
||||
-----------------------
|
||||
> <p id="scroll_view_t_move_to_page">是否每次翻一页（当 move_to_page 为ture 的时候才有效果，主要用于区分一次翻一页还是一次翻多页）。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### recursive 属性
|
||||
-----------------------
|
||||
> <p id="scroll_view_t_recursive">是否递归查找全部子控件。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### snap\_to\_page 属性
|
||||
-----------------------
|
||||
> <p id="scroll_view_t_snap_to_page">滚动时offset是否按页面对齐。
|
||||
|
||||
@ -33,6 +33,7 @@ slist_destroy(slist);
|
||||
| <a href="#slist_t_slist_foreach">slist\_foreach</a> | 遍历元素。 |
|
||||
| <a href="#slist_t_slist_head_pop">slist\_head\_pop</a> | 弹出第一个元素。 |
|
||||
| <a href="#slist_t_slist_init">slist\_init</a> | 初始化slist对象 |
|
||||
| <a href="#slist_t_slist_insert">slist\_insert</a> | 插入一个元素。 |
|
||||
| <a href="#slist_t_slist_prepend">slist\_prepend</a> | 在头部追加一个元素。 |
|
||||
| <a href="#slist_t_slist_remove">slist\_remove</a> | 删除第一个满足条件的元素。 |
|
||||
| <a href="#slist_t_slist_remove_all">slist\_remove\_all</a> | 删除全部元素。 |
|
||||
@ -225,6 +226,27 @@ slist_t* slist_init (slist_t* slist, tk_destroy_t destroy, tk_compare_t compare)
|
||||
| slist | slist\_t* | 单向链表对象。 |
|
||||
| destroy | tk\_destroy\_t | 元素销毁函数。 |
|
||||
| compare | tk\_compare\_t | 元素比较函数。 |
|
||||
#### slist\_insert 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="slist_t_slist_insert">插入一个元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t slist_insert (slist_t* slist, uint32_t index, void* data);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| slist | slist\_t* | 单向链表对象。 |
|
||||
| index | uint32\_t | 位置序数。 |
|
||||
| data | void* | 待追加的元素。 |
|
||||
#### slist\_prepend 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -37,6 +37,7 @@ str_reset(&s);
|
||||
| <a href="#str_t_str_decode_xml_entity">str\_decode\_xml\_entity</a> | 对XML基本的entity进行解码，目前仅支持<>"a;&。 |
|
||||
| <a href="#str_t_str_decode_xml_entity_with_len">str\_decode\_xml\_entity\_with\_len</a> | 对XML基本的entity进行解码，目前仅支持<>"a;&。 |
|
||||
| <a href="#str_t_str_encode_hex">str\_encode\_hex</a> | 把二进制的数据编码成16进制格式的字符串。 |
|
||||
| <a href="#str_t_str_encode_hex">str\_encode\_hex</a> | 把16进制格式的字符串解码成字符串。 |
|
||||
| <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_expand_vars">str\_expand\_vars</a> | 将字符串中的变量展开为obj中对应的属性值。 |
|
||||
@ -392,6 +393,27 @@ ret_t str_encode_hex (str_t* str, const uint8_t* data, uint32_t size, const char
|
||||
| data | const uint8\_t* | 数据。 |
|
||||
| size | uint32\_t | 数据长度。 |
|
||||
| format | const char* | 格式(如:"%02x" 表示生成小写) |
|
||||
#### str\_encode\_hex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="str_t_str_encode_hex">把16进制格式的字符串解码成字符串。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t str_encode_hex (str_t* str, uint8_t* data, uint32_t size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| str | str\_t* | str对象。 |
|
||||
| data | uint8\_t* | 数据缓存区(返回)。 |
|
||||
| size | uint32\_t | 数据最大长度。 |
|
||||
#### str\_end\_with 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -40,7 +40,7 @@ style_factory_t* style_factory ();
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
style_t* style_factory_create_style (style_factory_t* factory, widget_t* widget);
|
||||
style_t* style_factory_create_style (style_factory_t* factory, const char* style_type);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -49,7 +49,7 @@ style_t* style_factory_create_style (style_factory_t* factory, widget_t* widget)
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | style\_t* | 返回style对象。 |
|
||||
| factory | style\_factory\_t* | factory对象。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| style\_type | const char* | style类型。 |
|
||||
#### style\_factory\_set 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -16,9 +16,10 @@ style\_mutable也对style\_const进行了包装，当用户没修改某个值时
|
||||
| <a href="#style_mutable_t_style_mutable_create">style\_mutable\_create</a> | 创建style\_mutable对象。 |
|
||||
| <a href="#style_mutable_t_style_mutable_foreach">style\_mutable\_foreach</a> | 遍历。对每项调用回调函数on\_style\_item。 |
|
||||
| <a href="#style_mutable_t_style_mutable_get_value">style\_mutable\_get\_value</a> | 获取指定名称的值。 |
|
||||
| <a href="#style_mutable_t_style_mutable_register">style\_mutable\_register</a> | 将自己注册到style\_factory。 |
|
||||
| <a href="#style_mutable_t_style_mutable_remove_value">style\_mutable\_remove\_value</a> | 移除指定名称的值。 |
|
||||
| <a href="#style_mutable_t_style_mutable_reset">style\_mutable\_reset</a> | 清空s对象。 |
|
||||
| <a href="#style_mutable_t_style_mutable_set_color">style\_mutable\_set\_color</a> | 设置指定名称的颜色值。 |
|
||||
| <a href="#style_mutable_t_style_mutable_set_default_style">style\_mutable\_set\_default\_style</a> | 设置 style\_mutable 对象的 default\_style 成员，并且释放原来的 default\_style 成员对象 |
|
||||
| <a href="#style_mutable_t_style_mutable_set_int">style\_mutable\_set\_int</a> | 设置指定名称整数格式的值。 |
|
||||
| <a href="#style_mutable_t_style_mutable_set_name">style\_mutable\_set\_name</a> | 设置style的名称。 |
|
||||
| <a href="#style_mutable_t_style_mutable_set_str">style\_mutable\_set\_str</a> | 设置指定名称字符串的值。 |
|
||||
@ -80,7 +81,7 @@ ret_t style_mutable_copy (style_t* s, style_t* other);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
style_t* style_mutable_create (widget_t* widget, style_t* default_style);
|
||||
style_t* style_mutable_create (style_t* default_style);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -88,7 +89,6 @@ style_t* style_mutable_create (widget_t* widget, style_t* default_style);
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | style\_t* | style对象。 |
|
||||
| widget | widget\_t* | 控件 |
|
||||
| default\_style | style\_t* | 缺省的style。 |
|
||||
#### style\_mutable\_foreach 函数
|
||||
-----------------------
|
||||
@ -133,17 +133,21 @@ ret_t style_mutable_get_value (style_t* s, const char* state, const char* name,
|
||||
| state | const char* | 控件状态。 |
|
||||
| name | const char* | 属性名。 |
|
||||
| v | const value\_t* | 值。 |
|
||||
#### style\_mutable\_register 函数
|
||||
#### style\_mutable\_remove\_value 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="style_mutable_t_style_mutable_register">将自己注册到style\_factory。
|
||||
> <p id="style_mutable_t_style_mutable_remove_value">移除指定名称的值。
|
||||
备注：
|
||||
如果 state 控件状态为 NULL，name 属性名为 NULL，就清除所有的 mutable 风格。
|
||||
如果 state 控件状态为 NULL，name 属性名不为 NULL，清除 state 状态为 normal 的 name 属性。
|
||||
如果 state 控件状态不为 NULL，name 属性名为 NULL，就清除所有的 state 状态的风格。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t style_mutable_register ();
|
||||
ret_t style_mutable_remove_value (style_t* s, const char* state, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -151,6 +155,9 @@ ret_t style_mutable_register ();
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| s | style\_t* | style对象。 |
|
||||
| state | const char* | 控件状态。 |
|
||||
| name | const char* | 属性名。 |
|
||||
#### style\_mutable\_reset 函数
|
||||
-----------------------
|
||||
|
||||
@ -192,6 +199,26 @@ ret_t style_mutable_set_color (style_t* s, const char* state, const char* name,
|
||||
| state | const char* | 控件状态。 |
|
||||
| name | const char* | 属性名。 |
|
||||
| val | color\_t | 值。 |
|
||||
#### style\_mutable\_set\_default\_style 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="style_mutable_t_style_mutable_set_default_style">设置 style\_mutable 对象的 default\_style 成员，并且释放原来的 default\_style 成员对象
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t style_mutable_set_default_style (style_t* s, style_t* default_style);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| s | style\_t* | style对象。 |
|
||||
| default\_style | style\_t* | 缺省的style。 |
|
||||
#### style\_mutable\_set\_int 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -22,11 +22,16 @@ uint16_t font_size = style_get_int(style, STYLE_ID_FONT_SIZE, TK_DEFAULT_FONT_SI
|
||||
| <a href="#style_t_style_get_color">style\_get\_color</a> | 获取指定name的颜色值。 |
|
||||
| <a href="#style_t_style_get_int">style\_get\_int</a> | 获取指定name的整数格式的值。 |
|
||||
| <a href="#style_t_style_get_str">style\_get\_str</a> | 获取指定name的字符串格式的值。 |
|
||||
| <a href="#style_t_style_get_style_state">style\_get\_style\_state</a> | 获取风格对象的风格状态 |
|
||||
| <a href="#style_t_style_get_style_type">style\_get\_style\_type</a> | 获取 style 的风格类型。 |
|
||||
| <a href="#style_t_style_get_uint">style\_get\_uint</a> | 获取指定name的无符号整数格式的值。 |
|
||||
| <a href="#style_t_style_is_mutable">style\_is\_mutable</a> | 检查style是否是mutable的。 |
|
||||
| <a href="#style_t_style_is_valid">style\_is\_valid</a> | 检查style对象是否有效 |
|
||||
| <a href="#style_t_style_normalize_value">style\_normalize\_value</a> | 对值进行正规化。 |
|
||||
| <a href="#style_t_style_notify_widget_state_changed">style\_notify\_widget\_state\_changed</a> | widget状态改变时，通知style更新数据。 |
|
||||
| <a href="#style_t_style_set">style\_set</a> | 设置指定状态的指定属性的值(仅仅对mutable的style有效)。 |
|
||||
| <a href="#style_t_style_set_style_data">style\_set\_style\_data</a> | 把风格对象数据设置到风格对象中 |
|
||||
| <a href="#style_t_style_update_state">style\_update\_state</a> | 更新风格对象的状态以及对应的数据 |
|
||||
#### style\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
@ -109,6 +114,65 @@ const char* style_get_str (style_t* s, const char* name, const char* defval);
|
||||
| s | style\_t* | style对象。 |
|
||||
| name | const char* | 属性名。 |
|
||||
| defval | const char* | 缺省值。 |
|
||||
#### style\_get\_style\_state 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="style_t_style_get_style_state">获取风格对象的风格状态
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* style_get_style_state (style_t* s);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回风格状态。 |
|
||||
| s | style\_t* | style对象。 |
|
||||
#### style\_get\_style\_type 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="style_t_style_get_style_type">获取 style 的风格类型。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* style_get_style_type (style_t* s);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回风格类型。 |
|
||||
| s | style\_t* | style对象。 |
|
||||
#### style\_get\_uint 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="style_t_style_get_uint">获取指定name的无符号整数格式的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t style_get_uint (style_t* s, const char* name, uint32_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回无符号整数格式的值。 |
|
||||
| s | style\_t* | style对象。 |
|
||||
| name | const char* | 属性名。 |
|
||||
| defval | uint32\_t | 缺省值。 |
|
||||
#### style\_is\_mutable 函数
|
||||
-----------------------
|
||||
|
||||
@ -210,3 +274,48 @@ ret_t style_set (style_t* s, const char* state, const char* name, const value_t*
|
||||
| state | const char* | 状态。 |
|
||||
| name | const char* | 属性名。 |
|
||||
| value | const value\_t* | 值。 |
|
||||
#### style\_set\_style\_data 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="style_t_style_set_style_data">把风格对象数据设置到风格对象中
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t style_set_style_data (style_t* s, const uint8_t* data, const char* state);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| s | style\_t* | style对象。 |
|
||||
| data | const uint8\_t* | 风格对象数据 |
|
||||
| state | const char* | 风格状态 |
|
||||
#### style\_update\_state 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="style_t_style_update_state">更新风格对象的状态以及对应的数据
|
||||
备注：根据 widget_type 和 style_name 以及 widget_state 在 theme 对象中查找对应的数据并且更新到 style 对象中
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t style_update_state (style_t* s, theme_t* theme, const char* widget_type, const char* style_name, const char* widget_state);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| s | style\_t* | style对象。 |
|
||||
| theme | theme\_t* | theme对象。 |
|
||||
| widget\_type | const char* | 控件的类型名。 |
|
||||
| style\_name | const char* | style的名称。 |
|
||||
| widget\_state | const char* | 控件的状态。 |
|
||||
|
||||
@ -603,7 +603,7 @@ ret_t text_edit_set_select (text_edit_t* text_edit, uint32_t start, uint32_t end
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t text_edit_set_tips (text_edit_t* text_edit, const char* tips);
|
||||
ret_t text_edit_set_tips (text_edit_t* text_edit, const char* tips, bool_t mlines);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -613,6 +613,7 @@ ret_t text_edit_set_tips (text_edit_t* text_edit, const char* tips);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| text\_edit | text\_edit\_t* | text\_edit对象。 |
|
||||
| tips | const char* | 提示信息。 |
|
||||
| mlines | bool\_t | 提示信息是否多行显示。 |
|
||||
#### text\_edit\_set\_wrap\_word 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -57,6 +57,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L4
|
||||
| <a href="#text_selector_t_text_selector_set_loop_options">text\_selector\_set\_loop\_options</a> | 设置是否循环选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_options">text\_selector\_set\_options</a> | 设置选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_range_options">text\_selector\_set\_range\_options</a> | 设置一系列的整数选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_range_options_ex">text\_selector\_set\_range\_options\_ex</a> | 设置一系列的整数选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_selected_index">text\_selector\_set\_selected\_index</a> | 设置第index个选项为当前选中的选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_text">text\_selector\_set\_text</a> | 设置text_selector的文本。 |
|
||||
| <a href="#text_selector_t_text_selector_set_value">text\_selector\_set\_value</a> | 设置text_selector的值。 |
|
||||
@ -321,6 +322,29 @@ ret_t text_selector_set_range_options (widget_t* widget, int32_t start, uint32_t
|
||||
| start | int32\_t | 起始值。 |
|
||||
| nr | uint32\_t | 个数。 |
|
||||
| step | int32\_t | 步长。 |
|
||||
#### text\_selector\_set\_range\_options\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="text_selector_t_text_selector_set_range_options_ex">设置一系列的整数选项。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t text_selector_set_range_options_ex (widget_t* widget, int32_t start, uint32_t nr, int32_t step, const char* format);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | text\_selector对象。 |
|
||||
| start | int32\_t | 起始值。 |
|
||||
| nr | uint32\_t | 个数。 |
|
||||
| step | int32\_t | 步长。 |
|
||||
| format | const char* | 选项的格式化。 |
|
||||
#### text\_selector\_set\_selected\_index 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -10,12 +10,12 @@
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#theme_t_theme">theme</a> | 获取缺省的主题对象。 |
|
||||
| <a href="#theme_t_theme_create">theme\_create</a> | 创建主题对象。 |
|
||||
| <a href="#theme_t_theme_deinit">theme\_deinit</a> | 析构主题对象。 |
|
||||
| <a href="#theme_t_theme_default_create">theme\_default\_create</a> | 创建主题对象。 |
|
||||
| <a href="#theme_t_theme_destroy">theme\_destroy</a> | 析构并释放主题对象。 |
|
||||
| <a href="#theme_t_theme_find_style">theme\_find\_style</a> | 查找满足条件的style。 |
|
||||
| <a href="#theme_t_theme_init">theme\_init</a> | 初始化主题对象。 |
|
||||
| <a href="#theme_t_theme_get_style_type">theme\_get\_style\_type</a> | 获取主题的风格类型。 |
|
||||
| <a href="#theme_t_theme_set">theme\_set</a> | 设置缺省的主题对象。 |
|
||||
| <a href="#theme_t_theme_set_theme_data">theme\_set\_theme\_data</a> | 设置主题的数据。 |
|
||||
#### theme 函数
|
||||
-----------------------
|
||||
|
||||
@ -34,17 +34,17 @@ theme_t* theme ();
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | theme\_t* | 返回主题对象。 |
|
||||
#### theme\_create 函数
|
||||
#### theme\_default\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="theme_t_theme_create">创建主题对象。
|
||||
> <p id="theme_t_theme_default_create">创建主题对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
theme_t* theme_create (const uint8_t* data);
|
||||
theme_t* theme_default_create (const uint8_t* data);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -53,25 +53,6 @@ theme_t* theme_create (const uint8_t* data);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | theme\_t* | 返回主题对象。 |
|
||||
| data | const uint8\_t* | 主题数据。 |
|
||||
#### theme\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="theme_t_theme_deinit">析构主题对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t theme_deinit (theme_t* theme);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| theme | theme\_t* | 主题对象。 |
|
||||
#### theme\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
@ -101,38 +82,37 @@ ret_t theme_destroy (theme_t* theme);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
theme_t* theme_find_style (theme_t* data, const char* widget_type, const char* name, const char* widget_state);
|
||||
const uint8_t* theme_find_style (theme_t* theme, const char* widget_type, const char* name, const char* widget_state);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | theme\_t* | 返回主题对象。 |
|
||||
| data | theme\_t* | 主题对象。 |
|
||||
| 返回值 | const uint8\_t* | 返回风格对象数据。 |
|
||||
| theme | theme\_t* | 主题对象。 |
|
||||
| widget\_type | const char* | 控件的类型名。 |
|
||||
| name | const char* | style的名称。 |
|
||||
| widget\_state | const char* | 控件的状态。 |
|
||||
#### theme\_init 函数
|
||||
#### theme\_get\_style\_type 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="theme_t_theme_init">初始化主题对象。
|
||||
> <p id="theme_t_theme_get_style_type">获取主题的风格类型。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
theme_t* theme_init (theme_t* theme, const uint8_t* data);
|
||||
const char* theme_get_style_type (theme_t* theme);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | theme\_t* | 返回主题对象。 |
|
||||
| 返回值 | const char* | 返回风格类型。 |
|
||||
| theme | theme\_t* | 主题对象。 |
|
||||
| data | const uint8\_t* | 主题数据。 |
|
||||
#### theme\_set 函数
|
||||
-----------------------
|
||||
|
||||
@ -152,3 +132,23 @@ ret_t theme_set (theme_t* theme);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| theme | theme\_t* | 主题对象。 |
|
||||
#### theme\_set\_theme\_data 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="theme_t_theme_set_theme_data">设置主题的数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t theme_set_theme_data (theme_t* theme, const uint8_t* data);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| theme | theme\_t* | 主题对象。 |
|
||||
| data | const uint8\_t* | 主题数据。 |
|
||||
|
||||
@ -8,6 +8,7 @@
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <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指向的内存。 |
|
||||
| <a href="#utils_t_dummy_destroy">dummy\_destroy</a> | 空的destroy函数。 |
|
||||
| <a href="#utils_t_filename_to_name">filename\_to\_name</a> | 从完整文件名中获取文件名。 |
|
||||
@ -19,6 +20,7 @@
|
||||
| <a href="#utils_t_tk_atof">tk\_atof</a> | 将字符串转换为浮点类型。 |
|
||||
| <a href="#utils_t_tk_atoi">tk\_atoi</a> | 将字符串转换为整型数。 |
|
||||
| <a href="#utils_t_tk_atol">tk\_atol</a> | 将字符串转换为整型。 |
|
||||
| <a href="#utils_t_tk_atoul">tk\_atoul</a> | 将字符串转换为整型。 |
|
||||
| <a href="#utils_t_tk_ftoa">tk\_ftoa</a> | 将浮点型转换为字符串。 |
|
||||
| <a href="#utils_t_tk_is_valid_name">tk\_is\_valid\_name</a> | 判断是否是有效的属性名。 |
|
||||
| <a href="#utils_t_tk_itoa">tk\_itoa</a> | 将整型转换为字符串。 |
|
||||
@ -78,6 +80,26 @@ int compare_always_equal (const void* a, const void* b);
|
||||
| 返回值 | int | 始终返回0。 |
|
||||
| a | const void* | 数据a。 |
|
||||
| b | const void* | 数据b。 |
|
||||
#### data\_url\_copy 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_data_url_copy">将数据从源URL拷贝到目标URL。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t data_url_copy (const char* dst_url, const char* src_url);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dst\_url | const char* | 目标URL。 |
|
||||
| src\_url | const char* | 源URL。 |
|
||||
#### default\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
@ -288,14 +310,33 @@ int tk_atoi (const char* str);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int tk_atol (const char* str);
|
||||
int64_t tk_atol (const char* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回转换后的整型。 |
|
||||
| 返回值 | int64\_t | 返回转换后的整型。 |
|
||||
| str | const char* | 要转换为整型的字符串。 |
|
||||
#### tk\_atoul 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_atoul">将字符串转换为整型。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint64_t tk_atoul (const char* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint64\_t | 返回转换后的整型。 |
|
||||
| str | const char* | 要转换为整型的字符串。 |
|
||||
#### tk\_ftoa 函数
|
||||
-----------------------
|
||||
@ -563,7 +604,7 @@ int tk_snprintf (char* str, size_t size, const char* format);
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回格式化后的字符串长度+1。 |
|
||||
| 返回值 | int | 返回格式化后的字符串长度。 |
|
||||
| str | char* | 目标字符串。 |
|
||||
| size | size\_t | 拷贝字节数。 |
|
||||
| format | const char* | 格式化字符串。 |
|
||||
@ -930,7 +971,7 @@ int tk_vsnprintf (char* str, size_t size, const char* format, va_list ap);
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回格式化后的字符串长度+1。 |
|
||||
| 返回值 | int | 返回格式化后的字符串长度。 |
|
||||
| str | char* | 目标字符串。 |
|
||||
| size | size\_t | 拷贝字节数。 |
|
||||
| format | const char* | 格式化字符串。 |
|
||||
|
||||
@ -8,3 +8,4 @@
|
||||
| -------- | ------- |
|
||||
| VGCANVAS\_LINE\_CAP\_ROUND | 圆头。 |
|
||||
| VGCANVAS\_LINE\_CAP\_SQUARE | 方头。 |
|
||||
| VGCANVAS\_LINE\_CAP\_BUTT | 平头。 |
|
||||
|
||||
@ -43,17 +43,21 @@ vgcanvas_restore(vg);
|
||||
| <a href="#vgcanvas_t_vgcanvas_begin_frame">vgcanvas\_begin\_frame</a> | 开始绘制，系统内部调用。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_begin_path">vgcanvas\_begin\_path</a> | 清除之前的路径，并重新开始一条路径。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_bezier_to">vgcanvas\_bezier\_to</a> | 生成一条三次贝塞尔曲线。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_bind_fbo">vgcanvas\_bind\_fbo</a> | 绑定 fbo 对象。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_cast">vgcanvas\_cast</a> | 转换为vgcanvas对象(供脚本语言使用)。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_clear_cache">vgcanvas\_clear\_cache</a> | 释放vgcanvas对象的缓冲数据。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_clear_rect">vgcanvas\_clear\_rect</a> | 用颜色清除指定矩形区域。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_clip_rect">vgcanvas\_clip\_rect</a> | 矩形裁剪。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_close_path">vgcanvas\_close\_path</a> | 闭合路径。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_create">vgcanvas\_create</a> | 创建vgcanvas。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_create_fbo">vgcanvas\_create\_fbo</a> | 创建 fbo 对象。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_destroy">vgcanvas\_destroy</a> | 销毁vgcanvas对象。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_destroy_fbo">vgcanvas\_destroy\_fbo</a> | 销毁 fbo 对象。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_draw_icon">vgcanvas\_draw\_icon</a> | 绘制图标。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_draw_image">vgcanvas\_draw\_image</a> | 绘制图片。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_ellipse">vgcanvas\_ellipse</a> | 生成一个椭圆路径。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_end_frame">vgcanvas\_end\_frame</a> | 结束绘制。系统内部调用。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_fbo_to_bitmap">vgcanvas\_fbo\_to\_bitmap</a> | 把 fbo 对象的数据拷贝到 bitmap 中。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_fill">vgcanvas\_fill</a> | 填充多边形。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_fill_text">vgcanvas\_fill\_text</a> | 绘制文本。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_flush">vgcanvas\_flush</a> | flush |
|
||||
@ -99,6 +103,7 @@ vgcanvas_restore(vg);
|
||||
| <a href="#vgcanvas_t_vgcanvas_stroke">vgcanvas\_stroke</a> | 画线。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_transform">vgcanvas\_transform</a> | 变换矩阵。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_translate">vgcanvas\_translate</a> | 平移。 |
|
||||
| <a href="#vgcanvas_t_vgcanvas_unbind_fbo">vgcanvas\_unbind\_fbo</a> | 解开绑定 fbo 对象。 |
|
||||
### 属性
|
||||
<p id="vgcanvas_t_properties">
|
||||
|
||||
@ -233,6 +238,26 @@ ret_t vgcanvas_bezier_to (vgcanvas_t* vg, float_t cp1x, float_t cp1y, float_t cp
|
||||
| cp2y | float\_t | 控制点3y坐标。 |
|
||||
| x | float\_t | x坐标。 |
|
||||
| y | float\_t | y坐标。 |
|
||||
#### vgcanvas\_bind\_fbo 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vgcanvas_t_vgcanvas_bind_fbo">绑定 fbo 对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t vgcanvas_bind_fbo (vgcanvas_t* vg, framebuffer_object_t* fbo);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| vg | vgcanvas\_t* | vgcanvas对象。 |
|
||||
| fbo | framebuffer\_object\_t* | 需要创建 fbo 的对象。 |
|
||||
#### vgcanvas\_cast 函数
|
||||
-----------------------
|
||||
|
||||
@ -362,6 +387,29 @@ vgcanvas_t* vgcanvas_create (uint32_t w, uint32_t h, uint32_t stride, bitmap_for
|
||||
| stride | uint32\_t | 一行占用的字节数。 |
|
||||
| format | bitmap\_format\_t | 如果data是framebuffer，format指定data的格式。 |
|
||||
| data | void* | framebuffer或其它ctx。 |
|
||||
#### vgcanvas\_create\_fbo 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vgcanvas_t_vgcanvas_create_fbo">创建 fbo 对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t vgcanvas_create_fbo (vgcanvas_t* vg, uint32_t w, uint32_t h, bool_t custom_draw_model, framebuffer_object_t* fbo);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| vg | vgcanvas\_t* | vgcanvas对象。 |
|
||||
| w | uint32\_t | fbo 对象的宽。 |
|
||||
| h | uint32\_t | fbo 对象的高。 |
|
||||
| custom\_draw\_model | bool\_t | 是否脱离 awtk 默认的 OpenGL 绘图方法。 |
|
||||
| fbo | framebuffer\_object\_t* | 需要创建 fbo 的对象。 |
|
||||
#### vgcanvas\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
@ -381,6 +429,26 @@ ret_t vgcanvas_destroy (vgcanvas_t* vg);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| vg | vgcanvas\_t* | vgcanvas对象。 |
|
||||
#### vgcanvas\_destroy\_fbo 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vgcanvas_t_vgcanvas_destroy_fbo">销毁 fbo 对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t vgcanvas_destroy_fbo (vgcanvas_t* vg, framebuffer_object_t* fbo);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| vg | vgcanvas\_t* | vgcanvas对象。 |
|
||||
| fbo | framebuffer\_object\_t* | 需要创建 fbo 的对象。 |
|
||||
#### vgcanvas\_draw\_icon 函数
|
||||
-----------------------
|
||||
|
||||
@ -481,6 +549,28 @@ ret_t vgcanvas_end_frame (vgcanvas_t* vg);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| vg | vgcanvas\_t* | vgcanvas对象。 |
|
||||
#### vgcanvas\_fbo\_to\_bitmap 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vgcanvas_t_vgcanvas_fbo_to_bitmap">把 fbo 对象的数据拷贝到 bitmap 中。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t vgcanvas_fbo_to_bitmap (vgcanvas_t* vg, framebuffer_object_t* fbo, bitmap_t* img, const rect_t* r);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| vg | vgcanvas\_t* | vgcanvas对象。 |
|
||||
| fbo | framebuffer\_object\_t* | 需要创建 fbo 的对象。 |
|
||||
| img | bitmap\_t* | 输出的 bitmap 的对象。 |
|
||||
| r | const rect\_t* | 需要拷贝的区域。 |
|
||||
#### vgcanvas\_fill 函数
|
||||
-----------------------
|
||||
|
||||
@ -1450,6 +1540,26 @@ ret_t vgcanvas_translate (vgcanvas_t* vg, float_t x, float_t y);
|
||||
| vg | vgcanvas\_t* | vgcanvas对象。 |
|
||||
| x | float\_t | x方向偏移。 |
|
||||
| y | float\_t | y方向偏移。 |
|
||||
#### vgcanvas\_unbind\_fbo 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vgcanvas_t_vgcanvas_unbind_fbo">解开绑定 fbo 对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t vgcanvas_unbind_fbo (vgcanvas_t* vg, framebuffer_object_t* fbo);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| vg | vgcanvas\_t* | vgcanvas对象。 |
|
||||
| fbo | framebuffer\_object\_t* | 需要创建 fbo 的对象。 |
|
||||
#### anti\_alias 属性
|
||||
-----------------------
|
||||
> <p id="vgcanvas_t_anti_alias">是否启用反走样功能。
|
||||
|
||||
@ -42,6 +42,7 @@ wbuffer_deinit(&wbuffer);
|
||||
| <a href="#wbuffer_t_wbuffer_write_binary">wbuffer\_write\_binary</a> | 写入指定长度的二进制数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_double">wbuffer\_write\_double</a> | 写入double数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_float">wbuffer\_write\_float</a> | 写入float数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_int32">wbuffer\_write\_int32</a> | 写入int32数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_string">wbuffer\_write\_string</a> | 写入字符串。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_uint16">wbuffer\_write\_uint16</a> | 写入uint16数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_uint32">wbuffer\_write\_uint32</a> | 写入uint32数据。 |
|
||||
@ -254,6 +255,26 @@ ret_t wbuffer_write_float (wbuffer_t* wbuffer, float value);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| wbuffer | wbuffer\_t* | wbuffer对象。 |
|
||||
| value | float | 要写入的数据。 |
|
||||
#### wbuffer\_write\_int32 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wbuffer_t_wbuffer_write_int32">写入int32数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t wbuffer_write_int32 (wbuffer_t* wbuffer, int32_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| wbuffer | wbuffer\_t* | wbuffer对象。 |
|
||||
| value | int32\_t | 要写入的数据。 |
|
||||
#### wbuffer\_write\_string 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -11,6 +11,12 @@
|
||||
| WIDGET\_PROP\_Y | Y坐标。 |
|
||||
| WIDGET\_PROP\_W | 宽度。 |
|
||||
| WIDGET\_PROP\_H | 高度。 |
|
||||
| WIDGET\_PROP\_DESIGN\_W | 窗口设计时宽度。 |
|
||||
| WIDGET\_PROP\_DESIGN\_H | 窗口设计时宽度。 |
|
||||
| WIDGET\_PROP\_AUTO\_SCALE\_CHILDREN\_X | 窗口大小与设计时大小不同时，是否自动调整子控件的x坐标。 |
|
||||
| WIDGET\_PROP\_AUTO\_SCALE\_CHILDREN\_Y | 窗口大小与设计时大小不同时，是否自动调整子控件的y坐标。 |
|
||||
| WIDGET\_PROP\_AUTO\_SCALE\_CHILDREN\_W | 窗口大小与设计时大小不同时，是否自动调整子控件的宽度。 |
|
||||
| WIDGET\_PROP\_AUTO\_SCALE\_CHILDREN\_H | 窗口大小与设计时大小不同时，是否自动调整子控件的高度。 |
|
||||
| WIDGET\_PROP\_INPUTING | inputing。 |
|
||||
| WIDGET\_PROP\_ALWAYS\_ON\_TOP | always on top。 |
|
||||
| WIDGET\_PROP\_CARET\_X | caret x。 |
|
||||
|
||||
@ -101,12 +101,14 @@ widget_on(button, EVT_CLICK, on_click, NULL);
|
||||
| <a href="#widget_t_widget_get_prop_pointer">widget\_get\_prop\_pointer</a> | 获取指针格式的属性。 |
|
||||
| <a href="#widget_t_widget_get_prop_str">widget\_get\_prop\_str</a> | 获取字符串格式的属性。 |
|
||||
| <a href="#widget_t_widget_get_state_for_style">widget\_get\_state\_for\_style</a> | 把控件的状态转成获取style选要的状态，一般只在子类中使用。 |
|
||||
| <a href="#widget_t_widget_get_style_type">widget\_get\_style\_type</a> | 获取 widget 对应风格类型 |
|
||||
| <a href="#widget_t_widget_get_text">widget\_get\_text</a> | 获取控件的文本。 |
|
||||
| <a href="#widget_t_widget_get_text_utf8">widget\_get\_text\_utf8</a> | 获取控件的文本。 |
|
||||
| <a href="#widget_t_widget_get_type">widget\_get\_type</a> | 获取当前控件的类型名称。 |
|
||||
| <a href="#widget_t_widget_get_value">widget\_get\_value</a> | 获取控件的值。只是对widget\_get\_prop的包装，值的意义由子类控件决定。 |
|
||||
| <a href="#widget_t_widget_get_window">widget\_get\_window</a> | 获取当前控件所在的窗口。 |
|
||||
| <a href="#widget_t_widget_get_window_manager">widget\_get\_window\_manager</a> | 获取当前的窗口管理器。 |
|
||||
| <a href="#widget_t_widget_get_window_theme">widget\_get\_window\_theme</a> | 获取控件的窗口主题 |
|
||||
| <a href="#widget_t_widget_grab">widget\_grab</a> | 让指定子控件抓住事件。 |
|
||||
| <a href="#widget_t_widget_index_of">widget\_index\_of</a> | 获取控件在父控件中的索引编号。 |
|
||||
| <a href="#widget_t_widget_init">widget\_init</a> | 初始化控件。仅在子类控件构造函数中使用。 |
|
||||
@ -119,11 +121,13 @@ widget_on(button, EVT_CLICK, on_click, NULL);
|
||||
| <a href="#widget_t_widget_is_instance_of">widget\_is\_instance\_of</a> | 检查控件是否是指定的类型。 |
|
||||
| <a href="#widget_t_widget_is_keyboard">widget\_is\_keyboard</a> | 判断当前控件是否是keyboard。 |
|
||||
| <a href="#widget_t_widget_is_normal_window">widget\_is\_normal\_window</a> | 检查控件是否是普通窗口类型。 |
|
||||
| <a href="#widget_t_widget_is_opened_dialog">widget\_is\_opened\_dialog</a> | 检查控件弹出对话框控件是否已经打开了（而非挂起状态）。 |
|
||||
| <a href="#widget_t_widget_is_opened_popup">widget\_is\_opened\_popup</a> | 检查控件弹出窗口控件是否已经打开了（而非挂起状态）。 |
|
||||
| <a href="#widget_t_widget_is_overlay">widget\_is\_overlay</a> | 检查控件是否是overlay窗口类型。 |
|
||||
| <a href="#widget_t_widget_is_parent_of">widget\_is\_parent\_of</a> | 判断当前控件是否是指定控件的父控件(包括非直系)。 |
|
||||
| <a href="#widget_t_widget_is_point_in">widget\_is\_point\_in</a> | 判断一个点是否在控件内。 |
|
||||
| <a href="#widget_t_widget_is_popup">widget\_is\_popup</a> | 检查控件是否是弹出窗口类型。 |
|
||||
| <a href="#widget_t_widget_is_style_exist">widget\_is\_style\_exist</a> | 查询指定的style是否存在。 |
|
||||
| <a href="#widget_t_widget_is_system_bar">widget\_is\_system\_bar</a> | 检查控件是否是system bar类型。 |
|
||||
| <a href="#widget_t_widget_is_window">widget\_is\_window</a> | 判断当前控件是否是窗口。 |
|
||||
| <a href="#widget_t_widget_is_window_manager">widget\_is\_window\_manager</a> | 判断当前控件是否是窗口管理器。 |
|
||||
@ -131,6 +135,7 @@ widget_on(button, EVT_CLICK, on_click, NULL);
|
||||
| <a href="#widget_t_widget_layout">widget\_layout</a> | 布局当前控件及子控件。 |
|
||||
| <a href="#widget_t_widget_layout_children">widget\_layout\_children</a> | layout子控件。 |
|
||||
| <a href="#widget_t_widget_load_asset">widget\_load\_asset</a> | 加载资源。 |
|
||||
| <a href="#widget_t_widget_load_asset_ex">widget\_load\_asset\_ex</a> | 加载资源。 |
|
||||
| <a href="#widget_t_widget_load_image">widget\_load\_image</a> | 加载图片。 |
|
||||
| <a href="#widget_t_widget_lookup">widget\_lookup</a> | 查找指定名称的子控件(返回第一个)。 |
|
||||
| <a href="#widget_t_widget_lookup_by_type">widget\_lookup\_by\_type</a> | 查找指定类型的子控件(返回第一个)。 |
|
||||
@ -205,6 +210,7 @@ widget_on(button, EVT_CLICK, on_click, NULL);
|
||||
| <a href="#widget_t_widget_to_global">widget\_to\_global</a> | 将控件内的本地坐标转换成全局坐标。 |
|
||||
| <a href="#widget_t_widget_to_local">widget\_to\_local</a> | 将屏幕坐标转换成控件内的本地坐标，即相对于控件左上角的坐标。 |
|
||||
| <a href="#widget_t_widget_to_screen">widget\_to\_screen</a> | 将控件内的本地坐标转换成屏幕上的坐标。 |
|
||||
| <a href="#widget_t_widget_to_screen_ex">widget\_to\_screen\_ex</a> | 将控件内的本地坐标根据祖父级控件转换成相对于祖父级控件的屏幕相对坐标。 |
|
||||
| <a href="#widget_t_widget_to_xml">widget\_to\_xml</a> | 将widget转换成xml。 |
|
||||
| <a href="#widget_t_widget_ungrab">widget\_ungrab</a> | 让指定子控件放弃抓住事件。 |
|
||||
| <a href="#widget_t_widget_unload_asset">widget\_unload\_asset</a> | 卸载资源。 |
|
||||
@ -1366,6 +1372,25 @@ const char* widget_get_state_for_style (widget_t* widget, bool_t active, bool_t
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| active | bool\_t | 控件是否为当前项。 |
|
||||
| checked | bool\_t | 控件是否为选中项。 |
|
||||
#### widget\_get\_style\_type 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_get_style_type">获取 widget 对应风格类型
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* widget_get_style_type (widget_t* widget);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回 widget 的对应风格类型。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
#### widget\_get\_text 函数
|
||||
-----------------------
|
||||
|
||||
@ -1494,6 +1519,27 @@ widget_t* widget_get_window_manager (widget_t* widget);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 窗口管理器对象。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
#### widget\_get\_window\_theme 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_get_window_theme">获取控件的窗口主题
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t widget_get_window_theme (widget_t* widget, theme_t** win_theme, theme_t** default_theme);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| win\_theme | theme\_t** | 返回窗口主题。 |
|
||||
| default\_theme | theme\_t** | 返回全局默认主题。 |
|
||||
#### widget\_grab 函数
|
||||
-----------------------
|
||||
|
||||
@ -1744,6 +1790,25 @@ bool_t widget_is_normal_window (widget_t* widget);
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回FALSE表示不是，否则表示是。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
#### widget\_is\_opened\_dialog 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_is_opened_dialog">检查控件弹出对话框控件是否已经打开了（而非挂起状态）。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t widget_is_opened_dialog (widget_t* widget);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回FALSE表示不是，否则表示是。 |
|
||||
@ -1847,6 +1912,27 @@ bool_t widget_is_popup (widget_t* widget);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回FALSE表示不是，否则表示是。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
#### widget\_is\_style\_exist 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_is_style_exist">查询指定的style是否存在。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t widget_is_style_exist (widget_t* widget, const char* style_name, const char* state_name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 存在返回 TRUE，不存在返回 FALSE。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| style\_name | const char* | style的名称（如果为 NULL，则默认为 default）。 |
|
||||
| state\_name | const char* | state的名称（如果为 NULL，则默认为 normal）。 |
|
||||
#### widget\_is\_system\_bar 函数
|
||||
-----------------------
|
||||
|
||||
@ -1990,6 +2076,36 @@ const asset_info_t* widget_load_asset (widget_t* widget, asset_type_t type, cons
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| type | asset\_type\_t | 资源类型。 |
|
||||
| name | const char* | 资源名。 |
|
||||
#### widget\_load\_asset\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_load_asset_ex">加载资源。
|
||||
|
||||
使用示例：
|
||||
|
||||
```c
|
||||
const asset_info_t* asset = widget_load_asset_ex(widget, ASSET_TYPE_IMAGE, ASSET_TYPE_IMAGE_BSVG, "mysvg");
|
||||
...
|
||||
widget_unload_asset(widget, asset);
|
||||
```
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const asset_info_t* widget_load_asset_ex (widget_t* widget, asset_type_t type, uint16_t subtype, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const asset\_info\_t* | 返回资源句柄。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| type | asset\_type\_t | 资源类型。 |
|
||||
| subtype | uint16\_t | 资源子类型。 |
|
||||
| name | const char* | 资源名。 |
|
||||
#### widget\_load\_image 函数
|
||||
-----------------------
|
||||
|
||||
@ -3583,6 +3699,28 @@ ret_t widget_to_screen (widget_t* widget, point_t* p);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| p | point\_t* | 坐标点。 |
|
||||
#### widget\_to\_screen\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_to_screen_ex">将控件内的本地坐标根据祖父级控件转换成相对于祖父级控件的屏幕相对坐标。
|
||||
备注：如果 parent 不是 widget 控件的父级或者祖父级话，该函数会退化为 widget_to_screen 函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t widget_to_screen_ex (widget_t* widget, widget_t* parent, point_t* p);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| parent | widget\_t* | 祖父级控。 |
|
||||
| p | point\_t* | 坐标点。 |
|
||||
#### widget\_to\_xml 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -32,8 +32,14 @@
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#window_base_t_assets_manager">assets\_manager</a> | assets\_manager\_t* | 获取资源管理器对象。 |
|
||||
| <a href="#window_base_t_auto_scale_children_h">auto\_scale\_children\_h</a> | bool\_t | 窗口大小与设计时大小不同时，是否自动调整子控件的高度。 |
|
||||
| <a href="#window_base_t_auto_scale_children_w">auto\_scale\_children\_w</a> | bool\_t | 窗口大小与设计时大小不同时，是否自动调整子控件的宽度。 |
|
||||
| <a href="#window_base_t_auto_scale_children_x">auto\_scale\_children\_x</a> | bool\_t | 窗口大小与设计时大小不同时，是否自动调整子控件的x坐标。 |
|
||||
| <a href="#window_base_t_auto_scale_children_y">auto\_scale\_children\_y</a> | bool\_t | 窗口大小与设计时大小不同时，是否自动调整子控件的y坐标。 |
|
||||
| <a href="#window_base_t_closable">closable</a> | window\_closable\_t | 收到EVT_REQUEST_CLOSE_WINDOW是否自动关闭窗口。 |
|
||||
| <a href="#window_base_t_close_anim_hint">close\_anim\_hint</a> | char* | 关闭窗口动画的名称。 |
|
||||
| <a href="#window_base_t_design_h">design\_h</a> | uint16\_t | 设计时高度。 |
|
||||
| <a href="#window_base_t_design_w">design\_w</a> | uint16\_t | 设计时宽度。 |
|
||||
| <a href="#window_base_t_disable_anim">disable\_anim</a> | bool\_t | 禁用窗口动画。 |
|
||||
| <a href="#window_base_t_font_manager">font\_manager</a> | font\_manager\_t* | 获取字体管理器对象。 |
|
||||
| <a href="#window_base_t_image_manager">image\_manager</a> | image\_manager\_t* | 获取图片管理器对象。 |
|
||||
@ -276,6 +282,70 @@ ret_t window_base_set_prop (widget_t* widget, const char* name, const value_t* v
|
||||
| 可直接读取 | 否 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
#### auto\_scale\_children\_h 属性
|
||||
-----------------------
|
||||
> <p id="window_base_t_auto_scale_children_h">窗口大小与设计时大小不同时，是否自动调整子控件的高度。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### auto\_scale\_children\_w 属性
|
||||
-----------------------
|
||||
> <p id="window_base_t_auto_scale_children_w">窗口大小与设计时大小不同时，是否自动调整子控件的宽度。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### auto\_scale\_children\_x 属性
|
||||
-----------------------
|
||||
> <p id="window_base_t_auto_scale_children_x">窗口大小与设计时大小不同时，是否自动调整子控件的x坐标。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### auto\_scale\_children\_y 属性
|
||||
-----------------------
|
||||
> <p id="window_base_t_auto_scale_children_y">窗口大小与设计时大小不同时，是否自动调整子控件的y坐标。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### closable 属性
|
||||
-----------------------
|
||||
> <p id="window_base_t_closable">收到EVT_REQUEST_CLOSE_WINDOW是否自动关闭窗口。
|
||||
@ -307,6 +377,38 @@ ret_t window_base_set_prop (widget_t* widget, const char* name, const value_t* v
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### design\_h 属性
|
||||
-----------------------
|
||||
> <p id="window_base_t_design_h">设计时高度。
|
||||
|
||||
* 类型：uint16\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### design\_w 属性
|
||||
-----------------------
|
||||
> <p id="window_base_t_design_w">设计时宽度。
|
||||
|
||||
* 类型：uint16\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -58,6 +58,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau
|
||||
| <a href="#window_t_window_create_default">window\_create\_default</a> | 以缺省的方式创建window对象。 |
|
||||
| <a href="#window_t_window_open">window\_open</a> | 从资源文件中加载并创建window_base对象。本函数在ui_loader/ui_builder_default里实现。 |
|
||||
| <a href="#window_t_window_open_and_close">window\_open\_and\_close</a> | 从资源文件中加载并创建window对象。本函数在ui_loader/ui_builder_default里实现。 |
|
||||
| <a href="#window_t_window_set_auto_scale_children">window\_set\_auto\_scale\_children</a> | 当设计分辨率和实际分辨率不一致时，自动调整子控件的位置和大小。 |
|
||||
| <a href="#window_t_window_set_fullscreen">window\_set\_fullscreen</a> | 设置为全屏窗口。 |
|
||||
### 属性
|
||||
<p id="window_t_properties">
|
||||
@ -312,6 +313,29 @@ widget_t* window_open_and_close (const char* name, widget_t* to_close);
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| name | const char* | window的名称。 |
|
||||
| to\_close | widget\_t* | 关闭该窗口。 |
|
||||
#### window\_set\_auto\_scale\_children 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="window_t_window_set_auto_scale_children">当设计分辨率和实际分辨率不一致时，自动调整子控件的位置和大小。
|
||||
|
||||
> 当子控件有self_layout参数或者子控件的父控件有children_layout参数时，不会自动调整。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t window_set_auto_scale_children (widget_t* widget, uint32_t design_w, uint32_t design_h);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | window对象。 |
|
||||
| design\_w | uint32\_t | 设计时宽度。 |
|
||||
| design\_h | uint32\_t | 设计时高度。 |
|
||||
#### window\_set\_fullscreen 函数
|
||||
-----------------------
|
||||
|
||||
@ -319,7 +343,7 @@ widget_t* window_open_and_close (const char* name, widget_t* to_close);
|
||||
|
||||
> <p id="window_t_window_set_fullscreen">设置为全屏窗口。
|
||||
|
||||
>这里全屏是指与LCD相同大小，而非让SDL窗口全屏。
|
||||
>如果app_type是SIMULATOR，全屏是指与LCD相同大小，而非让SDL窗口全屏。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user