mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-12-01 19:49:11 +08:00
update docs
This commit is contained in:
xianjimli
parent
801d0206cf
commit
25afd239ee
12
docs/manual/align_h_t.md
Normal file
12
docs/manual/align_h_t.md
Normal file
@ -0,0 +1,12 @@
|
||||
## align\_h\_t
|
||||
### 概述
|
||||
水平对齐的常量定义。
|
||||
### 常量
|
||||
<p id="align_h_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| ALIGN\_H\_NONE | 无效对齐方式。 |
|
||||
| ALIGN\_H\_CENTER | 居中对齐。 |
|
||||
| ALIGN\_H\_LEFT | 左边对齐。 |
|
||||
| ALIGN\_H\_RIGHT | 右边对齐。 |
|
||||
12
docs/manual/align_v_t.md
Normal file
12
docs/manual/align_v_t.md
Normal file
@ -0,0 +1,12 @@
|
||||
## align\_v\_t
|
||||
### 概述
|
||||
垂直对齐的常量定义。
|
||||
### 常量
|
||||
<p id="align_v_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| ALIGN\_V\_NONE | 无效对齐方式。 |
|
||||
| ALIGN\_V\_MIDDLE | 居中对齐。 |
|
||||
| ALIGN\_V\_TOP | 顶部对齐。 |
|
||||
| ALIGN\_V\_BOTTOM | 底部对齐。 |
|
||||
49
docs/manual/app_bar_t.md
Normal file
49
docs/manual/app_bar_t.md
Normal file
@ -0,0 +1,49 @@
|
||||
## app\_bar\_t
|
||||
### 概述
|
||||
app_bar。一个简单的容器控件，一般在窗口的顶部。
|
||||
它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="app_bar_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#app_bar_t_app_bar_cast">app\_bar\_cast</a> | 转换为app_bar对象(供脚本语言使用)。
|
|
||||
| <a href="#app_bar_t_app_bar_create">app\_bar\_create</a> | 创建app_bar对象
|
|
||||
### 属性
|
||||
<p id="app_bar_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="app_bar_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### app\_bar\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | app\_bar对象。 |
|
||||
| widget | widget\_t* | app\_bar对象。 |
|
||||
<p id="app_bar_t_app_bar_cast"> 转换为app_bar对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### app\_bar\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="app_bar_t_app_bar_create"> 创建app_bar对象
|
||||
|
||||
|
||||
|
||||
11
docs/manual/app_type_t.md
Normal file
11
docs/manual/app_type_t.md
Normal file
@ -0,0 +1,11 @@
|
||||
## app\_type\_t
|
||||
### 概述
|
||||
应用程序类型。
|
||||
### 常量
|
||||
<p id="app_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| APP\_MOBILE | 嵌入式或移动APP |
|
||||
| APP\_SIMULATOR | 模拟器。 |
|
||||
| APP\_DESKTOP | 桌面应用程序。 |
|
||||
218
docs/manual/array_t.md
Normal file
218
docs/manual/array_t.md
Normal file
@ -0,0 +1,218 @@
|
||||
## array\_t
|
||||
### 概述
|
||||
动态数组，根据元素个数动态调整数组的容量。
|
||||
|
||||
### 函数
|
||||
<p id="array_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#array_t_array_create">array\_create</a> | 创建array对象 |
|
||||
| <a href="#array_t_array_deinit">array\_deinit</a> | 清除数组中的元素。 |
|
||||
| <a href="#array_t_array_destroy">array\_destroy</a> | 清除数组中的元素，并释放数组对象。 |
|
||||
| <a href="#array_t_array_find">array\_find</a> | 查找第一个满足条件的元素。 |
|
||||
| <a href="#array_t_array_find_index">array\_find\_index</a> | 查找第一个满足条件的元素，并返回位置。 |
|
||||
| <a href="#array_t_array_init">array\_init</a> | 初始化array对象 |
|
||||
| <a href="#array_t_array_pop">array\_pop</a> | 弹出最后一个元素。 |
|
||||
| <a href="#array_t_array_push">array\_push</a> | 在尾巴追加一个元素。 |
|
||||
| <a href="#array_t_array_remove">array\_remove</a> | 删除第一个满足条件的元素。 |
|
||||
| <a href="#array_t_array_remove_all">array\_remove\_all</a> | 删除全部满足条件的元素。 |
|
||||
### 属性
|
||||
<p id="array_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#array_t_capacity">capacity</a> | uint16_t | 数组的容量大小。 |
|
||||
| <a href="#array_t_elms">elms</a> | void** | 数组中的元素。 |
|
||||
| <a href="#array_t_size">size</a> | uint16_t | 数组中元素的个数。 |
|
||||
### 事件
|
||||
<p id="array_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### array\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | array\_t* | 数组对象。 |
|
||||
| capacity | uint16\_t* | 数组的初始容量。 |
|
||||
<p id="array_t_array_create"> 创建array对象
|
||||
|
||||
|
||||
|
||||
|
||||
#### array\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 无。 |
|
||||
| array | array\_t* | 数组对象。 |
|
||||
<p id="array_t_array_deinit"> 清除数组中的元素。
|
||||
|
||||
|
||||
|
||||
|
||||
#### array\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 无。 |
|
||||
| array | array\_t* | 数组对象。 |
|
||||
<p id="array_t_array_destroy"> 清除数组中的元素，并释放数组对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### array\_find 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void* | 如果找到，返回满足条件的对象，否则返回NULL。 |
|
||||
| array | array\_t* | 数组对象。 |
|
||||
| cmp | tk\_compare\_t | 比较函数，为NULL时直接比较指针。 |
|
||||
| ctx | void* | 比较函数的上下文。 |
|
||||
<p id="array_t_array_find"> 查找第一个满足条件的元素。
|
||||
|
||||
|
||||
|
||||
|
||||
#### array\_find\_index 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 如果找到，返回满足条件的对象的位置，否则返回-1。 |
|
||||
| array | array\_t* | 数组对象。 |
|
||||
| cmp | tk\_compare\_t | 比较函数，为NULL时直接比较指针。 |
|
||||
| ctx | void* | 比较函数的上下文。 |
|
||||
<p id="array_t_array_find_index"> 查找第一个满足条件的元素，并返回位置。
|
||||
|
||||
|
||||
|
||||
|
||||
#### array\_init 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | array\_t* | 数组对象。 |
|
||||
| array | array\_t* | 数组对象。 |
|
||||
| capacity | uint16\_t* | 数组的初始容量。 |
|
||||
<p id="array_t_array_init"> 初始化array对象
|
||||
|
||||
|
||||
|
||||
|
||||
#### array\_pop 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void* | 成功返回最后一个元素，失败返回NULL。 |
|
||||
| array | array\_t* | 数组对象。 |
|
||||
<p id="array_t_array_pop"> 弹出最后一个元素。
|
||||
|
||||
|
||||
|
||||
|
||||
#### array\_push 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| array | array\_t* | 数组对象。 |
|
||||
| data | void* | 待追加的元素。 |
|
||||
<p id="array_t_array_push"> 在尾巴追加一个元素。
|
||||
|
||||
|
||||
|
||||
|
||||
#### array\_remove 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| array | array\_t* | 数组对象。 |
|
||||
| cmp | tk\_compare\_t | 比较函数，为NULL时直接比较指针。 |
|
||||
| ctx | void* | 比较函数的上下文。 |
|
||||
| destroy | tk\_destroy\_t | 销毁元素的回调函数。 |
|
||||
<p id="array_t_array_remove"> 删除第一个满足条件的元素。
|
||||
|
||||
|
||||
|
||||
|
||||
#### array\_remove\_all 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| array | array\_t* | 数组对象。 |
|
||||
| cmp | tk\_compare\_t | 比较函数，为NULL时直接比较指针。 |
|
||||
| ctx | void* | 比较函数的上下文。 |
|
||||
| destroy | tk\_destroy\_t | 销毁元素的回调函数。 |
|
||||
<p id="array_t_array_remove_all"> 删除全部满足条件的元素。
|
||||
|
||||
|
||||
|
||||
|
||||
#### capacity 属性
|
||||
-----------------------
|
||||
<p id="array_t_capacity"> 数组的容量大小。
|
||||
|
||||
|
||||
|
||||
* 类型：uint16\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### elms 属性
|
||||
-----------------------
|
||||
<p id="array_t_elms"> 数组中的元素。
|
||||
|
||||
|
||||
|
||||
* 类型：void**
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### size 属性
|
||||
-----------------------
|
||||
<p id="array_t_size"> 数组中元素的个数。
|
||||
|
||||
|
||||
|
||||
* 类型：uint16\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
9
docs/manual/asset_font_type_t.md
Normal file
9
docs/manual/asset_font_type_t.md
Normal file
@ -0,0 +1,9 @@
|
||||
## asset\_font\_type\_t
|
||||
### 概述
|
||||
字体资源类型定义。
|
||||
|
||||
### 常量
|
||||
<p id="asset_font_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
9
docs/manual/asset_image_type_t.md
Normal file
9
docs/manual/asset_image_type_t.md
Normal file
@ -0,0 +1,9 @@
|
||||
## asset\_image\_type\_t
|
||||
### 概述
|
||||
图片资源类型定义。
|
||||
|
||||
### 常量
|
||||
<p id="asset_image_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
133
docs/manual/asset_info_t.md
Normal file
133
docs/manual/asset_info_t.md
Normal file
@ -0,0 +1,133 @@
|
||||
## asset\_info\_t
|
||||
### 概述
|
||||
单个资源的描述信息。
|
||||
|
||||
### 函数
|
||||
<p id="asset_info_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
### 属性
|
||||
<p id="asset_info_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#asset_info_t_is_in_rom">is\_in\_rom</a> | uint8_t | 资源是否在ROM中。 |
|
||||
| <a href="#asset_info_t_name">name</a> | char* | 名称。 |
|
||||
| <a href="#asset_info_t_refcount">refcount</a> | uint32_t | 引用计数。is_in_rom == FALSE时才有效。 |
|
||||
| <a href="#asset_info_t_size">size</a> | uint32_t | 大小。 |
|
||||
| <a href="#asset_info_t_subtype">subtype</a> | uint8_t | 子类型。 |
|
||||
| <a href="#asset_info_t_type">type</a> | uint16_t | 类型。 |
|
||||
### 事件
|
||||
<p id="asset_info_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### is\_in\_rom 属性
|
||||
-----------------------
|
||||
<p id="asset_info_t_is_in_rom"> 资源是否在ROM中。
|
||||
|
||||
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### name 属性
|
||||
-----------------------
|
||||
<p id="asset_info_t_name"> 名称。
|
||||
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### refcount 属性
|
||||
-----------------------
|
||||
<p id="asset_info_t_refcount"> 引用计数。is_in_rom == FALSE时才有效。
|
||||
|
||||
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### size 属性
|
||||
-----------------------
|
||||
<p id="asset_info_t_size"> 大小。
|
||||
|
||||
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### subtype 属性
|
||||
-----------------------
|
||||
<p id="asset_info_t_subtype"> 子类型。
|
||||
|
||||
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### type 属性
|
||||
-----------------------
|
||||
<p id="asset_info_t_type"> 类型。
|
||||
|
||||
|
||||
|
||||
* 类型：uint16\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
17
docs/manual/asset_type_t.md
Normal file
17
docs/manual/asset_type_t.md
Normal file
@ -0,0 +1,17 @@
|
||||
## asset\_type\_t
|
||||
### 概述
|
||||
资源类型常量定义。
|
||||
|
||||
### 常量
|
||||
<p id="asset_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| ASSET\_TYPE\_NONE | 无效资源。 |
|
||||
| ASSET\_TYPE\_FONT | 字体资源。 |
|
||||
| ASSET\_TYPE\_IMAGE | 图片资源。 |
|
||||
| ASSET\_TYPE\_STYLE | 主题资源。 |
|
||||
| ASSET\_TYPE\_UI | UI数据资源。 |
|
||||
| ASSET\_TYPE\_XML | XML数据资源。 |
|
||||
| ASSET\_TYPE\_STRINGS | 字符串数据资源。 |
|
||||
| ASSET\_TYPE\_DATA | 其它数据资源。 |
|
||||
9
docs/manual/asset_ui_type_t.md
Normal file
9
docs/manual/asset_ui_type_t.md
Normal file
@ -0,0 +1,9 @@
|
||||
## asset\_ui\_type\_t
|
||||
### 概述
|
||||
UI资源类型定义。
|
||||
|
||||
### 常量
|
||||
<p id="asset_ui_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
198
docs/manual/assets_manager_t.md
Normal file
198
docs/manual/assets_manager_t.md
Normal file
@ -0,0 +1,198 @@
|
||||
## assets\_manager\_t
|
||||
### 概述
|
||||
资源管理器。
|
||||
|
||||
### 函数
|
||||
<p id="assets_manager_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#assets_manager_t_assets_manager">assets\_manager</a> | 获取缺省资源管理器。 |
|
||||
| <a href="#assets_manager_t_assets_manager_add">assets\_manager\_add</a> | 向资源管理器中增加一个资源。 |
|
||||
| <a href="#assets_manager_t_assets_manager_clear_cache">assets\_manager\_clear\_cache</a> | 清除指定类型的缓存。 |
|
||||
| <a href="#assets_manager_t_assets_manager_create">assets\_manager\_create</a> | 创建资源管理器。 |
|
||||
| <a href="#assets_manager_t_assets_manager_deinit">assets\_manager\_deinit</a> | 释放全部资源。 |
|
||||
| <a href="#assets_manager_t_assets_manager_destroy">assets\_manager\_destroy</a> | 释放全部资源并销毁asset manager对象。 |
|
||||
| <a href="#assets_manager_t_assets_manager_find_in_cache">assets\_manager\_find\_in\_cache</a> | 在资源管理器的缓存中查找指定的资源(不引用)。 |
|
||||
| <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_ref">assets\_manager\_ref</a> | 在资源管理器的缓存中查找指定的资源并引用它，如果缓存中不存在，尝试加载该资源。 |
|
||||
| <a href="#assets_manager_t_assets_manager_set">assets\_manager\_set</a> | 设置缺省资源管理器。 |
|
||||
| <a href="#assets_manager_t_assets_manager_set_res_root">assets\_manager\_set\_res\_root</a> | 设置资源所在的目录(其下目录结构请参考demos)。 |
|
||||
| <a href="#assets_manager_t_assets_manager_unref">assets\_manager\_unref</a> | 释放指定的资源。 |
|
||||
### 属性
|
||||
<p id="assets_manager_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="assets_manager_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### assets\_manager 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | assets\_manager\_t* | 返回asset manager对象。 |
|
||||
<p id="assets_manager_t_assets_manager"> 获取缺省资源管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_add 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
| info | asset\_info\_t | 待增加的资源。 |
|
||||
<p id="assets_manager_t_assets_manager_add"> 向资源管理器中增加一个资源。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_clear\_cache 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
<p id="assets_manager_t_assets_manager_clear_cache"> 清除指定类型的缓存。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | assets\_manager\_t* | 返回asset manager对象。 |
|
||||
| init\_nr | uint32\_t | 预先分配资源的个数。 |
|
||||
<p id="assets_manager_t_assets_manager_create"> 创建资源管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
<p id="assets_manager_t_assets_manager_deinit"> 释放全部资源。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
<p id="assets_manager_t_assets_manager_destroy"> 释放全部资源并销毁asset manager对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_find\_in\_cache 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | asset\_info\_t* | 返回资源。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
| name | char* | 资源的名称。 |
|
||||
<p id="assets_manager_t_assets_manager_find_in_cache"> 在资源管理器的缓存中查找指定的资源(不引用)。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_init 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | assets\_manager\_t* | 返回asset manager对象。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
| init\_nr | uint32\_t | 预先分配资源的个数。 |
|
||||
<p id="assets_manager_t_assets_manager_init"> 初始化资源管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_load 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | asset\_info\_t* | 返回资源。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
| name | char* | 资源的名称。 |
|
||||
<p id="assets_manager_t_assets_manager_load"> 从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH_FS_RES时才生效。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_ref 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | asset\_info\_t* | 返回资源。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
| name | char* | 资源的名称。 |
|
||||
<p id="assets_manager_t_assets_manager_ref"> 在资源管理器的缓存中查找指定的资源并引用它，如果缓存中不存在，尝试加载该资源。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_set 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
<p id="assets_manager_t_assets_manager_set"> 设置缺省资源管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_set\_res\_root 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
| res\_root | const char* | 资源所在的目录。 |
|
||||
<p id="assets_manager_t_assets_manager_set_res_root"> 设置资源所在的目录(其下目录结构请参考demos)。
|
||||
|
||||
|
||||
|
||||
|
||||
#### assets\_manager\_unref 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rm | assets\_manager\_t* | asset manager对象。 |
|
||||
| info | asset\_info\_t* | 资源。 |
|
||||
<p id="assets_manager_t_assets_manager_unref"> 释放指定的资源。
|
||||
|
||||
|
||||
|
||||
|
||||
14
docs/manual/bitmap_flag_t.md
Normal file
14
docs/manual/bitmap_flag_t.md
Normal file
@ -0,0 +1,14 @@
|
||||
## bitmap\_flag\_t
|
||||
### 概述
|
||||
位图标志常量定义。
|
||||
|
||||
### 常量
|
||||
<p id="bitmap_flag_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| BITMAP\_FLAG\_NONE | 无特殊标志。 |
|
||||
| BITMAP\_FLAG\_OPAQUE | 不透明图片。 |
|
||||
| BITMAP\_FLAG\_IMMUTABLE | 图片内容不会变化。 |
|
||||
| BITMAP\_FLAG\_TEXTURE | OpenGL Texture, bitmap的id是有效的texture id。 |
|
||||
| BITMAP\_FLAG\_CHANGED | 如果是MUTABLE的图片，更新时需要设置此标志，底层可能会做特殊处理，比如更新图片到GPU。 |
|
||||
18
docs/manual/bitmap_format_t.md
Normal file
18
docs/manual/bitmap_format_t.md
Normal file
@ -0,0 +1,18 @@
|
||||
## bitmap\_format\_t
|
||||
### 概述
|
||||
位图格式常量定义。
|
||||
|
||||
### 常量
|
||||
<p id="bitmap_format_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| BITMAP\_FMT\_NONE | 无效格式。 |
|
||||
| BITMAP\_FMT\_RGBA8888 | 一个像素占用4个字节，RGBA占一个字节，按内存地址递增。 |
|
||||
| BITMAP\_FMT\_ABGR8888 | 一个像素占用4个字节，ABGR占一个字节，按内存地址递增。 |
|
||||
| BITMAP\_FMT\_BGRA8888 | 一个像素占用4个字节，BGRA占一个字节，按内存地址递增。 |
|
||||
| BITMAP\_FMT\_ARGB8888 | 一个像素占用4个字节，ARGB占一个字节，按内存地址递增。 |
|
||||
| BITMAP\_FMT\_RGB565 | 一个像素占用2个字节，RGB分别占用5,6,5位, 按内存地址递增。 |
|
||||
| BITMAP\_FMT\_BGR565 | 一个像素占用2个字节，BGR分别占用5,6,5位, 按内存地址递增。 |
|
||||
| BITMAP\_FMT\_RGB888 | 一个像素占用3个字节，RGB占一个字节，按内存地址递增。 |
|
||||
| BITMAP\_FMT\_BGR888 | 一个像素占用3个字节，RGB占一个字节，按内存地址递增。 |
|
||||
283
docs/manual/bitmap_t.md
Normal file
283
docs/manual/bitmap_t.md
Normal file
@ -0,0 +1,283 @@
|
||||
## bitmap\_t
|
||||
### 概述
|
||||
位图。
|
||||
|
||||
### 函数
|
||||
<p id="bitmap_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#bitmap_t_bitmap_create">bitmap\_create</a> | 创建图片对象(一般供脚本语言中使用)。 |
|
||||
| <a href="#bitmap_t_bitmap_create_ex">bitmap\_create\_ex</a> | 创建图片对象。 |
|
||||
| <a href="#bitmap_t_bitmap_destroy">bitmap\_destroy</a> | 销毁图片。 |
|
||||
| <a href="#bitmap_t_bitmap_get_bpp">bitmap\_get\_bpp</a> | 获取图片一个像素占用的字节数。 |
|
||||
| <a href="#bitmap_t_bitmap_get_line_length">bitmap\_get\_line\_length</a> | 获取每一行占用内存的字节数。 |
|
||||
| <a href="#bitmap_t_bitmap_get_pixel">bitmap\_get\_pixel</a> | 获取图片指定像素的rgba颜色值(主要用于测试程序)。 |
|
||||
| <a href="#bitmap_t_bitmap_init">bitmap\_init</a> | 初始化图片。 |
|
||||
| <a href="#bitmap_t_bitmap_init_from_rgba">bitmap\_init\_from\_rgba</a> | 初始化图片。 |
|
||||
| <a href="#bitmap_t_bitmap_set_line_length">bitmap\_set\_line\_length</a> | 设置line_length。 |
|
||||
### 属性
|
||||
<p id="bitmap_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#bitmap_t_data">data</a> | uint8_t* | 图片数据。 |
|
||||
| <a href="#bitmap_t_flags">flags</a> | uint16_t | 标志。请参考{bitmap_flag_t}。 |
|
||||
| <a href="#bitmap_t_format">format</a> | uint16_t | 格式。请参考{bitmap_format_t}。 |
|
||||
| <a href="#bitmap_t_h">h</a> | wh_t | 高度。 |
|
||||
| <a href="#bitmap_t_line_length">line\_length</a> | uint32_t | 每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。 |
|
||||
| <a href="#bitmap_t_name">name</a> | char* | 名称。 |
|
||||
| <a href="#bitmap_t_w">w</a> | wh_t | 宽度。 |
|
||||
### 事件
|
||||
<p id="bitmap_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### bitmap\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bitmap\_t* | 返回bitmap对象。 |
|
||||
<p id="bitmap_t_bitmap_create"> 创建图片对象(一般供脚本语言中使用)。
|
||||
|
||||
|
||||
|
||||
#### bitmap\_create\_ex 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bitmap\_t* | 返回bitmap对象。 |
|
||||
| w | uint32\_t | 宽度。 |
|
||||
| h | uint32\_t | 高度。 |
|
||||
| line\_length | uint32\_t | line\_length。 |
|
||||
| format | bitmap\_format\_t | 格式。 |
|
||||
<p id="bitmap_t_bitmap_create_ex"> 创建图片对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### bitmap\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| bitmap | bitmap\_t* | bitmap对象。 |
|
||||
<p id="bitmap_t_bitmap_destroy"> 销毁图片。
|
||||
|
||||
|
||||
|
||||
#### bitmap\_get\_bpp 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回一个像素占用的字节数。 |
|
||||
| bitmap | bitmap\_t* | bitmap对象。 |
|
||||
<p id="bitmap_t_bitmap_get_bpp"> 获取图片一个像素占用的字节数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### bitmap\_get\_line\_length 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| bitmap | bitmap\_t* | bitmap对象。 |
|
||||
<p id="bitmap_t_bitmap_get_line_length"> 获取每一行占用内存的字节数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### bitmap\_get\_pixel 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| bitmap | bitmap\_t* | bitmap对象。 |
|
||||
| x | uint32\_t | x坐标。 |
|
||||
| y | uint32\_t | y坐标。 |
|
||||
| rgba | rgba\_t* | 返回颜色值。 |
|
||||
<p id="bitmap_t_bitmap_get_pixel"> 获取图片指定像素的rgba颜色值(主要用于测试程序)。
|
||||
|
||||
|
||||
|
||||
|
||||
#### bitmap\_init 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| bitmap | bitmap\_t* | bitmap对象。 |
|
||||
| w | uint32\_t | 宽度。 |
|
||||
| h | uint32\_t | 高度。 |
|
||||
| format | bitmap\_format\_t | 格式。 |
|
||||
| data | const uint8\_t* | 数据，直接引用，但不负责释放。如果为空，由内部自动分配和释放。 |
|
||||
<p id="bitmap_t_bitmap_init"> 初始化图片。
|
||||
|
||||
|
||||
|
||||
|
||||
#### bitmap\_init\_from\_rgba 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| bitmap | bitmap\_t* | bitmap对象。 |
|
||||
| w | uint32\_t | 宽度。 |
|
||||
| h | uint32\_t | 高度。 |
|
||||
| format | bitmap\_format\_t | 格式。 |
|
||||
| | const uint8\_t* | a |
|
||||
| comp | uint32\_t | 颜色通道数(目前支持3(rgb)和4(rgba))。 |
|
||||
<p id="bitmap_t_bitmap_init_from_rgba"> 初始化图片。
|
||||
数据。3通道时为RGB888格式，4通道时为RGBA888格式(内部拷贝该数据，不会引用，调用者自行释放)。
|
||||
|
||||
|
||||
|
||||
|
||||
#### bitmap\_set\_line\_length 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| bitmap | bitmap\_t* | bitmap对象。 |
|
||||
| line\_length | uint32\_t | line\_length。 |
|
||||
<p id="bitmap_t_bitmap_set_line_length"> 设置line_length。
|
||||
|
||||
|
||||
|
||||
|
||||
#### data 属性
|
||||
-----------------------
|
||||
<p id="bitmap_t_data"> 图片数据。
|
||||
|
||||
|
||||
|
||||
* 类型：uint8\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### flags 属性
|
||||
-----------------------
|
||||
<p id="bitmap_t_flags"> 标志。请参考{bitmap_flag_t}。
|
||||
|
||||
|
||||
|
||||
* 类型：uint16\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### format 属性
|
||||
-----------------------
|
||||
<p id="bitmap_t_format"> 格式。请参考{bitmap_format_t}。
|
||||
|
||||
|
||||
|
||||
* 类型：uint16\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### h 属性
|
||||
-----------------------
|
||||
<p id="bitmap_t_h"> 高度。
|
||||
|
||||
|
||||
|
||||
* 类型：wh\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### line\_length 属性
|
||||
-----------------------
|
||||
<p id="bitmap_t_line_length"> 每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。
|
||||
|
||||
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### name 属性
|
||||
-----------------------
|
||||
<p id="bitmap_t_name"> 名称。
|
||||
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### w 属性
|
||||
-----------------------
|
||||
<p id="bitmap_t_w"> 宽度。
|
||||
|
||||
|
||||
|
||||
* 类型：wh\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
14
docs/manual/border_type_t.md
Normal file
14
docs/manual/border_type_t.md
Normal file
@ -0,0 +1,14 @@
|
||||
## border\_type\_t
|
||||
### 概述
|
||||
控件边框类型。
|
||||
### 常量
|
||||
<p id="border_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| BORDER\_NONE | 无边框。 |
|
||||
| BORDER\_LEFT | 左边框线。 |
|
||||
| BORDER\_RIGHT | 右边框线。 |
|
||||
| BORDER\_TOP | 上边框线。 |
|
||||
| BORDER\_BOTTOM | 下边框线。 |
|
||||
| BORDER\_ALL | 全边框线。 |
|
||||
48
docs/manual/button_group_t.md
Normal file
48
docs/manual/button_group_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## button\_group\_t
|
||||
### 概述
|
||||
Button Group控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="button_group_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#button_group_t_button_group_cast">button\_group\_cast</a> | 转换为button_group对象(供脚本语言使用)。
|
|
||||
| <a href="#button_group_t_button_group_create">button\_group\_create</a> | 创建button_group对象
|
|
||||
### 属性
|
||||
<p id="button_group_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="button_group_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### button\_group\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | button\_group对象。 |
|
||||
| widget | widget\_t* | button\_group对象。 |
|
||||
<p id="button_group_t_button_group_cast"> 转换为button_group对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### button\_group\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="button_group_t_button_group_create"> 创建button_group对象
|
||||
|
||||
|
||||
|
||||
81
docs/manual/button_t.md
Normal file
81
docs/manual/button_t.md
Normal file
@ -0,0 +1,81 @@
|
||||
## button\_t
|
||||
### 概述
|
||||
按钮控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="button_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#button_t_button_cast">button\_cast</a> | 转换为button对象(供脚本语言使用)。
|
|
||||
| <a href="#button_t_button_create">button\_create</a> | 创建button对象
|
|
||||
| <a href="#button_t_button_set_repeat">button\_set\_repeat</a> | 设置释放EVT_CLICK事件的时间间隔。为0则不重复释放EVT_CLICK事件。
|
|
||||
### 属性
|
||||
<p id="button_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#button_t_repeat">repeat</a> | int32_t | 重复释放EVT_CLICK事件的时间间隔。为0则不重复释放EVT_CLICK事件。
|
|
||||
### 事件
|
||||
<p id="button_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
| EVT\_CLICK | pointer\_event\_t | 点击事件。 |
|
||||
| EVT\_LONG\_PRESS | pointer\_event\_t | 长按事件。 |
|
||||
#### button\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | button对象。 |
|
||||
| widget | widget\_t* | button对象。 |
|
||||
<p id="button_t_button_cast"> 转换为button对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### button\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="button_t_button_create"> 创建button对象
|
||||
|
||||
|
||||
|
||||
#### button\_set\_repeat 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| repeat | int32\_t | 释放EVT\_CLICK事件的时间间隔(毫秒)。 |
|
||||
<p id="button_t_button_set_repeat"> 设置释放EVT_CLICK事件的时间间隔。为0则不重复释放EVT_CLICK事件。
|
||||
|
||||
|
||||
|
||||
#### repeat 属性
|
||||
-----------------------
|
||||
<p id="button_t_repeat"> 重复释放EVT_CLICK事件的时间间隔。为0则不重复释放EVT_CLICK事件。
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
64
docs/manual/calibration_win_t.md
Normal file
64
docs/manual/calibration_win_t.md
Normal file
@ -0,0 +1,64 @@
|
||||
## calibration\_win\_t
|
||||
### 概述
|
||||
电阻屏校准屏幕。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="calibration_win_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#calibration_win_t_calibration_win_create">calibration\_win\_create</a> | 创建calibration_win对象
|
|
||||
| <a href="#calibration_win_t_calibration_win_set_on_click">calibration\_win\_set\_on\_click</a> | 设置校准点击事件的处理函数。
|
|
||||
| <a href="#calibration_win_t_calibration_win_set_on_done">calibration\_win\_set\_on\_done</a> | 设置校准完成的处理函数。
|
|
||||
### 属性
|
||||
<p id="calibration_win_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="calibration_win_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### calibration\_win\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="calibration_win_t_calibration_win_create"> 创建calibration_win对象
|
||||
|
||||
|
||||
|
||||
#### calibration\_win\_set\_on\_click 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| on\_click | calibration\_win\_on\_click\_t | 回调函数。 |
|
||||
| ctx | void* | 回调函数的上下文。 |
|
||||
<p id="calibration_win_t_calibration_win_set_on_click"> 设置校准点击事件的处理函数。
|
||||
|
||||
|
||||
|
||||
#### calibration\_win\_set\_on\_done 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| on\_done | calibration\_win\_on\_done\_t | 回调函数。 |
|
||||
| ctx | void* | 回调函数的上下文。 |
|
||||
<p id="calibration_win_t_calibration_win_set_on_done"> 设置校准完成的处理函数。
|
||||
|
||||
|
||||
|
||||
36
docs/manual/candidates_t.md
Normal file
36
docs/manual/candidates_t.md
Normal file
@ -0,0 +1,36 @@
|
||||
## candidates\_t
|
||||
### 概述
|
||||
输入法候选字词控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="candidates_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#candidates_t_candidates_create">candidates\_create</a> | 创建candidates对象
|
|
||||
### 属性
|
||||
<p id="candidates_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="candidates_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### candidates\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="candidates_t_candidates_create"> 创建candidates对象
|
||||
|
||||
|
||||
|
||||
18
docs/manual/canvas_t.md
Normal file
18
docs/manual/canvas_t.md
Normal file
@ -0,0 +1,18 @@
|
||||
## canvas\_t
|
||||
### 概述
|
||||
canvas类。
|
||||
### 函数
|
||||
<p id="canvas_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
### 属性
|
||||
<p id="canvas_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="canvas_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
48
docs/manual/canvas_widget_t.md
Normal file
48
docs/manual/canvas_widget_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## canvas\_widget\_t
|
||||
### 概述
|
||||
画布控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="canvas_widget_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#canvas_widget_t_canvas_widget_cast">canvas\_widget\_cast</a> | 转换为canvas_widget对象(供脚本语言使用)。
|
|
||||
| <a href="#canvas_widget_t_canvas_widget_create">canvas\_widget\_create</a> | 创建canvas_widget对象
|
|
||||
### 属性
|
||||
<p id="canvas_widget_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="canvas_widget_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### canvas\_widget\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | canvas\_widget对象。 |
|
||||
| widget | widget\_t* | canvas\_widget对象。 |
|
||||
<p id="canvas_widget_t_canvas_widget_cast"> 转换为canvas_widget对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### canvas\_widget\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="canvas_widget_t_canvas_widget_create"> 创建canvas_widget对象
|
||||
|
||||
|
||||
|
||||
97
docs/manual/check_button_t.md
Normal file
97
docs/manual/check_button_t.md
Normal file
@ -0,0 +1,97 @@
|
||||
## check\_button\_t
|
||||
### 概述
|
||||
勾选控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="check_button_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#check_button_t_check_button_cast">check\_button\_cast</a> | 转换check_button对象(供脚本语言使用)。
|
|
||||
| <a href="#check_button_t_check_button_create">check\_button\_create</a> | 创建check_button对象
|
|
||||
| <a href="#check_button_t_check_button_create_radio">check\_button\_create\_radio</a> | 创建check_button对象
|
|
||||
| <a href="#check_button_t_check_button_set_value">check\_button\_set\_value</a> | 设置控件的值。
|
|
||||
### 属性
|
||||
<p id="check_button_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#check_button_t_value">value</a> | bool_t | 值。
|
|
||||
### 事件
|
||||
<p id="check_button_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(勾选状态)即将改变事件。 |
|
||||
| EVT\_VALUE\_CHANGED | event\_t | 值(勾选状态)改变事件。 |
|
||||
#### check\_button\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | check\_button对象。 |
|
||||
| widget | widget\_t* | check\_button对象。 |
|
||||
<p id="check_button_t_check_button_cast"> 转换check_button对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### check\_button\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="check_button_t_check_button_create"> 创建check_button对象
|
||||
|
||||
|
||||
|
||||
#### check\_button\_create\_radio 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="check_button_t_check_button_create_radio"> 创建check_button对象
|
||||
|
||||
|
||||
|
||||
#### check\_button\_set\_value 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | check\_button对象。 |
|
||||
| value | bool\_t | 值 |
|
||||
<p id="check_button_t_check_button_set_value"> 设置控件的值。
|
||||
|
||||
|
||||
|
||||
#### value 属性
|
||||
-----------------------
|
||||
<p id="check_button_t_value"> 值。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
148
docs/manual/children_layouter_t.md
Normal file
148
docs/manual/children_layouter_t.md
Normal file
@ -0,0 +1,148 @@
|
||||
## children\_layouter\_t
|
||||
### 概述
|
||||
子控件排版布局器的接口。
|
||||
按特定算法对子控件进行排版布局。
|
||||
|
||||
### 函数
|
||||
<p id="children_layouter_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#children_layouter_t_children_layouter_destroy">children\_layouter\_destroy</a> | 销毁layouter对象。 |
|
||||
| <a href="#children_layouter_t_children_layouter_get_param">children\_layouter\_get\_param</a> | 获取指定的参数。 |
|
||||
| <a href="#children_layouter_t_children_layouter_get_param_float">children\_layouter\_get\_param\_float</a> | 获取指定的浮点格式的参数。 |
|
||||
| <a href="#children_layouter_t_children_layouter_get_param_int">children\_layouter\_get\_param\_int</a> | 获取指定的整数格式的参数。 |
|
||||
| <a href="#children_layouter_t_children_layouter_is_valid">children\_layouter\_is\_valid</a> | 判断layouter对象是否有效。 |
|
||||
| <a href="#children_layouter_t_children_layouter_layout">children\_layouter\_layout</a> | 对子控件进行Layout。 |
|
||||
| <a href="#children_layouter_t_children_layouter_set_param">children\_layouter\_set\_param</a> | 获取指定的参数。 |
|
||||
| <a href="#children_layouter_t_children_layouter_set_param_str">children\_layouter\_set\_param\_str</a> | 设置字符串格式的参数。 |
|
||||
| <a href="#children_layouter_t_children_layouter_to_string">children\_layouter\_to\_string</a> | 获取全部参数。 |
|
||||
### 属性
|
||||
<p id="children_layouter_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="children_layouter_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### children\_layouter\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| layouter | children\_layouter\_t* | layouter对象。 |
|
||||
<p id="children_layouter_t_children_layouter_destroy"> 销毁layouter对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### children\_layouter\_get\_param 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| layouter | children\_layouter\_t* | layouter对象。 |
|
||||
| name | const char* | 参数名。 |
|
||||
| v | value\_t* | 返回参数的值。 |
|
||||
<p id="children_layouter_t_children_layouter_get_param"> 获取指定的参数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### children\_layouter\_get\_param\_float 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 成功返回参数的值，失败返回缺省值。 |
|
||||
| layouter | children\_layouter\_t* | layouter对象。 |
|
||||
| name | const char* | 参数名。 |
|
||||
| defval | float\_t | 缺省值。 |
|
||||
<p id="children_layouter_t_children_layouter_get_param_float"> 获取指定的浮点格式的参数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### children\_layouter\_get\_param\_int 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 成功返回参数的值，失败返回缺省值。 |
|
||||
| layouter | children\_layouter\_t* | layouter对象。 |
|
||||
| name | const char* | 参数名。 |
|
||||
| defval | int32\_t | 缺省值。 |
|
||||
<p id="children_layouter_t_children_layouter_get_param_int"> 获取指定的整数格式的参数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### children\_layouter\_is\_valid 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回TRUE表示有效，否则表示无效。 |
|
||||
| layouter | children\_layouter\_t* | layouter对象。 |
|
||||
<p id="children_layouter_t_children_layouter_is_valid"> 判断layouter对象是否有效。
|
||||
|
||||
|
||||
|
||||
|
||||
#### children\_layouter\_layout 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| layouter | children\_layouter\_t* | layouter对象。 |
|
||||
| widget | widget\_t* | 控件。 |
|
||||
<p id="children_layouter_t_children_layouter_layout"> 对子控件进行Layout。
|
||||
|
||||
|
||||
|
||||
|
||||
#### children\_layouter\_set\_param 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| layouter | children\_layouter\_t* | layouter对象。 |
|
||||
| name | const char* | 参数名。 |
|
||||
| v | const value\_t* | 参数的值。 |
|
||||
<p id="children_layouter_t_children_layouter_set_param"> 获取指定的参数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### children\_layouter\_set\_param\_str 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| layouter | children\_layouter\_t* | layouter对象。 |
|
||||
| name | const char* | 参数名。 |
|
||||
| value | const char* | 参数值。 |
|
||||
<p id="children_layouter_t_children_layouter_set_param_str"> 设置字符串格式的参数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### children\_layouter\_to\_string 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回字符串格式的参数。 |
|
||||
| layouter | children\_layouter\_t* | layouter对象。 |
|
||||
<p id="children_layouter_t_children_layouter_to_string"> 获取全部参数。
|
||||
|
||||
|
||||
|
||||
|
||||
11
docs/manual/clip_board_data_type_t.md
Normal file
11
docs/manual/clip_board_data_type_t.md
Normal file
@ -0,0 +1,11 @@
|
||||
## clip\_board\_data\_type\_t
|
||||
### 概述
|
||||
剪切板数据类型定义。
|
||||
|
||||
### 常量
|
||||
<p id="clip_board_data_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| CLIP\_BOARD\_DATA\_TYPE\_NONE | 无数据。 |
|
||||
| CLIP\_BOARD\_DATA\_TYPE\_TEXT | UTF8文本。 |
|
||||
127
docs/manual/clip_board_t.md
Normal file
127
docs/manual/clip_board_t.md
Normal file
@ -0,0 +1,127 @@
|
||||
## clip\_board\_t
|
||||
### 概述
|
||||
剪切板接口。
|
||||
|
||||
### 函数
|
||||
<p id="clip_board_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#clip_board_t_clip_board">clip\_board</a> | 获取缺省的剪切板对象。 |
|
||||
| <a href="#clip_board_t_clip_board_clear">clip\_board\_clear</a> | 清空剪切板中的数据。 |
|
||||
| <a href="#clip_board_t_clip_board_destroy">clip\_board\_destroy</a> | 销毁剪切板对象。 |
|
||||
| <a href="#clip_board_t_clip_board_get_data">clip\_board\_get\_data</a> | 从剪切板中获取数据。 |
|
||||
| <a href="#clip_board_t_clip_board_get_text">clip\_board\_get\_text</a> | 从剪切板中获取文本(UTF8)数据。 |
|
||||
| <a href="#clip_board_t_clip_board_set">clip\_board\_set</a> | 设置缺省的剪切板对象。 |
|
||||
| <a href="#clip_board_t_clip_board_set_data">clip\_board\_set\_data</a> | 设置数据到剪切板中。 |
|
||||
| <a href="#clip_board_t_clip_board_set_text">clip\_board\_set\_text</a> | 设置文本(UTF8)数据到剪切板。 |
|
||||
### 属性
|
||||
<p id="clip_board_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="clip_board_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### clip\_board 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回缺省剪切板对象。 |
|
||||
<p id="clip_board_t_clip_board"> 获取缺省的剪切板对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### clip\_board\_clear 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| cl | clip\_board\_t* | 剪切板对象。 |
|
||||
<p id="clip_board_t_clip_board_clear"> 清空剪切板中的数据。
|
||||
|
||||
|
||||
|
||||
|
||||
#### clip\_board\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| cl | clip\_board\_t* | 剪切板对象。 |
|
||||
<p id="clip_board_t_clip_board_destroy"> 销毁剪切板对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### clip\_board\_get\_data 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| cl | clip\_board\_t* | 剪切板对象。 |
|
||||
| type | clip\_board\_data\_type\_t* | 返回数据类型(可为NULL)。 |
|
||||
| data | void** data | 返回数据(可为NULL)。 |
|
||||
| size | uint32\_t* | 返回数据长度(可为NULL)。 |
|
||||
<p id="clip_board_t_clip_board_get_data"> 从剪切板中获取数据。
|
||||
|
||||
|
||||
|
||||
|
||||
#### clip\_board\_get\_text 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回文本数据。 |
|
||||
<p id="clip_board_t_clip_board_get_text"> 从剪切板中获取文本(UTF8)数据。
|
||||
|
||||
|
||||
|
||||
|
||||
#### clip\_board\_set 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| cl | clip\_board\_t* | 剪切板对象。 |
|
||||
<p id="clip_board_t_clip_board_set"> 设置缺省的剪切板对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### clip\_board\_set\_data 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| cl | clip\_board\_t* | 剪切板对象。 |
|
||||
| type | clip\_board\_data\_type\_t | 数据类型。 |
|
||||
| data | const void* data | 数据。 |
|
||||
| size | uint32\_t | 数据长度 |
|
||||
<p id="clip_board_t_clip_board_set_data"> 设置数据到剪切板中。
|
||||
|
||||
|
||||
|
||||
|
||||
#### clip\_board\_set\_text 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| text | const char* | 文本。 |
|
||||
<p id="clip_board_t_clip_board_set_text"> 设置文本(UTF8)数据到剪切板。
|
||||
|
||||
|
||||
|
||||
|
||||
88
docs/manual/color_component_t.md
Normal file
88
docs/manual/color_component_t.md
Normal file
@ -0,0 +1,88 @@
|
||||
## color\_component\_t
|
||||
### 概述
|
||||
颜色选择器的颜色分量。
|
||||
控件的名称有严格规定：
|
||||
COLOR_PICKER_CHILD_SV: 水平为Value/Brightness(递增)，垂直为Saturation(递减)。
|
||||
COLOR_PICKER_CHILD_H: 水平为同色，垂直为Hue(递减)。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="color_component_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#color_component_t_color_component_create">color\_component\_create</a> | 创建color_component对象
|
|
||||
| <a href="#color_component_t_color_component_get_h">color\_component\_get\_h</a> | 获取h分量。
|
|
||||
| <a href="#color_component_t_color_component_get_s">color\_component\_get\_s</a> | 获取s分量。
|
|
||||
| <a href="#color_component_t_color_component_get_v">color\_component\_get\_v</a> | 获取v分量。
|
|
||||
| <a href="#color_component_t_color_component_set_color">color\_component\_set\_color</a> | 设置颜色。
|
|
||||
### 属性
|
||||
<p id="color_component_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="color_component_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### color\_component\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="color_component_t_color_component_create"> 创建color_component对象
|
||||
|
||||
|
||||
|
||||
#### color\_component\_get\_h 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | float | 返回h分量。 |
|
||||
| widget | widget\_t* | color\_component对象。 |
|
||||
<p id="color_component_t_color_component_get_h"> 获取h分量。
|
||||
|
||||
|
||||
|
||||
#### color\_component\_get\_s 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | float | 返回s分量。 |
|
||||
| widget | widget\_t* | color\_component对象。 |
|
||||
<p id="color_component_t_color_component_get_s"> 获取s分量。
|
||||
|
||||
|
||||
|
||||
#### color\_component\_get\_v 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | float | 返回v分量。 |
|
||||
| widget | widget\_t* | color\_component对象。 |
|
||||
<p id="color_component_t_color_component_get_v"> 获取v分量。
|
||||
|
||||
|
||||
|
||||
#### color\_component\_set\_color 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| c | color\_t | 颜色。 |
|
||||
<p id="color_component_t_color_component_set_color"> 设置颜色。
|
||||
|
||||
|
||||
|
||||
90
docs/manual/color_picker_t.md
Normal file
90
docs/manual/color_picker_t.md
Normal file
@ -0,0 +1,90 @@
|
||||
## color\_picker\_t
|
||||
### 概述
|
||||
颜色选择器。 其中的控件必须按下列规则命名：
|
||||
COLOR_PICKER_CHILD_R 红色分量。可以是spin_box、edit和slider。
|
||||
COLOR_PICKER_CHILD_G 绿色分量。可以是spin_box、edit和slider。
|
||||
COLOR_PICKER_CHILD_B 蓝色分量。可以是spin_box、edit和slider。
|
||||
COLOR_PICKER_CHILD_H Hue分量。可以是spin_box、edit、slider和color_component。
|
||||
COLOR_PICKER_CHILD_S Saturation分量。可以是spin_box、edit和slider。
|
||||
COLOR_PICKER_CHILD_V Value/Brightness分量。可以是spin_box、edit和slider。
|
||||
COLOR_PICKER_CHILD_SV Saturation和Value/Brightness分量。可以是color_component。
|
||||
COLOR_PICKER_CHILD_OLD 旧的值。可以是spin_box、edit和color_tile。
|
||||
COLOR_PICKER_CHILD_NEW 新的值。可以是spin_box、edit和color_tile。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="color_picker_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#color_picker_t_color_picker_cast">color\_picker\_cast</a> | 转换为color_picker对象(供脚本语言使用)。
|
|
||||
| <a href="#color_picker_t_color_picker_create">color\_picker\_create</a> | 创建color_picker对象
|
|
||||
| <a href="#color_picker_t_color_picker_set_color">color\_picker\_set\_color</a> | 设置颜色。
|
|
||||
### 属性
|
||||
<p id="color_picker_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#color_picker_t_value">value</a> | const char* | 颜色。
|
|
||||
### 事件
|
||||
<p id="color_picker_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(颜色)即将改变事件。 |
|
||||
| EVT\_VALUE\_CHANGED | event\_t | 值(颜色)改变事件。 |
|
||||
#### color\_picker\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | color\_picker对象。 |
|
||||
| widget | widget\_t* | color\_picker对象。 |
|
||||
<p id="color_picker_t_color_picker_cast"> 转换为color_picker对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### color\_picker\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="color_picker_t_color_picker_create"> 创建color_picker对象
|
||||
|
||||
|
||||
|
||||
#### color\_picker\_set\_color 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| color | const char* | 颜色。 |
|
||||
<p id="color_picker_t_color_picker_set_color"> 设置颜色。
|
||||
|
||||
|
||||
|
||||
#### value 属性
|
||||
-----------------------
|
||||
<p id="color_picker_t_value"> 颜色。
|
||||
|
||||
|
||||
* 类型：const char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
123
docs/manual/color_tile_t.md
Normal file
123
docs/manual/color_tile_t.md
Normal file
@ -0,0 +1,123 @@
|
||||
## color\_tile\_t
|
||||
### 概述
|
||||
色块控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="color_tile_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#color_tile_t_color_tile_cast">color\_tile\_cast</a> | 转换为color_tile对象(供脚本语言使用)。
|
|
||||
| <a href="#color_tile_t_color_tile_create">color\_tile\_create</a> | 创建color_tile对象
|
|
||||
| <a href="#color_tile_t_color_tile_set_bg_color">color\_tile\_set\_bg\_color</a> | 设置背景颜色。
|
|
||||
| <a href="#color_tile_t_color_tile_set_border_color">color\_tile\_set\_border\_color</a> | 设置边框颜色。
|
|
||||
| <a href="#color_tile_t_color_tile_set_value">color\_tile\_set\_value</a> | 设置背景颜色。
|
|
||||
### 属性
|
||||
<p id="color_tile_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#color_tile_t_bg_color">bg\_color</a> | const char* | 背景颜色。
|
|
||||
| <a href="#color_tile_t_border_color">border\_color</a> | const char* | 边框颜色。
|
|
||||
### 事件
|
||||
<p id="color_tile_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### color\_tile\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | color\_tile对象。 |
|
||||
| widget | widget\_t* | color\_tile对象。 |
|
||||
<p id="color_tile_t_color_tile_cast"> 转换为color_tile对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### color\_tile\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="color_tile_t_color_tile_create"> 创建color_tile对象
|
||||
|
||||
|
||||
|
||||
#### color\_tile\_set\_bg\_color 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| color | const char* | 背景颜色。 |
|
||||
<p id="color_tile_t_color_tile_set_bg_color"> 设置背景颜色。
|
||||
|
||||
|
||||
|
||||
#### color\_tile\_set\_border\_color 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| color | const char* | 边框颜色。 |
|
||||
<p id="color_tile_t_color_tile_set_border_color"> 设置边框颜色。
|
||||
|
||||
|
||||
|
||||
#### color\_tile\_set\_value 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| color | color\_t | 背景颜色。 |
|
||||
<p id="color_tile_t_color_tile_set_value"> 设置背景颜色。
|
||||
|
||||
|
||||
|
||||
#### bg\_color 属性
|
||||
-----------------------
|
||||
<p id="color_tile_t_bg_color"> 背景颜色。
|
||||
|
||||
|
||||
* 类型：const char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### border\_color 属性
|
||||
-----------------------
|
||||
<p id="color_tile_t_border_color"> 边框颜色。
|
||||
|
||||
|
||||
* 类型：const char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
49
docs/manual/column_t.md
Normal file
49
docs/manual/column_t.md
Normal file
@ -0,0 +1,49 @@
|
||||
## column\_t
|
||||
### 概述
|
||||
column。一个简单的容器控件，垂直排列一组控件。
|
||||
它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="column_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#column_t_column_cast">column\_cast</a> | 转换为column对象(供脚本语言使用)。
|
|
||||
| <a href="#column_t_column_create">column\_create</a> | 创建column对象
|
|
||||
### 属性
|
||||
<p id="column_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="column_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### column\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | column对象。 |
|
||||
| widget | widget\_t* | column对象。 |
|
||||
<p id="column_t_column_cast"> 转换为column对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### column\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="column_t_column_create"> 创建column对象
|
||||
|
||||
|
||||
|
||||
112
docs/manual/combo_box_item_t.md
Normal file
112
docs/manual/combo_box_item_t.md
Normal file
@ -0,0 +1,112 @@
|
||||
## combo\_box\_item\_t
|
||||
### 概述
|
||||
ComboBox Item控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="combo_box_item_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#combo_box_item_t_combo_box_item_cast">combo\_box\_item\_cast</a> | 转换combo_box_item对象(供脚本语言使用)。
|
|
||||
| <a href="#combo_box_item_t_combo_box_item_create">combo\_box\_item\_create</a> | 创建combo_box_item对象
|
|
||||
| <a href="#combo_box_item_t_combo_box_item_set_checked">combo\_box\_item\_set\_checked</a> | 设置控件是否被选中。
|
|
||||
| <a href="#combo_box_item_t_combo_box_item_set_value">combo\_box\_item\_set\_value</a> | 设置控件的值。
|
|
||||
### 属性
|
||||
<p id="combo_box_item_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#combo_box_item_t_checked">checked</a> | bool_t | 是否被选中。
|
|
||||
| <a href="#combo_box_item_t_value">value</a> | int32_t | 值。
|
|
||||
### 事件
|
||||
<p id="combo_box_item_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(勾选状态)即将改变事件。 |
|
||||
| EVT\_VALUE\_CHANGED | event\_t | 值(勾选状态)改变事件。 |
|
||||
#### combo\_box\_item\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | combo\_box\_item对象。 |
|
||||
| widget | widget\_t* | combo\_box\_item对象。 |
|
||||
<p id="combo_box_item_t_combo_box_item_cast"> 转换combo_box_item对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_item\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="combo_box_item_t_combo_box_item_create"> 创建combo_box_item对象
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_item\_set\_checked 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | combo\_box\_item对象。 |
|
||||
| checked | bool\_t | 是否被选中。 |
|
||||
<p id="combo_box_item_t_combo_box_item_set_checked"> 设置控件是否被选中。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_item\_set\_value 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | combo\_box\_item对象。 |
|
||||
| value | int32\_t | 值 |
|
||||
<p id="combo_box_item_t_combo_box_item_set_value"> 设置控件的值。
|
||||
|
||||
|
||||
|
||||
#### checked 属性
|
||||
-----------------------
|
||||
<p id="combo_box_item_t_checked"> 是否被选中。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### value 属性
|
||||
-----------------------
|
||||
<p id="combo_box_item_t_value"> 值。
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
236
docs/manual/combo_box_t.md
Normal file
236
docs/manual/combo_box_t.md
Normal file
@ -0,0 +1,236 @@
|
||||
## combo\_box\_t
|
||||
### 概述
|
||||
combobox控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="combo_box_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#combo_box_t_combo_box_append_option">combo\_box\_append\_option</a> | 追加一个选项。
|
|
||||
| <a href="#combo_box_t_combo_box_cast">combo\_box\_cast</a> | 转换combo_box对象(供脚本语言使用)。
|
|
||||
| <a href="#combo_box_t_combo_box_count_options">combo\_box\_count\_options</a> | 获取选项个数。
|
|
||||
| <a href="#combo_box_t_combo_box_create">combo\_box\_create</a> | 创建combo_box对象
|
|
||||
| <a href="#combo_box_t_combo_box_get_option">combo\_box\_get\_option</a> | 获取第index个选项。
|
|
||||
| <a href="#combo_box_t_combo_box_get_text">combo\_box\_get\_text</a> | 获取combo_box的文本。
|
|
||||
| <a href="#combo_box_t_combo_box_get_value">combo\_box\_get\_value</a> | 获取combo_box的值。
|
|
||||
| <a href="#combo_box_t_combo_box_reset_options">combo\_box\_reset\_options</a> | 重置所有选项。
|
|
||||
| <a href="#combo_box_t_combo_box_set_open_window">combo\_box\_set\_open\_window</a> | 点击按钮时可以打开popup窗口，本函数可设置窗口的名称。
|
|
||||
| <a href="#combo_box_t_combo_box_set_options">combo\_box\_set\_options</a> | 设置选项。
|
|
||||
| <a href="#combo_box_t_combo_box_set_selected_index">combo\_box\_set\_selected\_index</a> | 设置第index个选项为当前选中的选项。
|
|
||||
### 属性
|
||||
<p id="combo_box_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#combo_box_t_open_window">open\_window</a> | char* | 为点击按钮时，要打开窗口的名称。
|
|
||||
| <a href="#combo_box_t_options">options</a> | char* | 设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。
|
|
||||
| <a href="#combo_box_t_selected_index">selected\_index</a> | int32_t | 当前选中的选项。
|
|
||||
| <a href="#combo_box_t_value">value</a> | int32_t | 值。
|
|
||||
### 事件
|
||||
<p id="combo_box_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
| EVT\_VALUE\_WILL\_CHANGE | event\_t | 值即将改变事件。 |
|
||||
| EVT\_VALUE\_CHANGED | event\_t | 值改变事件。 |
|
||||
#### combo\_box\_append\_option 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
| value | int32\_t | 值。 |
|
||||
| text | char* | 文本。 |
|
||||
<p id="combo_box_t_combo_box_append_option"> 追加一个选项。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | combo\_box对象。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
<p id="combo_box_t_combo_box_cast"> 转换combo_box对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_count\_options 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回选项个数。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
<p id="combo_box_t_combo_box_count_options"> 获取选项个数。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="combo_box_t_combo_box_create"> 创建combo_box对象
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_get\_option 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | combo\_box\_option\_t* | 返回index个选项。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
| index | uint32\_t | 选项的索引。 |
|
||||
<p id="combo_box_t_combo_box_get_option"> 获取第index个选项。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_get\_text 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | char* | 返回文本。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
<p id="combo_box_t_combo_box_get_text"> 获取combo_box的文本。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_get\_value 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回值。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
<p id="combo_box_t_combo_box_get_value"> 获取combo_box的值。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_reset\_options 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
<p id="combo_box_t_combo_box_reset_options"> 重置所有选项。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_set\_open\_window 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
| open\_window | char* | 弹出窗口的名称。 |
|
||||
<p id="combo_box_t_combo_box_set_open_window"> 点击按钮时可以打开popup窗口，本函数可设置窗口的名称。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_set\_options 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
| options | char* | 选项。 |
|
||||
<p id="combo_box_t_combo_box_set_options"> 设置选项。
|
||||
|
||||
|
||||
|
||||
#### combo\_box\_set\_selected\_index 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
| index | uint32\_t | 选项的索引。 |
|
||||
<p id="combo_box_t_combo_box_set_selected_index"> 设置第index个选项为当前选中的选项。
|
||||
|
||||
|
||||
|
||||
#### open\_window 属性
|
||||
-----------------------
|
||||
<p id="combo_box_t_open_window"> 为点击按钮时，要打开窗口的名称。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### options 属性
|
||||
-----------------------
|
||||
<p id="combo_box_t_options"> 设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### selected\_index 属性
|
||||
-----------------------
|
||||
<p id="combo_box_t_selected_index"> 当前选中的选项。
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### value 属性
|
||||
-----------------------
|
||||
<p id="combo_box_t_value"> 值。
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
18
docs/manual/custom_prop_t.md
Normal file
18
docs/manual/custom_prop_t.md
Normal file
@ -0,0 +1,18 @@
|
||||
## custom\_prop\_t
|
||||
### 概述
|
||||
widget自定义属性。
|
||||
### 函数
|
||||
<p id="custom_prop_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
### 属性
|
||||
<p id="custom_prop_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="custom_prop_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
70
docs/manual/custom_props_t.md
Normal file
70
docs/manual/custom_props_t.md
Normal file
@ -0,0 +1,70 @@
|
||||
## custom\_props\_t
|
||||
### 概述
|
||||
widget自定义属性集合。
|
||||
### 函数
|
||||
<p id="custom_props_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#custom_props_t_custom_props_create">custom\_props\_create</a> | 创建custom_props对象
|
|
||||
| <a href="#custom_props_t_custom_props_destroy">custom\_props\_destroy</a> | 销毁属性集合。
|
|
||||
| <a href="#custom_props_t_custom_props_get">custom\_props\_get</a> | 获取属性的值。
|
|
||||
| <a href="#custom_props_t_custom_props_set">custom\_props\_set</a> | 设置属性的值。
|
|
||||
### 属性
|
||||
<p id="custom_props_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="custom_props_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### custom\_props\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | custom\_props\_t* | custom\_props对象。 |
|
||||
| capacity | uint32\_t | 初始容量。 |
|
||||
<p id="custom_props_t_custom_props_create"> 创建custom_props对象
|
||||
|
||||
|
||||
|
||||
#### custom\_props\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| props | custom\_props\_t | 属性集合对象。 |
|
||||
<p id="custom_props_t_custom_props_destroy"> 销毁属性集合。
|
||||
|
||||
|
||||
|
||||
#### custom\_props\_get 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| props | custom\_props\_t | 属性集合对象。 |
|
||||
| name | char* | 属性的名称。 |
|
||||
| v | value\_t* | 用于返回属性的值。 |
|
||||
<p id="custom_props_t_custom_props_get"> 获取属性的值。
|
||||
|
||||
|
||||
|
||||
#### custom\_props\_set 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| props | custom\_props\_t | 属性集合对象。 |
|
||||
| name | char* | 属性的名称。 |
|
||||
| v | value\_t* | 属性的值。 |
|
||||
<p id="custom_props_t_custom_props_set"> 设置属性的值。
|
||||
|
||||
|
||||
|
||||
184
docs/manual/date_time_t.md
Normal file
184
docs/manual/date_time_t.md
Normal file
@ -0,0 +1,184 @@
|
||||
## date\_time\_t
|
||||
### 概述
|
||||
日期时间。
|
||||
|
||||
### 函数
|
||||
<p id="date_time_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#date_time_t_date_time_create">date\_time\_create</a> | 创建date_time对象，并初始为当前日期和时间(一般供脚本语言中使用)。 |
|
||||
| <a href="#date_time_t_date_time_date_time_set_impl">date\_time\_date\_time\_set\_impl</a> | 设置获取当前日期和时间的函数。 |
|
||||
| <a href="#date_time_t_date_time_destroy">date\_time\_destroy</a> | 销毁date_time对象(一般供脚本语言中使用)。 |
|
||||
| <a href="#date_time_t_date_time_init">date\_time\_init</a> | 初始为当前日期和时间。 |
|
||||
### 属性
|
||||
<p id="date_time_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#date_time_t_day">day</a> | int32_t | 日(1-31)。 |
|
||||
| <a href="#date_time_t_hour">hour</a> | int32_t | 时(0 - 23)。 |
|
||||
| <a href="#date_time_t_minute">minute</a> | int32_t | 分(0 - 59)。 |
|
||||
| <a href="#date_time_t_month">month</a> | int32_t | 月(1-12)。 |
|
||||
| <a href="#date_time_t_second">second</a> | int32_t | 秒(0 - 59)。 |
|
||||
| <a href="#date_time_t_year">year</a> | int32_t | 年。 |
|
||||
### 事件
|
||||
<p id="date_time_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### date\_time\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | date\_time\_t* | 返回date\_time对象。 |
|
||||
<p id="date_time_t_date_time_create"> 创建date_time对象，并初始为当前日期和时间(一般供脚本语言中使用)。
|
||||
|
||||
|
||||
|
||||
|
||||
#### date\_time\_date\_time\_set\_impl 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| date\_time\_get\_now | date\_time\_get\_now\_t | 获取当前日期和时间的函数。 |
|
||||
<p id="date_time_t_date_time_date_time_set_impl"> 设置获取当前日期和时间的函数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### date\_time\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
<p id="date_time_t_date_time_destroy"> 销毁date_time对象(一般供脚本语言中使用)。
|
||||
|
||||
|
||||
|
||||
|
||||
#### date\_time\_init 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | date\_time\_t* | 返回date\_time对象。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
<p id="date_time_t_date_time_init"> 初始为当前日期和时间。
|
||||
|
||||
|
||||
|
||||
|
||||
#### day 属性
|
||||
-----------------------
|
||||
<p id="date_time_t_day"> 日(1-31)。
|
||||
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### hour 属性
|
||||
-----------------------
|
||||
<p id="date_time_t_hour"> 时(0 - 23)。
|
||||
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### minute 属性
|
||||
-----------------------
|
||||
<p id="date_time_t_minute"> 分(0 - 59)。
|
||||
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### month 属性
|
||||
-----------------------
|
||||
<p id="date_time_t_month"> 月(1-12)。
|
||||
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### second 属性
|
||||
-----------------------
|
||||
<p id="date_time_t_second"> 秒(0 - 59)。
|
||||
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### year 属性
|
||||
-----------------------
|
||||
<p id="date_time_t_year"> 年。
|
||||
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
48
docs/manual/dialog_client_t.md
Normal file
48
docs/manual/dialog_client_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## dialog\_client\_t
|
||||
### 概述
|
||||
对话框客户区控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="dialog_client_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#dialog_client_t_dialog_client_cast">dialog\_client\_cast</a> | 转换为dialog_client对象(供脚本语言使用)。
|
|
||||
| <a href="#dialog_client_t_dialog_client_create">dialog\_client\_create</a> | 创建dialog对象。
|
|
||||
### 属性
|
||||
<p id="dialog_client_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="dialog_client_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### dialog\_client\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | dialog\_client对象。 |
|
||||
| widget | widget\_t* | dialog\_client对象。 |
|
||||
<p id="dialog_client_t_dialog_client_cast"> 转换为dialog_client对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### dialog\_client\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | dialog对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="dialog_client_t_dialog_client_create"> 创建dialog对象。
|
||||
|
||||
|
||||
|
||||
139
docs/manual/dialog_t.md
Normal file
139
docs/manual/dialog_t.md
Normal file
@ -0,0 +1,139 @@
|
||||
## dialog\_t
|
||||
### 概述
|
||||
对话框控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="dialog_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#dialog_t_dialog_cast">dialog\_cast</a> | 转换dialog对象(供脚本语言使用)。
|
|
||||
| <a href="#dialog_t_dialog_create">dialog\_create</a> | 创建dialog对象。
|
|
||||
| <a href="#dialog_t_dialog_create_simple">dialog\_create\_simple</a> | 创建dialog对象，同时创建title/client。
|
|
||||
| <a href="#dialog_t_dialog_get_client">dialog\_get\_client</a> | 获取client控件。
|
|
||||
| <a href="#dialog_t_dialog_get_title">dialog\_get\_title</a> | 获取title控件。
|
|
||||
| <a href="#dialog_t_dialog_modal">dialog\_modal</a> | 模态显示对话框。
|
|
||||
| <a href="#dialog_t_dialog_open">dialog\_open</a> | 从资源文件中加载并创建Dialog对象。本函数在ui_loader/ui_builder_default里实现。
|
|
||||
| <a href="#dialog_t_dialog_quit">dialog\_quit</a> | 退出模态显示。
|
|
||||
| <a href="#dialog_t_dialog_set_title">dialog\_set\_title</a> | 设置对话框的标题文本。
|
|
||||
### 属性
|
||||
<p id="dialog_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="dialog_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### dialog\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | dialog对象。 |
|
||||
| widget | widget\_t* | dialog对象。 |
|
||||
<p id="dialog_t_dialog_cast"> 转换dialog对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### dialog\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | dialog对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="dialog_t_dialog_create"> 创建dialog对象。
|
||||
|
||||
|
||||
|
||||
#### dialog\_create\_simple 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | dialog对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="dialog_t_dialog_create_simple"> 创建dialog对象，同时创建title/client。
|
||||
|
||||
|
||||
|
||||
#### dialog\_get\_client 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | client对象。 |
|
||||
| widget | widget\_t* | dialog对象。 |
|
||||
<p id="dialog_t_dialog_get_client"> 获取client控件。
|
||||
|
||||
|
||||
|
||||
#### dialog\_get\_title 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | title对象。 |
|
||||
| widget | widget\_t* | dialog对象。 |
|
||||
<p id="dialog_t_dialog_get_title"> 获取title控件。
|
||||
|
||||
|
||||
|
||||
#### dialog\_modal 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | dialog对象。 |
|
||||
<p id="dialog_t_dialog_modal"> 模态显示对话框。
|
||||
dialog_modal返回后，dialog对象将在下一个idle函数中回收，也就是在dialog_modal调用完成后仍然可以访问dialog中控件，直到本次事件结束。
|
||||
|
||||
|
||||
|
||||
#### dialog\_open 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| name | char* | dialog的名称。 |
|
||||
<p id="dialog_t_dialog_open"> 从资源文件中加载并创建Dialog对象。本函数在ui_loader/ui_builder_default里实现。
|
||||
|
||||
|
||||
|
||||
#### dialog\_quit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | dialog对象。 |
|
||||
| code | uint32\_t | 退出码，作为dialog\_modal的返回值。 |
|
||||
<p id="dialog_t_dialog_quit"> 退出模态显示。
|
||||
|
||||
|
||||
|
||||
#### dialog\_set\_title 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | dialog对象。 |
|
||||
| title | char* | 标题。 |
|
||||
<p id="dialog_t_dialog_set_title"> 设置对话框的标题文本。
|
||||
|
||||
|
||||
|
||||
48
docs/manual/dialog_title_t.md
Normal file
48
docs/manual/dialog_title_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## dialog\_title\_t
|
||||
### 概述
|
||||
对话框标题控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="dialog_title_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#dialog_title_t_dialog_title_cast">dialog\_title\_cast</a> | 转换为dialog_title对象(供脚本语言使用)。
|
|
||||
| <a href="#dialog_title_t_dialog_title_create">dialog\_title\_create</a> | 创建dialog对象。
|
|
||||
### 属性
|
||||
<p id="dialog_title_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="dialog_title_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### dialog\_title\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | dialog\_title对象。 |
|
||||
| widget | widget\_t* | dialog\_title对象。 |
|
||||
<p id="dialog_title_t_dialog_title_cast"> 转换为dialog_title对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### dialog\_title\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | dialog对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="dialog_title_t_dialog_title_create"> 创建dialog对象。
|
||||
|
||||
|
||||
|
||||
97
docs/manual/digit_clock_t.md
Normal file
97
docs/manual/digit_clock_t.md
Normal file
@ -0,0 +1,97 @@
|
||||
## digit\_clock\_t
|
||||
### 概述
|
||||
数字时钟控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="digit_clock_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#digit_clock_t_digit_clock_cast">digit\_clock\_cast</a> | 转换为digit_clock对象(供脚本语言使用)。
|
|
||||
| <a href="#digit_clock_t_digit_clock_create">digit\_clock\_create</a> | 创建digit_clock对象
|
|
||||
| <a href="#digit_clock_t_digit_clock_set_format">digit\_clock\_set\_format</a> | 设置显示格式。
|
|
||||
### 属性
|
||||
<p id="digit_clock_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#digit_clock_t_format">format</a> | char* | 显示格式。
|
|
||||
### 事件
|
||||
<p id="digit_clock_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### digit\_clock\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | digit\_clock对象。 |
|
||||
| widget | widget\_t* | digit\_clock对象。 |
|
||||
<p id="digit_clock_t_digit_clock_cast"> 转换为digit_clock对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### digit\_clock\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="digit_clock_t_digit_clock_create"> 创建digit_clock对象
|
||||
|
||||
|
||||
|
||||
#### digit\_clock\_set\_format 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| format | const char* | 格式。 |
|
||||
<p id="digit_clock_t_digit_clock_set_format"> 设置显示格式。
|
||||
|
||||
|
||||
|
||||
#### format 属性
|
||||
-----------------------
|
||||
<p id="digit_clock_t_format"> 显示格式。
|
||||
Y 代表年(完整显示)
|
||||
M 代表月(1-12)
|
||||
D 代表日(1-31)
|
||||
h 代表时(0-23)
|
||||
m 代表分(0-59)
|
||||
s 代表秒(0-59)
|
||||
YY 代表年(只显示末两位)
|
||||
MM 代表月(01-12)
|
||||
DD 代表日(01-31)
|
||||
hh 代表时(00-23)
|
||||
mm 代表分(00-59)
|
||||
ss 代表秒(00-59)
|
||||
|
||||
如 日期时间为：2018/11/12 9:10:20
|
||||
"Y/D/M"显示为"2018/11/12"
|
||||
"Y-D-M"显示为"2018-11-12"
|
||||
"Y-D-M h:m:s"显示为"2018-11-12 9:10:20"
|
||||
"Y-D-M hh:mm:ss"显示为"2018-11-12 09:10:20"
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
136
docs/manual/dragger_t.md
Normal file
136
docs/manual/dragger_t.md
Normal file
@ -0,0 +1,136 @@
|
||||
## dragger\_t
|
||||
### 概述
|
||||
dragger控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="dragger_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#dragger_t_dragger_cast">dragger\_cast</a> | 转换为dragger对象(供脚本语言使用)。
|
|
||||
| <a href="#dragger_t_dragger_create">dragger\_create</a> | 创建dragger对象。
|
|
||||
| <a href="#dragger_t_dragger_set_range">dragger\_set\_range</a> | 设置拖动的范围。
|
|
||||
### 属性
|
||||
<p id="dragger_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#dragger_t_x_max">x\_max</a> | xy_t | x坐标的最大值。
|
|
||||
| <a href="#dragger_t_x_min">x\_min</a> | xy_t | x坐标的最小值。
|
|
||||
| <a href="#dragger_t_y_max">y\_max</a> | xy_t | y坐标的最大值。
|
|
||||
| <a href="#dragger_t_y_min">y\_min</a> | xy_t | y坐标的最小值。
|
|
||||
### 事件
|
||||
<p id="dragger_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### dragger\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | dragger对象。 |
|
||||
| widget | widget\_t* | dragger对象。 |
|
||||
<p id="dragger_t_dragger_cast"> 转换为dragger对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### dragger\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="dragger_t_dragger_create"> 创建dragger对象。
|
||||
|
||||
|
||||
|
||||
#### dragger\_set\_range 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| widget | widget\_t* | dragger控件。 |
|
||||
| x\_min | xy\_t | x坐标最小值。 |
|
||||
| y\_min | xy\_t | y坐标最小值。 |
|
||||
| x\_max | xy\_t | x坐标最大值。 |
|
||||
| y\_max | xy\_t | y坐标最大值。 |
|
||||
<p id="dragger_t_dragger_set_range"> 设置拖动的范围。
|
||||
|
||||
|
||||
|
||||
#### x\_max 属性
|
||||
-----------------------
|
||||
<p id="dragger_t_x_max"> x坐标的最大值。
|
||||
|
||||
|
||||
* 类型：xy\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### x\_min 属性
|
||||
-----------------------
|
||||
<p id="dragger_t_x_min"> x坐标的最小值。
|
||||
|
||||
|
||||
* 类型：xy\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### y\_max 属性
|
||||
-----------------------
|
||||
<p id="dragger_t_y_max"> y坐标的最大值。
|
||||
|
||||
|
||||
* 类型：xy\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### y\_min 属性
|
||||
-----------------------
|
||||
<p id="dragger_t_y_min"> y坐标的最小值。
|
||||
|
||||
|
||||
* 类型：xy\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
425
docs/manual/edit_t.md
Normal file
425
docs/manual/edit_t.md
Normal file
@ -0,0 +1,425 @@
|
||||
## edit\_t
|
||||
### 概述
|
||||
文本控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="edit_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#edit_t_edit_cast">edit\_cast</a> | 转换为edit对象(供脚本语言使用)。
|
|
||||
| <a href="#edit_t_edit_create">edit\_create</a> | 创建edit对象
|
|
||||
| <a href="#edit_t_edit_get_double">edit\_get\_double</a> | 获取double类型的值。
|
|
||||
| <a href="#edit_t_edit_get_int">edit\_get\_int</a> | 获取int类型的值。
|
|
||||
| <a href="#edit_t_edit_set_auto_fix">edit\_set\_auto\_fix</a> | 设置编辑器是否为自动改正。
|
|
||||
| <a href="#edit_t_edit_set_double">edit\_set\_double</a> | 设置double类型的值。
|
|
||||
| <a href="#edit_t_edit_set_float_limit">edit\_set\_float\_limit</a> | 设置为浮点数输入及取值范围。
|
|
||||
| <a href="#edit_t_edit_set_input_tips">edit\_set\_input\_tips</a> | 设置编辑器的输入提示。
|
|
||||
| <a href="#edit_t_edit_set_input_type">edit\_set\_input\_type</a> | 设置编辑器的输入类型。
|
|
||||
| <a href="#edit_t_edit_set_int">edit\_set\_int</a> | 设置int类型的值。
|
|
||||
| <a href="#edit_t_edit_set_int_limit">edit\_set\_int\_limit</a> | 设置为整数输入及取值范围。
|
|
||||
| <a href="#edit_t_edit_set_password_visible">edit\_set\_password\_visible</a> | 当编辑器输入类型为密码时，设置密码是否可见。
|
|
||||
| <a href="#edit_t_edit_set_readonly">edit\_set\_readonly</a> | 设置编辑器是否为只读。
|
|
||||
| <a href="#edit_t_edit_set_text_limit">edit\_set\_text\_limit</a> | 设置为文本输入及其长度限制，不允许输入超过max个字符，少于min个字符时进入error状态。
|
|
||||
### 属性
|
||||
<p id="edit_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#edit_t_auto_fix">auto\_fix</a> | bool_t | 输入无效时，是否自动改正。
|
|
||||
| <a href="#edit_t_bottom_margin">bottom\_margin</a> | uint8_t | 下边距。
|
|
||||
| <a href="#edit_t_input_type">input\_type</a> | input_type_t | 输入类型。XXX：需要在min/max/step之前设置。
|
|
||||
| <a href="#edit_t_left_margin">left\_margin</a> | uint8_t | 左边距。
|
|
||||
| <a href="#edit_t_max">max</a> | char* | 最大值或最大长度。
|
|
||||
| <a href="#edit_t_min">min</a> | char* | 最小值或最小长度。
|
|
||||
| <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_step">step</a> | char* | 步长。
|
|
||||
| <a href="#edit_t_tips">tips</a> | char* | 输入提示。
|
|
||||
| <a href="#edit_t_top_margin">top\_margin</a> | uint8_t | 上边距。
|
|
||||
### 事件
|
||||
<p id="edit_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
| EVT\_VALUE\_CHANGING | event\_t | 文本正在改变事件(编辑中)。 |
|
||||
| EVT\_VALUE\_CHANGED | event\_t | 文本改变事件。 |
|
||||
#### edit\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | edit对象。 |
|
||||
| widget | widget\_t* | edit对象。 |
|
||||
<p id="edit_t_edit_cast"> 转换为edit对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### edit\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="edit_t_edit_create"> 创建edit对象
|
||||
|
||||
|
||||
|
||||
#### edit\_get\_double 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | double | 返回double的值。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
<p id="edit_t_edit_get_double"> 获取double类型的值。
|
||||
|
||||
|
||||
|
||||
#### edit\_get\_int 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回int的值。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
<p id="edit_t_edit_get_int"> 获取int类型的值。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_auto\_fix 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| auto\_fix | bool\_t | 自动改正。 |
|
||||
<p id="edit_t_edit_set_auto_fix"> 设置编辑器是否为自动改正。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_double 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| value | double | 值。 |
|
||||
<p id="edit_t_edit_set_double"> 设置double类型的值。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_float\_limit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| min | double | 最小值。 |
|
||||
| max | double | 最大值。 |
|
||||
| step | double | 步长。 |
|
||||
<p id="edit_t_edit_set_float_limit"> 设置为浮点数输入及取值范围。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_input\_tips 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| tips | char* | 输入提示。 |
|
||||
<p id="edit_t_edit_set_input_tips"> 设置编辑器的输入提示。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_input\_type 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| type | input\_type\_t | 输入类型。 |
|
||||
<p id="edit_t_edit_set_input_type"> 设置编辑器的输入类型。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_int 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| value | int32\_t | 值。 |
|
||||
<p id="edit_t_edit_set_int"> 设置int类型的值。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_int\_limit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| min | int32\_t | 最小值。 |
|
||||
| max | int32\_t | 最大值。 |
|
||||
| step | int32\_t | 步长。 |
|
||||
<p id="edit_t_edit_set_int_limit"> 设置为整数输入及取值范围。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_password\_visible 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| password\_visible | bool\_t | 密码是否可见。 |
|
||||
<p id="edit_t_edit_set_password_visible"> 当编辑器输入类型为密码时，设置密码是否可见。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_readonly 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| readonly | bool\_t | 只读。 |
|
||||
<p id="edit_t_edit_set_readonly"> 设置编辑器是否为只读。
|
||||
|
||||
|
||||
|
||||
#### edit\_set\_text\_limit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
| min | uint32\_t | 最小长度。 |
|
||||
| max | uint32\_t | 最大长度。 |
|
||||
<p id="edit_t_edit_set_text_limit"> 设置为文本输入及其长度限制，不允许输入超过max个字符，少于min个字符时进入error状态。
|
||||
|
||||
|
||||
|
||||
#### auto\_fix 属性
|
||||
-----------------------
|
||||
<p id="edit_t_auto_fix"> 输入无效时，是否自动改正。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### bottom\_margin 属性
|
||||
-----------------------
|
||||
<p id="edit_t_bottom_margin"> 下边距。
|
||||
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### input\_type 属性
|
||||
-----------------------
|
||||
<p id="edit_t_input_type"> 输入类型。XXX：需要在min/max/step之前设置。
|
||||
|
||||
|
||||
* 类型：input\_type\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 否 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### left\_margin 属性
|
||||
-----------------------
|
||||
<p id="edit_t_left_margin"> 左边距。
|
||||
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### max 属性
|
||||
-----------------------
|
||||
<p id="edit_t_max"> 最大值或最大长度。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 否 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### min 属性
|
||||
-----------------------
|
||||
<p id="edit_t_min"> 最小值或最小长度。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 否 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### password\_visible 属性
|
||||
-----------------------
|
||||
<p id="edit_t_password_visible"> 密码是否可见。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### readonly 属性
|
||||
-----------------------
|
||||
<p id="edit_t_readonly"> 编辑器是否为只读。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### right\_margin 属性
|
||||
-----------------------
|
||||
<p id="edit_t_right_margin"> 右边距。
|
||||
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### step 属性
|
||||
-----------------------
|
||||
<p id="edit_t_step"> 步长。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 否 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### tips 属性
|
||||
-----------------------
|
||||
<p id="edit_t_tips"> 输入提示。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### top\_margin 属性
|
||||
-----------------------
|
||||
<p id="edit_t_top_margin"> 上边距。
|
||||
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
220
docs/manual/emitter_t.md
Normal file
220
docs/manual/emitter_t.md
Normal file
@ -0,0 +1,220 @@
|
||||
## emitter\_t
|
||||
### 概述
|
||||
事件分发器, 用于实现观察者模式。
|
||||
|
||||
### 函数
|
||||
<p id="emitter_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#emitter_t_emitter_create">emitter\_create</a> | 创建emitter对象。 |
|
||||
| <a href="#emitter_t_emitter_deinit">emitter\_deinit</a> | 析构。 |
|
||||
| <a href="#emitter_t_emitter_destroy">emitter\_destroy</a> | 销毁。 |
|
||||
| <a href="#emitter_t_emitter_disable">emitter\_disable</a> | 禁用。禁用后emitter_dispatch无效，但可以注册和注销。 |
|
||||
| <a href="#emitter_t_emitter_dispatch">emitter\_dispatch</a> | 分发事件。如果当前分发的回调函数返回RET_REMOVE，该回调函数将被移出。 |
|
||||
| <a href="#emitter_t_emitter_enable">emitter\_enable</a> | 启用。 |
|
||||
| <a href="#emitter_t_emitter_find">emitter\_find</a> | 通过ID查找emitter_item_t，主要用于辅助测试。 |
|
||||
| <a href="#emitter_t_emitter_init">emitter\_init</a> | 初始化emitter对象。 |
|
||||
| <a href="#emitter_t_emitter_off">emitter\_off</a> | 注销指定事件的处理函数。 |
|
||||
| <a href="#emitter_t_emitter_off_by_func">emitter\_off\_by\_func</a> | 注销指定事件的处理函数。 |
|
||||
| <a href="#emitter_t_emitter_on">emitter\_on</a> | 注册指定事件的处理函数。 |
|
||||
| <a href="#emitter_t_emitter_set_on_destroy">emitter\_set\_on\_destroy</a> | 设置一个回调函数，在emitter被销毁时调用(方便脚本语言去释放回调函数)。 |
|
||||
| <a href="#emitter_t_emitter_size">emitter\_size</a> | 获取注册的回调函数个数，主要用于辅助测试。 |
|
||||
### 属性
|
||||
<p id="emitter_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#emitter_t_enable">enable</a> | bool_t | 禁用标志。禁用时dispatch无效。 |
|
||||
### 事件
|
||||
<p id="emitter_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### emitter\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | emitter\_t* | 对象。 |
|
||||
<p id="emitter_t_emitter_create"> 创建emitter对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
<p id="emitter_t_emitter_deinit"> 析构。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
<p id="emitter_t_emitter_destroy"> 销毁。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_disable 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
<p id="emitter_t_emitter_disable"> 禁用。禁用后emitter_dispatch无效，但可以注册和注销。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_dispatch 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
| e | event\_t* | 事件对象。 |
|
||||
<p id="emitter_t_emitter_dispatch"> 分发事件。如果当前分发的回调函数返回RET_REMOVE，该回调函数将被移出。
|
||||
禁用状态下，本函数不做任何事情。
|
||||
|
||||
如果当前分发的回调函数返回RET_STOP，dispatch中断分发，并返回RET_STOP，否则返回RET_OK。
|
||||
|
||||
|
||||
|
||||
#### emitter\_enable 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
<p id="emitter_t_emitter_enable"> 启用。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_find 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
| id | uint32\_t | emitter\_on返回的ID。 |
|
||||
<p id="emitter_t_emitter_find"> 通过ID查找emitter_item_t，主要用于辅助测试。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_init 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | emitter\_t* | 对象。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
<p id="emitter_t_emitter_init"> 初始化emitter对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_off 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
| id | uint32\_t | emitter\_on返回的ID。 |
|
||||
<p id="emitter_t_emitter_off"> 注销指定事件的处理函数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_off\_by\_func 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
| type | event\_type\_t | 事件类型。 |
|
||||
| on\_event | event\_func\_t | 事件处理函数。 |
|
||||
| ctx | void* | 事件处理函数上下文。 |
|
||||
<p id="emitter_t_emitter_off_by_func"> 注销指定事件的处理函数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_on 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回id，用于emitter\_off。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
| type | event\_type\_t | 事件类型。 |
|
||||
| on\_event | event\_func\_t | 事件处理函数。 |
|
||||
| ctx | void* | 事件处理函数上下文。 |
|
||||
<p id="emitter_t_emitter_on"> 注册指定事件的处理函数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_set\_on\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
| id | uint32\_t | emitter\_on返回的ID。 |
|
||||
| on\_destroy | tk\_destroy\_t | 回调函数。 |
|
||||
| on\_destroy\_ctx | void* | 回调函数上下文。 |
|
||||
<p id="emitter_t_emitter_set_on_destroy"> 设置一个回调函数，在emitter被销毁时调用(方便脚本语言去释放回调函数)。
|
||||
|
||||
|
||||
|
||||
|
||||
#### emitter\_size 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 回调函数个数。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
<p id="emitter_t_emitter_size"> 获取注册的回调函数个数，主要用于辅助测试。
|
||||
|
||||
|
||||
|
||||
|
||||
#### enable 属性
|
||||
-----------------------
|
||||
<p id="emitter_t_enable"> 禁用标志。禁用时dispatch无效。
|
||||
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
89
docs/manual/event_t.md
Normal file
89
docs/manual/event_t.md
Normal file
@ -0,0 +1,89 @@
|
||||
## event\_t
|
||||
### 概述
|
||||
事件基类。
|
||||
|
||||
### 函数
|
||||
<p id="event_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#event_t_event_cast">event\_cast</a> | 把event对象转wheel_event_t对象，主要给脚本语言使用。 |
|
||||
### 属性
|
||||
<p id="event_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#event_t_target">target</a> | void* | 事件发生的目标对象。 |
|
||||
| <a href="#event_t_time">time</a> | int32_t | 事件发生的时间。 |
|
||||
| <a href="#event_t_type">type</a> | int32_t | 类型。 |
|
||||
### 事件
|
||||
<p id="event_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### event\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | event\_t* | 对象。 |
|
||||
| event | event\_t* | event对象。 |
|
||||
<p id="event_t_event_cast"> 把event对象转wheel_event_t对象，主要给脚本语言使用。
|
||||
|
||||
|
||||
|
||||
|
||||
#### target 属性
|
||||
-----------------------
|
||||
<p id="event_t_target"> 事件发生的目标对象。
|
||||
|
||||
|
||||
|
||||
* 类型：void*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### time 属性
|
||||
-----------------------
|
||||
<p id="event_t_time"> 事件发生的时间。
|
||||
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### type 属性
|
||||
-----------------------
|
||||
<p id="event_t_type"> 类型。
|
||||
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
63
docs/manual/event_type_t.md
Normal file
63
docs/manual/event_type_t.md
Normal file
@ -0,0 +1,63 @@
|
||||
## event\_type\_t
|
||||
### 概述
|
||||
类型常量定义。
|
||||
|
||||
### 常量
|
||||
<p id="event_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| EVT\_NONE | 无效事件名称。 |
|
||||
| EVT\_POINTER\_DOWN | 指针按下事件名(pointer\_event\_t)。 |
|
||||
| EVT\_POINTER\_DOWN\_ABORT | 取消前一个指针按下事件名(pointer\_event\_t)。 |
|
||||
| EVT\_POINTER\_MOVE | 指针移动事件名(pointer\_event\_t)。 |
|
||||
| EVT\_POINTER\_UP | 指针抬起事件名(pointer\_event\_t)。 |
|
||||
| EVT\_WHEEL | 滚轮事件名(pointer\_event\_t)。 |
|
||||
| EVT\_CONTEXT\_MENU | 右键/长按弹出上下文菜单的事件名(pointer\_event\_t)。 |
|
||||
| EVT\_POINTER\_ENTER | 指针进入事件名(pointer\_event\_t)。 |
|
||||
| EVT\_POINTER\_LEAVE | 指针离开事件名(pointer\_event\_t)。 |
|
||||
| EVT\_LONG\_PRESS | 长按事件名(pointer\_event\_t)。 |
|
||||
| EVT\_CLICK | 点击事件名(pointer\_event\_t)。 |
|
||||
| EVT\_FOCUS | 得到焦点事件名(event\_t)。 |
|
||||
| EVT\_BLUR | 失去焦点事件名(event\_t)。 |
|
||||
| EVT\_KEY\_DOWN | 键按下事件名(key\_event\_t)。 |
|
||||
| EVT\_KEY\_REPEAT | 按键repeat事件名(key\_event\_t)。 |
|
||||
| EVT\_KEY\_UP | 键抬起事件名(key\_event\_t)。 |
|
||||
| EVT\_DESTROY | 对象销毁事件名(event\_t)。 |
|
||||
| EVT\_WILL\_MOVE | 即将移动Widget的事件名(event\_t)。 |
|
||||
| EVT\_MOVE | 移动Widget的事件名(event\_t)。 |
|
||||
| EVT\_WILL\_RESIZE | 即将调整Widget大小的事件名(event\_t)。 |
|
||||
| EVT\_RESIZE | 调整Widget大小的事件名(event\_t)。 |
|
||||
| EVT\_WILL\_MOVE\_RESIZE | 即将调整Widget大小/位置的事件名(event\_t)。 |
|
||||
| EVT\_MOVE\_RESIZE | 调整Widget大小/位置的事件名(event\_t)。 |
|
||||
| EVT\_PROP\_WILL\_CHANGE | 对象的属性即将改变的事件名(prop\_change\_event\_t)。 |
|
||||
| EVT\_PROP\_CHANGED | 对象的属性改变的事件名(prop\_change\_event\_t)。 |
|
||||
| EVT\_VALUE\_WILL\_CHANGE | 控件的值即将改变的事件名(event\_t)。 |
|
||||
| EVT\_VALUE\_CHANGED | 控件的值改变的事件名(event\_t)。 |
|
||||
| EVT\_VALUE\_CHANGING | 控件的值持续改变(如编辑器正在编辑)的事件名(event\_t)。 |
|
||||
| EVT\_PAINT | 绘制的事件名(paint\_event\_t)。 |
|
||||
| EVT\_BEFORE\_PAINT | 即将绘制的事件名(paint\_event\_t)。 |
|
||||
| EVT\_AFTER\_PAINT | 绘制完成的事件名(paint\_event\_t)。 |
|
||||
| EVT\_LOCALE\_CHANGED | locale改变的事件(event\_t)。 |
|
||||
| EVT\_ANIM\_START | 控件动画开始事件(event\_t)。 |
|
||||
| EVT\_ANIM\_STOP | 控件动画被主动停止的事件(event\_t)。 |
|
||||
| EVT\_ANIM\_PAUSE | 控件动画被暂停的事件(event\_t)。 |
|
||||
| EVT\_ANIM\_ONCE | 控件动画yoyo/repeat时，完成一次的事件(event\_t)。 |
|
||||
| EVT\_ANIM\_END | 控件动画完成事件(event\_t)。 |
|
||||
| EVT\_WINDOW\_LOAD | 窗口加载完成事件(event\_t)。 |
|
||||
| EVT\_WINDOW\_WILL\_OPEN | 窗口即将打开事件(event\_t)。
|
||||
如果有窗口动画，在窗口动画开始前触发。如果没有窗口动画，在窗口被加载后的下一次循环中触发。 |
|
||||
| EVT\_WINDOW\_OPEN | 窗口打开事件(event\_t)。
|
||||
如果有窗口动画，在窗口动画完成时触发。如果没有窗口动画，在窗口被加载后的下一次循环中触发。 |
|
||||
| EVT\_WINDOW\_CLOSE | 窗口关闭事件。 |
|
||||
| EVT\_REQUEST\_CLOSE\_WINDOW | 请求关闭窗口的事件(event\_t)。 |
|
||||
| EVT\_TOP\_WINDOW\_CHANGED | 顶层窗口改变的事件(window\_event\_t)。 |
|
||||
| EVT\_IM\_COMMIT | 输入法提交输入的文本事件(im\_commit\_event\_t)。 |
|
||||
| EVT\_IM\_SHOW\_CANDIDATES | 输入法请求显示候选字事件(im\_candidates\_event\_t)。 |
|
||||
| EVT\_IM\_ACTION | 软键盘Action点击事件(event\_t)。 |
|
||||
| EVT\_IM\_ACTION\_INFO | 请求更新软键盘上的Action按钮的信息(im\_action\_button\_info\_event\_t)。 |
|
||||
| EVT\_DRAG\_START | 开始拖动(event\_t)。 |
|
||||
| EVT\_DRAG | 拖动(event\_t)。 |
|
||||
| EVT\_DRAG\_END | 结束拖动(event\_t)。 |
|
||||
| EVT\_REQ\_START | event queue其它请求编号起始值。 |
|
||||
| EVT\_USER\_START | 用户定义事件起始值。 |
|
||||
34
docs/manual/font_loader_t.md
Normal file
34
docs/manual/font_loader_t.md
Normal file
@ -0,0 +1,34 @@
|
||||
## font\_loader\_t
|
||||
### 概述
|
||||
字体加载接口。
|
||||
|
||||
### 函数
|
||||
<p id="font_loader_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#font_loader_t_font_loader_load">font\_loader\_load</a> | 加载字体。 |
|
||||
### 属性
|
||||
<p id="font_loader_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="font_loader_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### font\_loader\_load 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | font\_t* | 成功返回font，失败返回NULL。 |
|
||||
| loader | font\_loader\_t* | loader对象。 |
|
||||
| name | const char* | 字体名字。 |
|
||||
| buff | uint8\_t* | 字体数据。 |
|
||||
| size | uint32\_t | 字体数据长度。 |
|
||||
<p id="font_loader_t_font_loader_load"> 加载字体。
|
||||
|
||||
|
||||
|
||||
204
docs/manual/font_manager_t.md
Normal file
204
docs/manual/font_manager_t.md
Normal file
@ -0,0 +1,204 @@
|
||||
## font\_manager\_t
|
||||
### 概述
|
||||
字体管理器。
|
||||
(如果使用nanovg，字体由nanovg内部管理)
|
||||
|
||||
### 函数
|
||||
<p id="font_manager_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#font_manager_t_font_manager">font\_manager</a> | 获取缺省的字体管理器。 |
|
||||
| <a href="#font_manager_t_font_manager_add">font\_manager\_add</a> | 向缓存中加入字体。 |
|
||||
| <a href="#font_manager_t_font_manager_create">font\_manager\_create</a> | 创建字体管理器。 |
|
||||
| <a href="#font_manager_t_font_manager_deinit">font\_manager\_deinit</a> | 析构字体管理器。 |
|
||||
| <a href="#font_manager_t_font_manager_destroy">font\_manager\_destroy</a> | 析构并释放字体管理器。 |
|
||||
| <a href="#font_manager_t_font_manager_find">font\_manager\_find</a> | 从缓存中查找字体。 |
|
||||
| <a href="#font_manager_t_font_manager_init">font\_manager\_init</a> | 初始化字体管理器。 |
|
||||
| <a href="#font_manager_t_font_manager_set">font\_manager\_set</a> | 设置缺省的字体管理器。 |
|
||||
| <a href="#font_manager_t_font_manager_set_assets_manager">font\_manager\_set\_assets\_manager</a> | 设置资源管理器对象 |
|
||||
| <a href="#font_manager_t_g2d_blend_image">g2d\_blend\_image</a> | 把图片指定的区域渲染到framebuffer指定的区域，src的大小和dst的大小不一致则进行缩放。
|
|
||||
| <a href="#font_manager_t_g2d_copy_image">g2d\_copy\_image</a> | 把图片指定的区域拷贝到framebuffer中。
|
|
||||
| <a href="#font_manager_t_g2d_copy_image">g2d\_copy\_image</a> | 把图片指定的区域进行旋转并拷贝到framebuffer相应的区域，本函数主要用于辅助实现横屏和竖屏的切换，一般支持90度旋转即可。
|
|
||||
| <a href="#font_manager_t_g2d_fill_rect">g2d\_fill\_rect</a> | 用颜色填充指定的区域。
|
|
||||
### 属性
|
||||
<p id="font_manager_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="font_manager_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### font\_manager 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | font\_manager\_t* | 返回字体管理器对象。 |
|
||||
<p id="font_manager_t_font_manager"> 获取缺省的字体管理器。
|
||||
|
||||
|
||||
|
||||
#### font\_manager\_add 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| fm | font\_manager\_t* | 字体管理器对象。 |
|
||||
| name | char* | 字体名。 |
|
||||
| font | font\_t* | 字体。 |
|
||||
<p id="font_manager_t_font_manager_add"> 向缓存中加入字体。
|
||||
|
||||
|
||||
|
||||
|
||||
#### font\_manager\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | font\_manager\_t* | 返回字体管理器对象。 |
|
||||
| loader | font\_loader\_t* | 字体加载器。 |
|
||||
<p id="font_manager_t_font_manager_create"> 创建字体管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### font\_manager\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| fm | font\_manager\_t* | 字体管理器对象。 |
|
||||
<p id="font_manager_t_font_manager_deinit"> 析构字体管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### font\_manager\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| fm | font\_manager\_t* | 字体管理器对象。 |
|
||||
<p id="font_manager_t_font_manager_destroy"> 析构并释放字体管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### font\_manager\_find 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | font\_t* | 返回字体对象。 |
|
||||
| fm | font\_manager\_t* | 字体管理器对象。 |
|
||||
| name | char* | 字体名，为NULL时使用TK\_DEFAULT\_FONT。 |
|
||||
| size | uint16\_t | 字体的大小。 |
|
||||
<p id="font_manager_t_font_manager_find"> 从缓存中查找字体。
|
||||
|
||||
|
||||
|
||||
|
||||
#### font\_manager\_init 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | font\_manager\_t* | 返回字体管理器对象。 |
|
||||
| fm | font\_manager\_t* | 字体管理器对象。 |
|
||||
| loader | font\_loader\_t* | 字体加载器。 |
|
||||
<p id="font_manager_t_font_manager_init"> 初始化字体管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### font\_manager\_set 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| fm | font\_manager\_t* | 字体管理器对象。 |
|
||||
<p id="font_manager_t_font_manager_set"> 设置缺省的字体管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### font\_manager\_set\_assets\_manager 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | font\_manager\_t* | 图片管理器对象。 |
|
||||
| assets\_manager | assets\_manager\_t* | 资源管理器。 |
|
||||
<p id="font_manager_t_font_manager_set_assets_manager"> 设置资源管理器对象
|
||||
|
||||
|
||||
|
||||
|
||||
#### g2d\_blend\_image 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
|
||||
| fb | bitmap\_t* | framebuffer对象。 |
|
||||
| img | bitmap\_t* | 图片对象。 |
|
||||
| dst | rect\_t* | 目的区域。 |
|
||||
| src | rect\_t* | 源区域。 |
|
||||
| global\_alpha | uint8\_t | 全局alpha。 |
|
||||
<p id="font_manager_t_g2d_blend_image"> 把图片指定的区域渲染到framebuffer指定的区域，src的大小和dst的大小不一致则进行缩放。
|
||||
1.硬件不支持缩放，则返回NOT_IMPL。
|
||||
2.硬件不支持全局alpha，global_alpha!=0xff时返回NOT_IMPL。
|
||||
|
||||
|
||||
|
||||
#### g2d\_copy\_image 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
|
||||
| fb | bitmap\_t* | framebuffer对象。 |
|
||||
| img | bitmap\_t* | 图片对象。 |
|
||||
| src | rect\_t* | 要拷贝的区域。 |
|
||||
| dx | xy\_t | 目标位置的x坐标。 |
|
||||
| dy | xy\_t | 目标位置的y坐标。 |
|
||||
<p id="font_manager_t_g2d_copy_image"> 把图片指定的区域拷贝到framebuffer中。
|
||||
|
||||
|
||||
|
||||
#### g2d\_copy\_image 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
|
||||
| fb | bitmap\_t* | framebuffer对象。 |
|
||||
| img | bitmap\_t* | 图片对象。 |
|
||||
| src | rect\_t* | 要旋转并拷贝的区域。 |
|
||||
| o | lcd\_orientation\_t | 旋转角度(一般支持90度即可)。 |
|
||||
<p id="font_manager_t_g2d_copy_image"> 把图片指定的区域进行旋转并拷贝到framebuffer相应的区域，本函数主要用于辅助实现横屏和竖屏的切换，一般支持90度旋转即可。
|
||||
|
||||
|
||||
|
||||
#### g2d\_fill\_rect 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 |
|
||||
| fb | bitmap\_t* | framebuffer对象。 |
|
||||
| dst | rect\_t* | 要填充的目标区域。 |
|
||||
| c | color\_t | 颜色。 |
|
||||
<p id="font_manager_t_g2d_fill_rect"> 用颜色填充指定的区域。
|
||||
|
||||
|
||||
|
||||
69
docs/manual/func_call_parser_t.md
Normal file
69
docs/manual/func_call_parser_t.md
Normal file
@ -0,0 +1,69 @@
|
||||
## func\_call\_parser\_t
|
||||
### 概述
|
||||
从字符串中解析出函数调用需要的参数。
|
||||
func_call => func_name '(' params ')'
|
||||
params => param ',' params
|
||||
param => name '=' value
|
||||
func_name => ID
|
||||
name = ID
|
||||
value = int | float | ID
|
||||
|
||||
如:move(x=10, y=20)
|
||||
如:rename(old_name=aa, new_name=bb)
|
||||
|
||||
### 函数
|
||||
<p id="func_call_parser_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#func_call_parser_t_func_call_parser_deinit">func\_call\_parser\_deinit</a> | 重置parser。 |
|
||||
| <a href="#func_call_parser_t_func_call_parser_init">func\_call\_parser\_init</a> | 初始化parser对象。 |
|
||||
| <a href="#func_call_parser_t_func_call_parser_parse">func\_call\_parser\_parse</a> | 开始解析。 |
|
||||
### 属性
|
||||
<p id="func_call_parser_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="func_call_parser_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### func\_call\_parser\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| parser | func\_call\_parser\_t* | parser对象。 |
|
||||
<p id="func_call_parser_t_func_call_parser_deinit"> 重置parser。
|
||||
|
||||
|
||||
|
||||
|
||||
#### func\_call\_parser\_init 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | func\_call\_parser\_t* | parser对象本身。 |
|
||||
| parser | func\_call\_parser\_t* | parser对象。 |
|
||||
| str | char* | 要解析的字符串。 |
|
||||
| size | uint32\_t | 字符串长度。 |
|
||||
<p id="func_call_parser_t_func_call_parser_init"> 初始化parser对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### func\_call\_parser\_parse 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| parser | func\_call\_parser\_t* | parser对象。 |
|
||||
<p id="func_call_parser_t_func_call_parser_parse"> 开始解析。
|
||||
|
||||
|
||||
|
||||
|
||||
48
docs/manual/gif_image_t.md
Normal file
48
docs/manual/gif_image_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## gif\_image\_t
|
||||
### 概述
|
||||
GIF图片控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="gif_image_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#gif_image_t_gif_image_cast">gif\_image\_cast</a> | 转换为gif_image对象(供脚本语言使用)。
|
|
||||
| <a href="#gif_image_t_gif_image_create">gif\_image\_create</a> | 创建gif_image对象
|
|
||||
### 属性
|
||||
<p id="gif_image_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="gif_image_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### gif\_image\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | gif\_image对象。 |
|
||||
| widget | widget\_t* | gif\_image对象。 |
|
||||
<p id="gif_image_t_gif_image_cast"> 转换为gif_image对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### gif\_image\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="gif_image_t_gif_image_create"> 创建gif_image对象
|
||||
|
||||
|
||||
|
||||
48
docs/manual/grid_item_t.md
Normal file
48
docs/manual/grid_item_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## grid\_item\_t
|
||||
### 概述
|
||||
grid_item。一个简单的容器控件，一般作为grid的子控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="grid_item_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#grid_item_t_grid_item_cast">grid\_item\_cast</a> | 转换为grid_item对象(供脚本语言使用)。
|
|
||||
| <a href="#grid_item_t_grid_item_create">grid\_item\_create</a> | 创建grid_item对象
|
|
||||
### 属性
|
||||
<p id="grid_item_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="grid_item_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### grid\_item\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | grid\_item对象。 |
|
||||
| widget | widget\_t* | grid\_item对象。 |
|
||||
<p id="grid_item_t_grid_item_cast"> 转换为grid_item对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### grid\_item\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="grid_item_t_grid_item_create"> 创建grid_item对象
|
||||
|
||||
|
||||
|
||||
49
docs/manual/grid_t.md
Normal file
49
docs/manual/grid_t.md
Normal file
@ -0,0 +1,49 @@
|
||||
## grid\_t
|
||||
### 概述
|
||||
grid。一个简单的容器控件，用于网格排列一组控件。
|
||||
它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="grid_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#grid_t_grid_cast">grid\_cast</a> | 转换为grid对象(供脚本语言使用)。
|
|
||||
| <a href="#grid_t_grid_create">grid\_create</a> | 创建grid对象
|
|
||||
### 属性
|
||||
<p id="grid_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="grid_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### grid\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | grid对象。 |
|
||||
| widget | widget\_t* | grid对象。 |
|
||||
<p id="grid_t_grid_cast"> 转换为grid对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### grid\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="grid_t_grid_create"> 创建grid对象
|
||||
|
||||
|
||||
|
||||
48
docs/manual/group_box_t.md
Normal file
48
docs/manual/group_box_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## group\_box\_t
|
||||
### 概述
|
||||
分组控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="group_box_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#group_box_t_group_box_cast">group\_box\_cast</a> | 转换为group_box对象(供脚本语言使用)。
|
|
||||
| <a href="#group_box_t_group_box_create">group\_box\_create</a> | 创建group_box对象
|
|
||||
### 属性
|
||||
<p id="group_box_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="group_box_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### group\_box\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | group\_box对象。 |
|
||||
| widget | widget\_t* | group\_box对象。 |
|
||||
<p id="group_box_t_group_box_cast"> 转换为group_box对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### group\_box\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="group_box_t_group_box_create"> 创建group_box对象
|
||||
|
||||
|
||||
|
||||
110
docs/manual/guage_pointer_t.md
Normal file
110
docs/manual/guage_pointer_t.md
Normal file
@ -0,0 +1,110 @@
|
||||
## guage\_pointer\_t
|
||||
### 概述
|
||||
仪表指针控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="guage_pointer_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#guage_pointer_t_guage_pointer_cast">guage\_pointer\_cast</a> | 转换为guage_pointer对象(供脚本语言使用)。
|
|
||||
| <a href="#guage_pointer_t_guage_pointer_create">guage\_pointer\_create</a> | 创建guage_pointer对象
|
|
||||
| <a href="#guage_pointer_t_guage_pointer_set_angle">guage\_pointer\_set\_angle</a> | 设置指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。
|
|
||||
| <a href="#guage_pointer_t_guage_pointer_set_image">guage\_pointer\_set\_image</a> | 设置指针的图片。
|
|
||||
### 属性
|
||||
<p id="guage_pointer_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#guage_pointer_t_angle">angle</a> | int32_t | 指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。
|
|
||||
| <a href="#guage_pointer_t_image">image</a> | char* | 指针图片。图片须垂直向上，图片的中心点为旋转方向。
|
|
||||
### 事件
|
||||
<p id="guage_pointer_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### guage\_pointer\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | guage\_pointer对象。 |
|
||||
| widget | widget\_t* | guage\_pointer对象。 |
|
||||
<p id="guage_pointer_t_guage_pointer_cast"> 转换为guage_pointer对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### guage\_pointer\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="guage_pointer_t_guage_pointer_create"> 创建guage_pointer对象
|
||||
|
||||
|
||||
|
||||
#### guage\_pointer\_set\_angle 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| angle | int32\_t | 指针角度。 |
|
||||
<p id="guage_pointer_t_guage_pointer_set_angle"> 设置指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。
|
||||
|
||||
|
||||
|
||||
#### guage\_pointer\_set\_image 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| image | const char* | 指针的图片。 |
|
||||
<p id="guage_pointer_t_guage_pointer_set_image"> 设置指针的图片。
|
||||
|
||||
|
||||
|
||||
#### angle 属性
|
||||
-----------------------
|
||||
<p id="guage_pointer_t_angle"> 指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。
|
||||
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### image 属性
|
||||
-----------------------
|
||||
<p id="guage_pointer_t_image"> 指针图片。图片须垂直向上，图片的中心点为旋转方向。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
110
docs/manual/guage_t.md
Normal file
110
docs/manual/guage_t.md
Normal file
@ -0,0 +1,110 @@
|
||||
## guage\_t
|
||||
### 概述
|
||||
表盘控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="guage_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#guage_t_guage_cast">guage\_cast</a> | 转换为guage对象(供脚本语言使用)。
|
|
||||
| <a href="#guage_t_guage_create">guage\_create</a> | 创建guage对象
|
|
||||
| <a href="#guage_t_guage_set_draw_type">guage\_set\_draw\_type</a> | 设置图片的显示方式。
|
|
||||
| <a href="#guage_t_guage_set_image">guage\_set\_image</a> | 设置背景图片的名称。
|
|
||||
### 属性
|
||||
<p id="guage_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#guage_t_draw_type">draw\_type</a> | image_draw_type_t | 图片的绘制方式。
|
|
||||
| <a href="#guage_t_image">image</a> | char* | 背景图片。
|
|
||||
### 事件
|
||||
<p id="guage_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### guage\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | guage对象。 |
|
||||
| widget | widget\_t* | guage对象。 |
|
||||
<p id="guage_t_guage_cast"> 转换为guage对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### guage\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="guage_t_guage_create"> 创建guage对象
|
||||
|
||||
|
||||
|
||||
#### guage\_set\_draw\_type 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image对象。 |
|
||||
| draw\_type | image\_draw\_type\_t | 显示方式。 |
|
||||
<p id="guage_t_guage_set_draw_type"> 设置图片的显示方式。
|
||||
|
||||
|
||||
|
||||
#### guage\_set\_image 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image对象。 |
|
||||
| name | char* | 图片名称，该图片必须存在于资源管理器。 |
|
||||
<p id="guage_t_guage_set_image"> 设置背景图片的名称。
|
||||
|
||||
|
||||
|
||||
#### draw\_type 属性
|
||||
-----------------------
|
||||
<p id="guage_t_draw_type"> 图片的绘制方式。
|
||||
|
||||
|
||||
* 类型：image\_draw\_type\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### image 属性
|
||||
-----------------------
|
||||
<p id="guage_t_image"> 背景图片。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
13
docs/manual/icon_at_type_t.md
Normal file
13
docs/manual/icon_at_type_t.md
Normal file
@ -0,0 +1,13 @@
|
||||
## icon\_at\_type\_t
|
||||
### 概述
|
||||
图标所在的位置。
|
||||
### 常量
|
||||
<p id="icon_at_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| ICON\_AT\_AUTO | 自动选择位置。 |
|
||||
| ICON\_AT\_LEFT | 水平左边，垂直居中。 |
|
||||
| ICON\_AT\_RIGHT | 水平右边，垂直居中(not used now)。 |
|
||||
| ICON\_AT\_TOP | 水平居中，垂直顶部(not used now)。 |
|
||||
| ICON\_AT\_BOTTOM | 水平居中，垂直低部(not used now)。 |
|
||||
87
docs/manual/idle_t.md
Normal file
87
docs/manual/idle_t.md
Normal file
@ -0,0 +1,87 @@
|
||||
## idle\_t
|
||||
### 概述
|
||||
idle函数在主循环中paint之后执行。
|
||||
|
||||
### 函数
|
||||
<p id="idle_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#idle_t_idle_add">idle\_add</a> | 增加一个idle。 |
|
||||
| <a href="#idle_t_idle_count">idle\_count</a> | 返回idle的个数。 |
|
||||
| <a href="#idle_t_idle_queue">idle\_queue</a> | 用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。 |
|
||||
| <a href="#idle_t_idle_remove">idle\_remove</a> | 删除指定的idle。 |
|
||||
| <a href="#idle_t_idle_set_on_destroy">idle\_set\_on\_destroy</a> | 设置一个回调函数，在idle被销毁时调用(方便脚本语言去释放回调函数)。 |
|
||||
### 属性
|
||||
<p id="idle_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="idle_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### idle\_add 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回idle的ID，0表示失败。 |
|
||||
| on\_idle | idle\_func\_t | idle回调函数，回调函数返回RET\_REPEAT，则下次继续执行，否则自动移出。 |
|
||||
| ctx | void* | idle回调函数的上下文。 |
|
||||
<p id="idle_t_idle_add"> 增加一个idle。
|
||||
|
||||
|
||||
|
||||
|
||||
#### idle\_count 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回idle的个数。 |
|
||||
<p id="idle_t_idle_count"> 返回idle的个数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### idle\_queue 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| on\_idle | idle\_func\_t | idle回调函数。 |
|
||||
| ctx | void* | idle回调函数的上下文。 |
|
||||
<p id="idle_t_idle_queue"> 用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。
|
||||
|
||||
|
||||
|
||||
|
||||
#### idle\_remove 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| idle\_id | uint32\_t | idleID。 |
|
||||
<p id="idle_t_idle_remove"> 删除指定的idle。
|
||||
|
||||
|
||||
|
||||
|
||||
#### idle\_set\_on\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| idle\_id | uint32\_t | idleID。 |
|
||||
| on\_destroy | tk\_destroy\_t | 回调函数。 |
|
||||
| on\_destroy\_ctx | void* | 回调函数上下文。 |
|
||||
<p id="idle_t_idle_set_on_destroy"> 设置一个回调函数，在idle被销毁时调用(方便脚本语言去释放回调函数)。
|
||||
|
||||
|
||||
|
||||
|
||||
59
docs/manual/im_action_button_info_event_t.md
Normal file
59
docs/manual/im_action_button_info_event_t.md
Normal file
@ -0,0 +1,59 @@
|
||||
## im\_action\_button\_info\_event\_t
|
||||
### 概述
|
||||
设置软键盘上的action按钮的信息事件。
|
||||
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="im_action_button_info_event_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
### 属性
|
||||
<p id="im_action_button_info_event_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#im_action_button_info_event_t_enable">enable</a> | bool_t | 软键盘上的action按钮启用。 |
|
||||
| <a href="#im_action_button_info_event_t_text">text</a> | char* | 软键盘上的action按钮显示的文本。 |
|
||||
### 事件
|
||||
<p id="im_action_button_info_event_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### enable 属性
|
||||
-----------------------
|
||||
<p id="im_action_button_info_event_t_enable"> 软键盘上的action按钮启用。
|
||||
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### text 属性
|
||||
-----------------------
|
||||
<p id="im_action_button_info_event_t_text"> 软键盘上的action按钮显示的文本。
|
||||
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
252
docs/manual/im_candidates_event_t.md
Normal file
252
docs/manual/im_candidates_event_t.md
Normal file
@ -0,0 +1,252 @@
|
||||
## im\_candidates\_event\_t
|
||||
### 概述
|
||||
输入法请求显示候选字的事件。
|
||||
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="im_candidates_event_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#im_candidates_event_t_input_method">input\_method</a> | 获取全局输入法对象。 |
|
||||
| <a href="#im_candidates_event_t_input_method_commit_text">input\_method\_commit\_text</a> | 提交输入文本。 |
|
||||
| <a href="#im_candidates_event_t_input_method_create">input\_method\_create</a> | 创建输入法对象。在具体实现中实现。 |
|
||||
| <a href="#im_candidates_event_t_input_method_destroy">input\_method\_destroy</a> | 销毁输入法对象。在具体实现中实现。 |
|
||||
| <a href="#im_candidates_event_t_input_method_dispatch">input\_method\_dispatch</a> | 分发一个事件。 |
|
||||
| <a href="#im_candidates_event_t_input_method_dispatch_action">input\_method\_dispatch\_action</a> | 软键盘上的action按钮被点击时，调用本函数分发EVT_IM_ACTION事件。 |
|
||||
| <a href="#im_candidates_event_t_input_method_dispatch_candidates">input\_method\_dispatch\_candidates</a> | 请求显示候选字。 |
|
||||
| <a href="#im_candidates_event_t_input_method_dispatch_key">input\_method\_dispatch\_key</a> | 提交按键。 |
|
||||
| <a href="#im_candidates_event_t_input_method_dispatch_to_widget">input\_method\_dispatch\_to\_widget</a> | 分发一个事件当前焦点控件。 |
|
||||
| <a href="#im_candidates_event_t_input_method_off">input\_method\_off</a> | 注销指定事件的处理函数。 |
|
||||
| <a href="#im_candidates_event_t_input_method_on">input\_method\_on</a> | 注册指定事件的处理函数。 |
|
||||
| <a href="#im_candidates_event_t_input_method_request">input\_method\_request</a> | 打开或关闭输入法。 |
|
||||
| <a href="#im_candidates_event_t_input_method_set">input\_method\_set</a> | 设置全局输入法对象。 |
|
||||
| <a href="#im_candidates_event_t_input_method_update_action_button_info">input\_method\_update\_action\_button\_info</a> | 设置软键盘上的action按钮的信息。 |
|
||||
### 属性
|
||||
<p id="im_candidates_event_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#im_candidates_event_t_candidates">candidates</a> | char* | 可选的文本，多个文本以\0分隔。如：里\0李\0力\0离\0 |
|
||||
| <a href="#im_candidates_event_t_candidates_nr">candidates\_nr</a> | uint32_t | 可选的文本的个数。 |
|
||||
### 事件
|
||||
<p id="im_candidates_event_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### input\_method 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | input\_method\_t* | 成功返回输入法对象，失败返回NULL。 |
|
||||
<p id="im_candidates_event_t_input_method"> 获取全局输入法对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_commit\_text 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
| text | char* | 文本。 |
|
||||
<p id="im_candidates_event_t_input_method_commit_text"> 提交输入文本。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | input\_method\_t* | 成功返回输入法对象，失败返回NULL。 |
|
||||
<p id="im_candidates_event_t_input_method_create"> 创建输入法对象。在具体实现中实现。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
<p id="im_candidates_event_t_input_method_destroy"> 销毁输入法对象。在具体实现中实现。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_dispatch 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 控件对象。 |
|
||||
| e | event\_t* | 事件。 |
|
||||
<p id="im_candidates_event_t_input_method_dispatch"> 分发一个事件。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_dispatch\_action 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
<p id="im_candidates_event_t_input_method_dispatch_action"> 软键盘上的action按钮被点击时，调用本函数分发EVT_IM_ACTION事件。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_dispatch\_candidates 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
| strs | char* | 候选字列表。 |
|
||||
| nr | uint32\_t | 候选字个数。 |
|
||||
<p id="im_candidates_event_t_input_method_dispatch_candidates"> 请求显示候选字。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_dispatch\_key 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
| key | uint32\_t | 键值。 |
|
||||
<p id="im_candidates_event_t_input_method_dispatch_key"> 提交按键。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_dispatch\_to\_widget 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 控件对象。 |
|
||||
| e | event\_t* | 事件。 |
|
||||
<p id="im_candidates_event_t_input_method_dispatch_to_widget"> 分发一个事件当前焦点控件。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_off 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
| id | uint32\_t | input\_method\_on返回的ID。 |
|
||||
<p id="im_candidates_event_t_input_method_off"> 注销指定事件的处理函数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_on 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回id，用于input\_method\_off。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
| type | event\_type\_t | 事件类型。 |
|
||||
| on\_event | event\_func\_t | 事件处理函数。 |
|
||||
| ctx | void* | 事件处理函数上下文。 |
|
||||
<p id="im_candidates_event_t_input_method_on"> 注册指定事件的处理函数。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_request 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
| widget | widget\_t* | 焦点控件，为NULL时关闭输入法，非NULL时打开输入法。 |
|
||||
<p id="im_candidates_event_t_input_method_request"> 打开或关闭输入法。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_set 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
<p id="im_candidates_event_t_input_method_set"> 设置全局输入法对象。
|
||||
|
||||
|
||||
|
||||
|
||||
#### input\_method\_update\_action\_button\_info 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
| text | char* | 按钮的文本。 |
|
||||
| enable | bool\_t | 按钮的是否可用。 |
|
||||
<p id="im_candidates_event_t_input_method_update_action_button_info"> 设置软键盘上的action按钮的信息。
|
||||
|
||||
|
||||
|
||||
|
||||
#### candidates 属性
|
||||
-----------------------
|
||||
<p id="im_candidates_event_t_candidates"> 可选的文本，多个文本以\0分隔。如：里\0李\0力\0离\0
|
||||
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
#### candidates\_nr 属性
|
||||
-----------------------
|
||||
<p id="im_candidates_event_t_candidates_nr"> 可选的文本的个数。
|
||||
|
||||
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
40
docs/manual/im_commit_event_t.md
Normal file
40
docs/manual/im_commit_event_t.md
Normal file
@ -0,0 +1,40 @@
|
||||
## im\_commit\_event\_t
|
||||
### 概述
|
||||
输入法提交输入的文本事件。
|
||||
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="im_commit_event_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
### 属性
|
||||
<p id="im_commit_event_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#im_commit_event_t_text">text</a> | char* | 提交的文本。 |
|
||||
### 事件
|
||||
<p id="im_commit_event_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### text 属性
|
||||
-----------------------
|
||||
<p id="im_commit_event_t_text"> 提交的文本。
|
||||
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 否 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
270
docs/manual/image_animation_t.md
Normal file
270
docs/manual/image_animation_t.md
Normal file
@ -0,0 +1,270 @@
|
||||
## image\_animation\_t
|
||||
### 概述
|
||||
图片动画控件，指定一个图片前缀，依次显示指定序列的图片，从而形成动画效果。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="image_animation_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#image_animation_t_image_animation_cast">image\_animation\_cast</a> | 转换为image_animation对象(供脚本语言使用)。
|
|
||||
| <a href="#image_animation_t_image_animation_create">image\_animation\_create</a> | 创建image_animation对象
|
|
||||
| <a href="#image_animation_t_image_animation_pause">image\_animation\_pause</a> | 暂停。
|
|
||||
| <a href="#image_animation_t_image_animation_play">image\_animation\_play</a> | 播放。
|
|
||||
| <a href="#image_animation_t_image_animation_set_auto_play">image\_animation\_set\_auto\_play</a> | 设置是否自动播放。
|
|
||||
| <a href="#image_animation_t_image_animation_set_delay">image\_animation\_set\_delay</a> | 设置延迟播放时间(仅适用于自动播放)。
|
|
||||
| <a href="#image_animation_t_image_animation_set_image">image\_animation\_set\_image</a> | 设置图片前缀。
|
|
||||
| <a href="#image_animation_t_image_animation_set_interval">image\_animation\_set\_interval</a> | 设置播放间隔时间。
|
|
||||
| <a href="#image_animation_t_image_animation_set_loop">image\_animation\_set\_loop</a> | 设置是否循环播放。
|
|
||||
| <a href="#image_animation_t_image_animation_set_sequence">image\_animation\_set\_sequence</a> | 设置播放序列。比如image为"fire"，sequence为"123", 将依次播放"fire1", "fire2", "fire3"。
|
|
||||
| <a href="#image_animation_t_image_animation_stop">image\_animation\_stop</a> | 停止(并重置index为0)。
|
|
||||
### 属性
|
||||
<p id="image_animation_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#image_animation_t_auto_play">auto\_play</a> | bool_t | 是否自动播放。
|
|
||||
| <a href="#image_animation_t_delay">delay</a> | uint32_t | 自动播放时延迟播放的时间(毫秒)。
|
|
||||
| <a href="#image_animation_t_image">image</a> | char* | 图片名称的前缀。
|
|
||||
| <a href="#image_animation_t_interval">interval</a> | uint32_t | 每张图片播放的时间(毫秒)。
|
|
||||
| <a href="#image_animation_t_loop">loop</a> | bool_t | 是否循环播放。
|
|
||||
| <a href="#image_animation_t_sequence">sequence</a> | char* | 播放的序列，字符可选值为:0-9,a-z,A-Z。
|
|
||||
### 事件
|
||||
<p id="image_animation_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### image\_animation\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | image\_animation对象。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
<p id="image_animation_t_image_animation_cast"> 转换为image_animation对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="image_animation_t_image_animation_create"> 创建image_animation对象
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_pause 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
<p id="image_animation_t_image_animation_pause"> 暂停。
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_play 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
<p id="image_animation_t_image_animation_play"> 播放。
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_set\_auto\_play 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
| auto\_play | bool\_t | 是否自动播放。 |
|
||||
<p id="image_animation_t_image_animation_set_auto_play"> 设置是否自动播放。
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_set\_delay 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
| delay | uint32\_t | 延迟播放时间(毫秒)。 |
|
||||
<p id="image_animation_t_image_animation_set_delay"> 设置延迟播放时间(仅适用于自动播放)。
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_set\_image 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
| image | const char* | 图片前缀。 |
|
||||
<p id="image_animation_t_image_animation_set_image"> 设置图片前缀。
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_set\_interval 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
| interval | uint32\_t | 间隔时间(毫秒)。 |
|
||||
<p id="image_animation_t_image_animation_set_interval"> 设置播放间隔时间。
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_set\_loop 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
| loop | bool\_t | 是否循环播放。 |
|
||||
<p id="image_animation_t_image_animation_set_loop"> 设置是否循环播放。
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_set\_sequence 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
| sequence | const char* | 播放序列。 |
|
||||
<p id="image_animation_t_image_animation_set_sequence"> 设置播放序列。比如image为"fire"，sequence为"123", 将依次播放"fire1", "fire2", "fire3"。
|
||||
|
||||
|
||||
|
||||
#### image\_animation\_stop 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_animation对象。 |
|
||||
<p id="image_animation_t_image_animation_stop"> 停止(并重置index为0)。
|
||||
|
||||
|
||||
|
||||
#### auto\_play 属性
|
||||
-----------------------
|
||||
<p id="image_animation_t_auto_play"> 是否自动播放。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### delay 属性
|
||||
-----------------------
|
||||
<p id="image_animation_t_delay"> 自动播放时延迟播放的时间(毫秒)。
|
||||
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### image 属性
|
||||
-----------------------
|
||||
<p id="image_animation_t_image"> 图片名称的前缀。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### interval 属性
|
||||
-----------------------
|
||||
<p id="image_animation_t_interval"> 每张图片播放的时间(毫秒)。
|
||||
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### loop 属性
|
||||
-----------------------
|
||||
<p id="image_animation_t_loop"> 是否循环播放。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### sequence 属性
|
||||
-----------------------
|
||||
<p id="image_animation_t_sequence"> 播放的序列，字符可选值为:0-9,a-z,A-Z。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
287
docs/manual/image_base_t.md
Normal file
287
docs/manual/image_base_t.md
Normal file
@ -0,0 +1,287 @@
|
||||
## image\_base\_t
|
||||
### 概述
|
||||
图片控件基类。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="image_base_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#image_base_t_image_base_cast">image\_base\_cast</a> | 转换为image_base对象(供脚本语言使用)。
|
|
||||
| <a href="#image_base_t_image_set_anchor">image\_set\_anchor</a> | 设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。
|
|
||||
| <a href="#image_base_t_image_set_clickable">image\_set\_clickable</a> | 设置控件是否可以被点击。
|
|
||||
| <a href="#image_base_t_image_set_image">image\_set\_image</a> | 设置控件的图片名称。
|
|
||||
| <a href="#image_base_t_image_set_rotation">image\_set\_rotation</a> | 设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。
|
|
||||
| <a href="#image_base_t_image_set_scale">image\_set\_scale</a> | 设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。
|
|
||||
| <a href="#image_base_t_image_set_selectable">image\_set\_selectable</a> | 设置控件是否可以被选中。
|
|
||||
| <a href="#image_base_t_image_set_selected">image\_set\_selected</a> | 设置控件的选中状态。
|
|
||||
### 属性
|
||||
<p id="image_base_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#image_base_t_anchor_x">anchor\_x</a> | float_t | 锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。
|
|
||||
| <a href="#image_base_t_anchor_y">anchor\_y</a> | float_t | 锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。
|
|
||||
| <a href="#image_base_t_clickable">clickable</a> | bool_t | 点击时，是否触发EVT_CLICK事件。
|
|
||||
| <a href="#image_base_t_image">image</a> | char* | 图片的名称。
|
|
||||
| <a href="#image_base_t_rotation">rotation</a> | float_t | 控件的旋转角度(幅度)。
|
|
||||
| <a href="#image_base_t_scale_x">scale\_x</a> | float_t | 控件在X方向上的缩放比例。
|
|
||||
| <a href="#image_base_t_scale_y">scale\_y</a> | float_t | 控件在Y方向上的缩放比例。
|
|
||||
| <a href="#image_base_t_selectable">selectable</a> | bool_t | 是否设置选中状态。
|
|
||||
| <a href="#image_base_t_selected">selected</a> | bool_t | 当前是否被选中。
|
|
||||
### 事件
|
||||
<p id="image_base_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### image\_base\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | image\_base对象。 |
|
||||
| widget | widget\_t* | image\_base对象。 |
|
||||
<p id="image_base_t_image_base_cast"> 转换为image_base对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### image\_set\_anchor 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| anchor\_x | float\_t | 锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。 |
|
||||
| anchor\_y | float\_t | 锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。 |
|
||||
<p id="image_base_t_image_set_anchor"> 设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。
|
||||
|
||||
|
||||
|
||||
#### image\_set\_clickable 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| clickable | bool\_t | 是否可以被点击。 |
|
||||
<p id="image_base_t_image_set_clickable"> 设置控件是否可以被点击。
|
||||
|
||||
|
||||
|
||||
#### image\_set\_image 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image对象。 |
|
||||
| name | char* | 图片名称，该图片必须存在于资源管理器。 |
|
||||
<p id="image_base_t_image_set_image"> 设置控件的图片名称。
|
||||
|
||||
|
||||
|
||||
#### image\_set\_rotation 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| rotation | float\_t | 旋转角度(幅度)。 |
|
||||
<p id="image_base_t_image_set_rotation"> 设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。
|
||||
|
||||
|
||||
|
||||
#### image\_set\_scale 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| scale\_x | float\_t | X方向缩放比例。 |
|
||||
| scale\_y | float\_t | Y方向缩放比例。 |
|
||||
<p id="image_base_t_image_set_scale"> 设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。
|
||||
|
||||
|
||||
|
||||
#### image\_set\_selectable 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| selectable | bool\_t | 是否可以被选中。 |
|
||||
<p id="image_base_t_image_set_selectable"> 设置控件是否可以被选中。
|
||||
|
||||
|
||||
|
||||
#### image\_set\_selected 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| selected | bool\_t | 是否被选中。 |
|
||||
<p id="image_base_t_image_set_selected"> 设置控件的选中状态。
|
||||
|
||||
|
||||
|
||||
#### anchor\_x 属性
|
||||
-----------------------
|
||||
<p id="image_base_t_anchor_x"> 锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。
|
||||
|
||||
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### anchor\_y 属性
|
||||
-----------------------
|
||||
<p id="image_base_t_anchor_y"> 锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。
|
||||
|
||||
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### clickable 属性
|
||||
-----------------------
|
||||
<p id="image_base_t_clickable"> 点击时，是否触发EVT_CLICK事件。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### image 属性
|
||||
-----------------------
|
||||
<p id="image_base_t_image"> 图片的名称。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### rotation 属性
|
||||
-----------------------
|
||||
<p id="image_base_t_rotation"> 控件的旋转角度(幅度)。
|
||||
|
||||
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### scale\_x 属性
|
||||
-----------------------
|
||||
<p id="image_base_t_scale_x"> 控件在X方向上的缩放比例。
|
||||
|
||||
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### scale\_y 属性
|
||||
-----------------------
|
||||
<p id="image_base_t_scale_y"> 控件在Y方向上的缩放比例。
|
||||
|
||||
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### selectable 属性
|
||||
-----------------------
|
||||
<p id="image_base_t_selectable"> 是否设置选中状态。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### selected 属性
|
||||
-----------------------
|
||||
<p id="image_base_t_selected"> 当前是否被选中。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 否 |
|
||||
| 可在XML中设置 | 否 |
|
||||
| 支通过widget_get_prop读取 | 否 |
|
||||
| 支通过widget_set_prop修改 | 否 |
|
||||
30
docs/manual/image_draw_type_t.md
Normal file
30
docs/manual/image_draw_type_t.md
Normal file
@ -0,0 +1,30 @@
|
||||
## image\_draw\_type\_t
|
||||
### 概述
|
||||
图片绘制方法常量定义。
|
||||
|
||||
### 常量
|
||||
<p id="image_draw_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| IMAGE\_DRAW\_DEFAULT | 缺省显示。将图片按原大小显示在目标矩形的左上角。 |
|
||||
| IMAGE\_DRAW\_CENTER | 居中显示。将图片按原大小显示在目标矩形的中央。 |
|
||||
| IMAGE\_DRAW\_ICON | 图标显示。同居中显示，但会根据屏幕密度调整大小。 |
|
||||
| IMAGE\_DRAW\_SCALE | 缩放显示。将图片缩放至目标矩形的大小(不保证宽高成比例)。 |
|
||||
| IMAGE\_DRAW\_SCALE\_AUTO | 自动缩放显示。将图片缩放至目标矩形的宽度或高度(选取最小的比例)，并居中显示。 |
|
||||
| IMAGE\_DRAW\_SCALE\_DOWN | 如果图片比目标矩形大，自动缩小显示，否则居中显示。 |
|
||||
| IMAGE\_DRAW\_SCALE\_W | 宽度缩放显示。 将图片缩放至目标矩形的宽度，高度按此比例进行缩放，超出不部分不显示。 |
|
||||
| IMAGE\_DRAW\_SCALE\_H | 高度缩放显示。将图片缩放至目标矩形的高度，宽度按此比例进行缩放，超出不部分不显示。 |
|
||||
| IMAGE\_DRAW\_REPEAT | 平铺显示。 |
|
||||
| IMAGE\_DRAW\_REPEAT\_X | 水平方向平铺显示，垂直方向缩放。 |
|
||||
| IMAGE\_DRAW\_REPEAT\_Y | 垂直方向平铺显示，水平方向缩放。 |
|
||||
| IMAGE\_DRAW\_PATCH9 | 9宫格显示。
|
||||
将图片分成等大小的9块，4个角按原大小显示在目标矩形的4个角，左右上下和中间5块分别缩放显示在对应的目标区域。 |
|
||||
| IMAGE\_DRAW\_PATCH3\_X | 水平方向3宫格显示，垂直方向居中显示。
|
||||
将图片在水平方向上分成等大小的3块，左右两块按原大小显示在目标矩形的左右，中间一块缩放显示在目标区域中间剩余部分。 |
|
||||
| IMAGE\_DRAW\_PATCH3\_Y | 垂直方向3宫格显示，水平方向居中显示。
|
||||
将图片在垂直方向上分成等大小的3块，上下两块按原大小显示在目标矩形的上下，中间一块缩放显示在目标区域中间剩余部分。 |
|
||||
| IMAGE\_DRAW\_PATCH3\_X\_SCALE\_Y | 水平方向3宫格显示，垂直方向缩放显示。
|
||||
将图片在水平方向上分成等大小的3块，左右两块按原大小显示在目标矩形的左右，中间一块缩放显示在目标区域中间剩余部分。 |
|
||||
| IMAGE\_DRAW\_PATCH3\_Y\_SCALE\_X | 垂直方向3宫格显示，水平方向缩放显示。
|
||||
将图片在垂直方向上分成等大小的3块，上下两块按原大小显示在目标矩形的上下，中间一块缩放显示在目标区域中间剩余部分。 |
|
||||
33
docs/manual/image_loader_t.md
Normal file
33
docs/manual/image_loader_t.md
Normal file
@ -0,0 +1,33 @@
|
||||
## image\_loader\_t
|
||||
### 概述
|
||||
图片加载接口。
|
||||
|
||||
### 函数
|
||||
<p id="image_loader_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#image_loader_t_image_loader_load">image\_loader\_load</a> | 加载图片。 |
|
||||
### 属性
|
||||
<p id="image_loader_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="image_loader_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### image\_loader\_load 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| loader | image\_loader\_t* | loader对象。 |
|
||||
| asset | const asset\_info\_t* | 资源。 |
|
||||
| bitmap | bitmap\_t* | 用于返回位图对象。 |
|
||||
<p id="image_loader_t_image_loader_load"> 加载图片。
|
||||
|
||||
|
||||
|
||||
183
docs/manual/image_manager_t.md
Normal file
183
docs/manual/image_manager_t.md
Normal file
@ -0,0 +1,183 @@
|
||||
## image\_manager\_t
|
||||
### 概述
|
||||
图片管理器。负责加载，解码和缓存图片。
|
||||
|
||||
### 函数
|
||||
<p id="image_manager_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#image_manager_t_image_manager">image\_manager</a> | 获取缺省的图片管理器。 |
|
||||
| <a href="#image_manager_t_image_manager_add">image\_manager\_add</a> | 向缓存中加入一张图片 |
|
||||
| <a href="#image_manager_t_image_manager_create">image\_manager\_create</a> | 创建图片管理器。 |
|
||||
| <a href="#image_manager_t_image_manager_deinit">image\_manager\_deinit</a> | 析构图片管理器。 |
|
||||
| <a href="#image_manager_t_image_manager_destroy">image\_manager\_destroy</a> | 析构并释放图片管理器。 |
|
||||
| <a href="#image_manager_t_image_manager_init">image\_manager\_init</a> | 初始化图片管理器。 |
|
||||
| <a href="#image_manager_t_image_manager_load">image\_manager\_load</a> | 加载指定的图片。 |
|
||||
| <a href="#image_manager_t_image_manager_lookup">image\_manager\_lookup</a> | 从缓存中查找图片 |
|
||||
| <a href="#image_manager_t_image_manager_set">image\_manager\_set</a> | 设置缺省的图片管理器。 |
|
||||
| <a href="#image_manager_t_image_manager_set_assets_manager">image\_manager\_set\_assets\_manager</a> | 设置资源管理器对象 |
|
||||
| <a href="#image_manager_t_image_manager_unload_unused">image\_manager\_unload\_unused</a> | 从图片管理器中卸载指定时间内没有使用的图片。 |
|
||||
| <a href="#image_manager_t_image_manager_update_specific">image\_manager\_update\_specific</a> | 更新缓存中图片的specific信息。 |
|
||||
### 属性
|
||||
<p id="image_manager_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
### 事件
|
||||
<p id="image_manager_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### image\_manager 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | image\_manager\_t* | 返回图片管理器对象。 |
|
||||
<p id="image_manager_t_image_manager"> 获取缺省的图片管理器。
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_add 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
| name | char* | 图片名。 |
|
||||
| image | bitmap\_t* | 图片信息。 |
|
||||
<p id="image_manager_t_image_manager_add"> 向缓存中加入一张图片
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | image\_manager\_t* | 返回图片管理器对象。 |
|
||||
| loader | image\_loader\_t* | 图片加载器。 |
|
||||
<p id="image_manager_t_image_manager_create"> 创建图片管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
<p id="image_manager_t_image_manager_deinit"> 析构图片管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
<p id="image_manager_t_image_manager_destroy"> 析构并释放图片管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_init 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | image\_manager\_t* | 返回图片管理器对象。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
| loader | image\_loader\_t* | 图片加载器。 |
|
||||
<p id="image_manager_t_image_manager_init"> 初始化图片管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_load 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
| name | char* | 图片名称。 |
|
||||
| image | bitmap\_t* | 用于返回图片。 |
|
||||
<p id="image_manager_t_image_manager_load"> 加载指定的图片。
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_lookup 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
| name | char* | 图片名。 |
|
||||
| image | bitmap\_t* | 返回图片信息。 |
|
||||
<p id="image_manager_t_image_manager_lookup"> 从缓存中查找图片
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_set 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
<p id="image_manager_t_image_manager_set"> 设置缺省的图片管理器。
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_set\_assets\_manager 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
| assets\_manager | assets\_manager\_t* | 资源管理器。 |
|
||||
<p id="image_manager_t_image_manager_set_assets_manager"> 设置资源管理器对象
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_unload\_unused 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
| time\_delta\_s | uint32\_t | 时间范围，单位为秒。 |
|
||||
<p id="image_manager_t_image_manager_unload_unused"> 从图片管理器中卸载指定时间内没有使用的图片。
|
||||
|
||||
|
||||
|
||||
|
||||
#### image\_manager\_update\_specific 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| imm | image\_manager\_t* | 图片管理器对象。 |
|
||||
| image | bitmap\_t* | 返回图片信息。 |
|
||||
<p id="image_manager_t_image_manager_update_specific"> 更新缓存中图片的specific信息。
|
||||
|
||||
|
||||
|
||||
|
||||
79
docs/manual/image_t.md
Normal file
79
docs/manual/image_t.md
Normal file
@ -0,0 +1,79 @@
|
||||
## image\_t
|
||||
### 概述
|
||||
图片控件。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="image_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#image_t_image_cast">image\_cast</a> | 转换为image对象(供脚本语言使用)。
|
|
||||
| <a href="#image_t_image_create">image\_create</a> | 创建image对象
|
|
||||
| <a href="#image_t_image_set_draw_type">image\_set\_draw\_type</a> | 设置图片的显示方式。
|
|
||||
### 属性
|
||||
<p id="image_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#image_t_draw_type">draw\_type</a> | image_draw_type_t | 图片的绘制方式(仅在没有旋转和缩放时生效)。
|
|
||||
### 事件
|
||||
<p id="image_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### image\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | image对象。 |
|
||||
| widget | widget\_t* | image对象。 |
|
||||
<p id="image_t_image_cast"> 转换为image对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### image\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="image_t_image_create"> 创建image对象
|
||||
|
||||
|
||||
|
||||
#### image\_set\_draw\_type 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image对象。 |
|
||||
| draw\_type | image\_draw\_type\_t | 显示方式(仅在没有旋转和缩放时生效)。 |
|
||||
<p id="image_t_image_set_draw_type"> 设置图片的显示方式。
|
||||
|
||||
|
||||
|
||||
#### draw\_type 属性
|
||||
-----------------------
|
||||
<p id="image_t_draw_type"> 图片的绘制方式(仅在没有旋转和缩放时生效)。
|
||||
|
||||
|
||||
* 类型：image\_draw\_type\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
145
docs/manual/image_value_t.md
Normal file
145
docs/manual/image_value_t.md
Normal file
@ -0,0 +1,145 @@
|
||||
## image\_value\_t
|
||||
### 概述
|
||||
image_value控件。可以用图片来表示如电池电量、WIFI信号强度和其它各种数值的值。
|
||||
其原理如下：
|
||||
* 1.把value以format为格式转换成字符串。
|
||||
* 2.把每个字符与image(图片文件名前缀)映射成一个图片名。
|
||||
* 3.最后把这些图片显示出来。
|
||||
|
||||
|
||||
### 函数
|
||||
<p id="image_value_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#image_value_t_image_value_cast">image\_value\_cast</a> | 转换为image_value对象(供脚本语言使用)。
|
|
||||
| <a href="#image_value_t_image_value_create">image\_value\_create</a> | 创建image_value对象
|
|
||||
| <a href="#image_value_t_image_value_set_format">image\_value\_set\_format</a> | 设置格式。
|
|
||||
| <a href="#image_value_t_image_value_set_image">image\_value\_set\_image</a> | 设置图片前缀。
|
|
||||
| <a href="#image_value_t_image_value_set_value">image\_value\_set\_value</a> | 设置值。
|
|
||||
### 属性
|
||||
<p id="image_value_t_properties">
|
||||
|
||||
| 名属性称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#image_value_t_format">format</a> | char* | 数值到字符串转换时的格式，缺省为"%d"。
|
|
||||
| <a href="#image_value_t_image">image</a> | char* | 图片名称的前缀。
|
|
||||
| <a href="#image_value_t_value">value</a> | float_t | 值。
|
|
||||
### 事件
|
||||
<p id="image_value_t_events">
|
||||
|
||||
| 事件名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------- |
|
||||
#### image\_value\_cast 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | image\_value对象。 |
|
||||
| widget | widget\_t* | image\_value对象。 |
|
||||
<p id="image_value_t_image_value_cast"> 转换为image_value对象(供脚本语言使用)。
|
||||
|
||||
|
||||
|
||||
#### image\_value\_create 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | widget\_t* | 对象。 |
|
||||
| parent | widget\_t* | 父控件 |
|
||||
| x | xy\_t | x坐标 |
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
<p id="image_value_t_image_value_create"> 创建image_value对象
|
||||
|
||||
|
||||
|
||||
#### image\_value\_set\_format 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_value对象。 |
|
||||
| format | const char* | 格式。 |
|
||||
<p id="image_value_t_image_value_set_format"> 设置格式。
|
||||
|
||||
|
||||
|
||||
#### image\_value\_set\_image 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_value对象。 |
|
||||
| image | const char* | 图片前缀。 |
|
||||
<p id="image_value_t_image_value_set_image"> 设置图片前缀。
|
||||
|
||||
|
||||
|
||||
#### image\_value\_set\_value 函数
|
||||
-----------------------
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_value对象。 |
|
||||
| value | float\_t | 值。 |
|
||||
<p id="image_value_t_image_value_set_value"> 设置值。
|
||||
|
||||
|
||||
|
||||
#### format 属性
|
||||
-----------------------
|
||||
<p id="image_value_t_format"> 数值到字符串转换时的格式，缺省为"%d"。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### image 属性
|
||||
-----------------------
|
||||
<p id="image_value_t_image"> 图片名称的前缀。
|
||||
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
#### value 属性
|
||||
-----------------------
|
||||
<p id="image_value_t_value"> 值。
|
||||
|
||||
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 支通过widget_get_prop读取 | 是 |
|
||||
| 支通过widget_set_prop修改 | 是 |
|
||||
BIN
docs/manual/images/app_bar_t_0.png
Normal file
BIN
docs/manual/images/app_bar_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.9 KiB |
BIN
docs/manual/images/button_group_t_0.png
Normal file
BIN
docs/manual/images/button_group_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
BIN
docs/manual/images/button_t_0.png
Normal file
BIN
docs/manual/images/button_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.7 KiB |
BIN
docs/manual/images/calibration_win_t_0.png
Normal file
BIN
docs/manual/images/calibration_win_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.9 KiB |
BIN
docs/manual/images/candidates_t_0.png
Normal file
BIN
docs/manual/images/candidates_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
BIN
docs/manual/images/canvas_widget_t_0.png
Normal file
BIN
docs/manual/images/canvas_widget_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.8 KiB |
BIN
docs/manual/images/check_button_t_0.png
Normal file
BIN
docs/manual/images/check_button_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
BIN
docs/manual/images/color_component_t_0.png
Normal file
BIN
docs/manual/images/color_component_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.0 KiB |
BIN
docs/manual/images/color_picker_t_0.png
Normal file
BIN
docs/manual/images/color_picker_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
BIN
docs/manual/images/color_tile_t_0.png
Normal file
BIN
docs/manual/images/color_tile_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
BIN
docs/manual/images/column_t_0.png
Normal file
BIN
docs/manual/images/column_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.7 KiB |
BIN
docs/manual/images/combo_box_item_t_0.png
Normal file
BIN
docs/manual/images/combo_box_item_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.8 KiB |
BIN
docs/manual/images/combo_box_t_0.png
Normal file
BIN
docs/manual/images/combo_box_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.1 KiB |
BIN
docs/manual/images/dialog_client_t_0.png
Normal file
BIN
docs/manual/images/dialog_client_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.7 KiB |
BIN
docs/manual/images/dialog_t_0.png
Normal file
BIN
docs/manual/images/dialog_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.8 KiB |
BIN
docs/manual/images/dialog_title_t_0.png
Normal file
BIN
docs/manual/images/dialog_title_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
BIN
docs/manual/images/digit_clock_t_0.png
Normal file
BIN
docs/manual/images/digit_clock_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
BIN
docs/manual/images/dragger_t_0.png
Normal file
BIN
docs/manual/images/dragger_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.0 KiB |
BIN
docs/manual/images/edit_t_0.png
Normal file
BIN
docs/manual/images/edit_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.4 KiB |
BIN
docs/manual/images/gif_image_t_0.png
Normal file
BIN
docs/manual/images/gif_image_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.3 KiB |
BIN
docs/manual/images/grid_item_t_0.png
Normal file
BIN
docs/manual/images/grid_item_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
BIN
docs/manual/images/grid_t_0.png
Normal file
BIN
docs/manual/images/grid_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.5 KiB |
BIN
docs/manual/images/group_box_t_0.png
Normal file
BIN
docs/manual/images/group_box_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
BIN
docs/manual/images/guage_pointer_t_0.png
Normal file
BIN
docs/manual/images/guage_pointer_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.7 KiB |
BIN
docs/manual/images/guage_t_0.png
Normal file
BIN
docs/manual/images/guage_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.7 KiB |
BIN
docs/manual/images/im_action_button_info_event_t_0.png
Normal file
BIN
docs/manual/images/im_action_button_info_event_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.8 KiB |
BIN
docs/manual/images/im_candidates_event_t_0.png
Normal file
BIN
docs/manual/images/im_candidates_event_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.9 KiB |
BIN
docs/manual/images/im_commit_event_t_0.png
Normal file
BIN
docs/manual/images/im_commit_event_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.3 KiB |
BIN
docs/manual/images/image_animation_t_0.png
Normal file
BIN
docs/manual/images/image_animation_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.8 KiB |
BIN
docs/manual/images/image_base_t_0.png
Normal file
BIN
docs/manual/images/image_base_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
BIN
docs/manual/images/image_t_0.png
Normal file
BIN
docs/manual/images/image_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.6 KiB |
BIN
docs/manual/images/image_value_t_0.png
Normal file
BIN
docs/manual/images/image_value_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.5 KiB |
BIN
docs/manual/images/key_event_t_0.png
Normal file
BIN
docs/manual/images/key_event_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.7 KiB |
BIN
docs/manual/images/keyboard_t_0.png
Normal file
BIN
docs/manual/images/keyboard_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
BIN
docs/manual/images/label_t_0.png
Normal file
BIN
docs/manual/images/label_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.6 KiB |
BIN
docs/manual/images/list_item_t_0.png
Normal file
BIN
docs/manual/images/list_item_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.0 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user