diff --git a/docs/manual/app_bar_t.md b/docs/manual/app_bar_t.md index 9e49de5732..9040d02b91 100644 --- a/docs/manual/app_bar_t.md +++ b/docs/manual/app_bar_t.md @@ -1,9 +1,9 @@ ## app\_bar\_t ### 概述 - app_bar。一个简单的容器控件，一般在窗口的顶部。 - 它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。 ![image](images/app_bar_t_0.png) + app_bar。一个简单的容器控件，一般在窗口的顶部。 + 它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。 ### 函数

@@ -22,17 +22,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### app\_bar\_cast 函数 +* 函数原型： + +``` +widget_t* app_bar_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | app\_bar对象。 | | widget | widget\_t* | app\_bar对象。 | -

转换为app_bar对象(供脚本语言使用)。 +* 函数功能： + +>

转换为app_bar对象(供脚本语言使用)。 #### app\_bar\_create 函数 +* 函数原型： + +``` +widget_t* app_bar_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -43,7 +61,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建app_bar对象 +* 函数功能： + +>

创建app_bar对象 diff --git a/docs/manual/array_t.md b/docs/manual/array_t.md index 84d70c35b0..f8dc834a52 100644 --- a/docs/manual/array_t.md +++ b/docs/manual/array_t.md @@ -31,42 +31,80 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### array\_create 函数 +* 函数原型： + +``` +array_t* array_create (uint16_t* capacity); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | array\_t* | 数组对象。 | | capacity | uint16\_t* | 数组的初始容量。 | -

创建array对象 +* 函数功能： + +>

创建array对象 #### array\_deinit 函数 +* 函数原型： + +``` +void array_deinit (array_t* array); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | void | 无。 | | array | array\_t* | 数组对象。 | -

清除数组中的元素。 +* 函数功能： + +>

清除数组中的元素。 #### array\_destroy 函数 +* 函数原型： + +``` +void array_destroy (array_t* array); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | void | 无。 | | array | array\_t* | 数组对象。 | -

清除数组中的元素，并释放数组对象。 +* 函数功能： + +>

清除数组中的元素，并释放数组对象。 #### array\_find 函数 +* 函数原型： + +``` +void* array_find (array_t* array, tk_compare_t cmp, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -75,12 +113,22 @@ | array | array\_t* | 数组对象。 | | cmp | tk\_compare\_t | 比较函数，为NULL时直接比较指针。 | | ctx | void* | 比较函数的上下文。 | -

查找第一个满足条件的元素。 +* 函数功能： + +>

查找第一个满足条件的元素。 #### array\_find\_index 函数 +* 函数原型： + +``` +int array_find_index (array_t* array, tk_compare_t cmp, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -89,12 +137,22 @@ | array | array\_t* | 数组对象。 | | cmp | tk\_compare\_t | 比较函数，为NULL时直接比较指针。 | | ctx | void* | 比较函数的上下文。 | -

查找第一个满足条件的元素，并返回位置。 +* 函数功能： + +>

查找第一个满足条件的元素，并返回位置。 #### array\_init 函数 +* 函数原型： + +``` +array_t* array_init (array_t* array, uint16_t* capacity); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -102,24 +160,44 @@ | 返回值 | array\_t* | 数组对象。 | | array | array\_t* | 数组对象。 | | capacity | uint16\_t* | 数组的初始容量。 | -

初始化array对象 +* 函数功能： + +>

初始化array对象 #### array\_pop 函数 +* 函数原型： + +``` +void* array_pop (array_t* array); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | void* | 成功返回最后一个元素，失败返回NULL。 | | array | array\_t* | 数组对象。 | -

弹出最后一个元素。 +* 函数功能： + +>

弹出最后一个元素。 #### array\_push 函数 +* 函数原型： + +``` +ret_t array_push (array_t* array, void* data); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -127,12 +205,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | array | array\_t* | 数组对象。 | | data | void* | 待追加的元素。 | -

在尾巴追加一个元素。 +* 函数功能： + +>

在尾巴追加一个元素。 #### array\_remove 函数 +* 函数原型： + +``` +ret_t array_remove (array_t* array, tk_compare_t cmp, void* ctx, tk_destroy_t destroy); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -142,12 +230,22 @@ | cmp | tk\_compare\_t | 比较函数，为NULL时直接比较指针。 | | ctx | void* | 比较函数的上下文。 | | destroy | tk\_destroy\_t | 销毁元素的回调函数。 | -

删除第一个满足条件的元素。 +* 函数功能： + +>

删除第一个满足条件的元素。 #### array\_remove\_all 函数 +* 函数原型： + +``` +ret_t array_remove_all (array_t* array, tk_compare_t cmp, void* ctx, tk_destroy_t destroy); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -157,14 +255,16 @@ | cmp | tk\_compare\_t | 比较函数，为NULL时直接比较指针。 | | ctx | void* | 比较函数的上下文。 | | destroy | tk\_destroy\_t | 销毁元素的回调函数。 | -

删除全部满足条件的元素。 +* 函数功能： + +>

删除全部满足条件的元素。 #### capacity 属性 ----------------------- -

数组的容量大小。 +>

数组的容量大小。 @@ -182,7 +282,7 @@ | 支通过widget_set_prop修改 | 否 | #### elms 属性 ----------------------- -

数组中的元素。 +>

数组中的元素。 @@ -200,7 +300,7 @@ | 支通过widget_set_prop修改 | 否 | #### size 属性 ----------------------- -

数组中元素的个数。 +>

数组中元素的个数。 diff --git a/docs/manual/asset_info_t.md b/docs/manual/asset_info_t.md index 9bcc3e63b0..a02d756149 100644 --- a/docs/manual/asset_info_t.md +++ b/docs/manual/asset_info_t.md @@ -25,7 +25,7 @@ | -------- | ----- | ------- | #### is\_in\_rom 属性 ----------------------- -

资源是否在ROM中。 +>

资源是否在ROM中。 @@ -43,7 +43,7 @@ | 支通过widget_set_prop修改 | 否 | #### name 属性 ----------------------- -

名称。 +>

名称。 @@ -61,7 +61,7 @@ | 支通过widget_set_prop修改 | 否 | #### refcount 属性 ----------------------- -

引用计数。is_in_rom == FALSE时才有效。 +>

引用计数。is_in_rom == FALSE时才有效。 @@ -79,7 +79,7 @@ | 支通过widget_set_prop修改 | 否 | #### size 属性 ----------------------- -

大小。 +>

大小。 @@ -97,7 +97,7 @@ | 支通过widget_set_prop修改 | 否 | #### subtype 属性 ----------------------- -

子类型。 +>

子类型。 @@ -115,7 +115,7 @@ | 支通过widget_set_prop修改 | 否 | #### type 属性 ----------------------- -

类型。 +>

类型。 diff --git a/docs/manual/assets_manager_t.md b/docs/manual/assets_manager_t.md index f014e22992..58805c6eee 100644 --- a/docs/manual/assets_manager_t.md +++ b/docs/manual/assets_manager_t.md @@ -31,17 +31,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### assets\_manager 函数 +* 函数原型： + +``` +assets_manager_t* assets_manager (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | assets\_manager\_t* | 返回asset manager对象。 | -

获取缺省资源管理器。 +* 函数功能： + +>

获取缺省资源管理器。 #### assets\_manager\_add 函数 +* 函数原型： + +``` +ret_t assets_manager_add (assets_manager_t* rm, asset_info_t info); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -49,12 +67,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rm | assets\_manager\_t* | asset manager对象。 | | info | asset\_info\_t | 待增加的资源。 | -

向资源管理器中增加一个资源。 +* 函数功能： + +>

向资源管理器中增加一个资源。 #### assets\_manager\_clear\_cache 函数 +* 函数原型： + +``` +ret_t assets_manager_clear_cache (assets_manager_t* rm, asset_type_t type); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -62,48 +90,88 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rm | assets\_manager\_t* | asset manager对象。 | | type | asset\_type\_t | 资源的类型。 | -

清除指定类型的缓存。 +* 函数功能： + +>

清除指定类型的缓存。 #### assets\_manager\_create 函数 +* 函数原型： + +``` +assets_manager_t* assets_manager_create (uint32_t init_nr); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | assets\_manager\_t* | 返回asset manager对象。 | | init\_nr | uint32\_t | 预先分配资源的个数。 | -

创建资源管理器。 +* 函数功能： + +>

创建资源管理器。 #### assets\_manager\_deinit 函数 +* 函数原型： + +``` +ret_t assets_manager_deinit (assets_manager_t* rm); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rm | assets\_manager\_t* | asset manager对象。 | -

释放全部资源。 +* 函数功能： + +>

释放全部资源。 #### assets\_manager\_destroy 函数 +* 函数原型： + +``` +ret_t assets_manager_destroy (assets_manager_t* rm); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rm | assets\_manager\_t* | asset manager对象。 | -

释放全部资源并销毁asset manager对象。 +* 函数功能： + +>

释放全部资源并销毁asset manager对象。 #### assets\_manager\_find\_in\_cache 函数 +* 函数原型： + +``` +asset_info_t* assets_manager_find_in_cache (assets_manager_t* rm, asset_type_t type, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -112,12 +180,22 @@ | rm | assets\_manager\_t* | asset manager对象。 | | type | asset\_type\_t | 资源的类型。 | | name | char* | 资源的名称。 | -

在资源管理器的缓存中查找指定的资源(不引用)。 +* 函数功能： + +>

在资源管理器的缓存中查找指定的资源(不引用)。 #### assets\_manager\_init 函数 +* 函数原型： + +``` +assets_manager_t* assets_manager_init (assets_manager_t* rm, uint32_t init_nr); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -125,12 +203,22 @@ | 返回值 | assets\_manager\_t* | 返回asset manager对象。 | | rm | assets\_manager\_t* | asset manager对象。 | | init\_nr | uint32\_t | 预先分配资源的个数。 | -

初始化资源管理器。 +* 函数功能： + +>

初始化资源管理器。 #### assets\_manager\_load 函数 +* 函数原型： + +``` +asset_info_t* assets_manager_load (assets_manager_t* rm, asset_type_t type, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -139,12 +227,22 @@ | rm | assets\_manager\_t* | asset manager对象。 | | type | asset\_type\_t | 资源的类型。 | | name | char* | 资源的名称。 | -

从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH_FS_RES时才生效。 +* 函数功能： + +>

从文件系统中加载指定的资源，并缓存到内存中。在定义了宏WITH_FS_RES时才生效。 #### assets\_manager\_ref 函数 +* 函数原型： + +``` +asset_info_t* assets_manager_ref (assets_manager_t* rm, asset_type_t type, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -153,24 +251,44 @@ | rm | assets\_manager\_t* | asset manager对象。 | | type | asset\_type\_t | 资源的类型。 | | name | char* | 资源的名称。 | -

在资源管理器的缓存中查找指定的资源并引用它，如果缓存中不存在，尝试加载该资源。 +* 函数功能： + +>

在资源管理器的缓存中查找指定的资源并引用它，如果缓存中不存在，尝试加载该资源。 #### assets\_manager\_set 函数 +* 函数原型： + +``` +ret_t assets_manager_set (assets_manager_t* rm); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rm | assets\_manager\_t* | asset manager对象。 | -

设置缺省资源管理器。 +* 函数功能： + +>

设置缺省资源管理器。 #### assets\_manager\_set\_res\_root 函数 +* 函数原型： + +``` +ret_t assets_manager_set_res_root (assets_manager_t* rm, const char* res_root); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -178,12 +296,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rm | assets\_manager\_t* | asset manager对象。 | | res\_root | const char* | 资源所在的目录。 | -

设置资源所在的目录(其下目录结构请参考demos)。 +* 函数功能： + +>

设置资源所在的目录(其下目录结构请参考demos)。 #### assets\_manager\_unref 函数 +* 函数原型： + +``` +ret_t assets_manager_unref (assets_manager_t* rm, asset_info_t* info); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -191,7 +319,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rm | assets\_manager\_t* | asset manager对象。 | | info | asset\_info\_t* | 资源。 | -

释放指定的资源。 +* 函数功能： + +>

释放指定的资源。 diff --git a/docs/manual/bitmap_t.md b/docs/manual/bitmap_t.md index 0527348ef5..550aa9d1fd 100644 --- a/docs/manual/bitmap_t.md +++ b/docs/manual/bitmap_t.md @@ -34,16 +34,34 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### bitmap\_create 函数 +* 函数原型： + +``` +bitmap_t* bitmap_create (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bitmap\_t* | 返回bitmap对象。 | -

创建图片对象(一般供脚本语言中使用)。 +* 函数功能： + +>

创建图片对象(一般供脚本语言中使用)。 #### bitmap\_create\_ex 函数 +* 函数原型： + +``` +bitmap_t* bitmap_create_ex (uint32_t w, uint32_t h, uint32_t line_length, bitmap_format_t format); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -53,47 +71,87 @@ | h | uint32\_t | 高度。 | | line\_length | uint32\_t | line\_length。 | | format | bitmap\_format\_t | 格式。 | -

创建图片对象。 +* 函数功能： + +>

创建图片对象。 #### bitmap\_destroy 函数 +* 函数原型： + +``` +ret_t bitmap_destroy (bitmap_t* bitmap); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | bitmap | bitmap\_t* | bitmap对象。 | -

销毁图片。 +* 函数功能： + +>

销毁图片。 #### bitmap\_get\_bpp 函数 +* 函数原型： + +``` +uint32_t bitmap_get_bpp (bitmap_t* bitmap); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint32\_t | 返回一个像素占用的字节数。 | | bitmap | bitmap\_t* | bitmap对象。 | -

获取图片一个像素占用的字节数。 +* 函数功能： + +>

获取图片一个像素占用的字节数。 #### bitmap\_get\_line\_length 函数 +* 函数原型： + +``` +ret_t bitmap_get_line_length (bitmap_t* bitmap); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | bitmap | bitmap\_t* | bitmap对象。 | -

获取每一行占用内存的字节数。 +* 函数功能： + +>

获取每一行占用内存的字节数。 #### bitmap\_get\_pixel 函数 +* 函数原型： + +``` +ret_t bitmap_get_pixel (bitmap_t* bitmap, uint32_t x, uint32_t y, rgba_t* rgba); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -103,12 +161,22 @@ | x | uint32\_t | x坐标。 | | y | uint32\_t | y坐标。 | | rgba | rgba\_t* | 返回颜色值。 | -

获取图片指定像素的rgba颜色值(主要用于测试程序)。 +* 函数功能： + +>

获取图片指定像素的rgba颜色值(主要用于测试程序)。 #### bitmap\_init 函数 +* 函数原型： + +``` +ret_t bitmap_init (bitmap_t* bitmap, uint32_t w, uint32_t h, bitmap_format_t format, const uint8_t* data); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -119,12 +187,22 @@ | h | uint32\_t | 高度。 | | format | bitmap\_format\_t | 格式。 | | data | const uint8\_t* | 数据，直接引用，但不负责释放。如果为空，由内部自动分配和释放。 | -

初始化图片。 +* 函数功能： + +>

初始化图片。 #### bitmap\_init\_from\_rgba 函数 +* 函数原型： + +``` +ret_t bitmap_init_from_rgba (bitmap_t* bitmap, uint32_t w, uint32_t h, bitmap_format_t format, const uint8_t* , uint32_t comp); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -136,13 +214,23 @@ | format | bitmap\_format\_t | 格式。 | | | const uint8\_t* | a | | comp | uint32\_t | 颜色通道数(目前支持3(rgb)和4(rgba))。 | -

初始化图片。 +* 函数功能： + +>

初始化图片。 数据。3通道时为RGB888格式，4通道时为RGBA888格式(内部拷贝该数据，不会引用，调用者自行释放)。 #### bitmap\_set\_line\_length 函数 +* 函数原型： + +``` +ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -150,14 +238,16 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | bitmap | bitmap\_t* | bitmap对象。 | | line\_length | uint32\_t | line\_length。 | -

设置line_length。 +* 函数功能： + +>

设置line_length。 #### data 属性 ----------------------- -

图片数据。 +>

图片数据。 @@ -175,7 +265,7 @@ | 支通过widget_set_prop修改 | 否 | #### flags 属性 ----------------------- -

标志。请参考{bitmap_flag_t}。 +>

标志。请参考{bitmap_flag_t}。 @@ -193,7 +283,7 @@ | 支通过widget_set_prop修改 | 否 | #### format 属性 ----------------------- -

格式。请参考{bitmap_format_t}。 +>

格式。请参考{bitmap_format_t}。 @@ -211,7 +301,7 @@ | 支通过widget_set_prop修改 | 否 | #### h 属性 ----------------------- -

高度。 +>

高度。 @@ -229,7 +319,7 @@ | 支通过widget_set_prop修改 | 否 | #### line\_length 属性 ----------------------- -

每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。 +>

每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。 @@ -247,7 +337,7 @@ | 支通过widget_set_prop修改 | 否 | #### name 属性 ----------------------- -

名称。 +>

名称。 @@ -265,7 +355,7 @@ | 支通过widget_set_prop修改 | 否 | #### w 属性 ----------------------- -

宽度。 +>

宽度。 diff --git a/docs/manual/button_group_t.md b/docs/manual/button_group_t.md index 1c208bb2c6..719341b281 100644 --- a/docs/manual/button_group_t.md +++ b/docs/manual/button_group_t.md @@ -1,8 +1,8 @@ ## button\_group\_t ### 概述 - Button Group控件。 ![image](images/button_group_t_0.png) + Button Group控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### button\_group\_cast 函数 +* 函数原型： + +``` +widget_t* button_group_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | button\_group对象。 | | widget | widget\_t* | button\_group对象。 | -

转换为button_group对象(供脚本语言使用)。 +* 函数功能： + +>

转换为button_group对象(供脚本语言使用)。 #### button\_group\_create 函数 +* 函数原型： + +``` +widget_t* button_group_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建button_group对象 +* 函数功能： + +>

创建button_group对象 diff --git a/docs/manual/button_t.md b/docs/manual/button_t.md index a7ee7de8c0..0e8a24e77f 100644 --- a/docs/manual/button_t.md +++ b/docs/manual/button_t.md @@ -1,8 +1,8 @@ ## button\_t ### 概述 - 按钮控件。 ![image](images/button_t_0.png) + 按钮控件。 ### 函数

@@ -25,17 +25,35 @@ | EVT\_CLICK | pointer\_event\_t | 点击事件。 | | EVT\_LONG\_PRESS | pointer\_event\_t | 长按事件。 | #### button\_cast 函数 +* 函数原型： + +``` +widget_t* button_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | button对象。 | | widget | widget\_t* | button对象。 | -

转换为button对象(供脚本语言使用)。 +* 函数功能： + +>

转换为button对象(供脚本语言使用)。 #### button\_create 函数 +* 函数原型： + +``` +widget_t* button_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -46,11 +64,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建button对象 +* 函数功能： + +>

创建button对象 #### button\_set\_repeat 函数 +* 函数原型： + +``` +ret_t button_set_repeat (widget_t* widget, int32_t repeat); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -58,13 +86,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | repeat | int32\_t | 释放EVT\_CLICK事件的时间间隔(毫秒)。 | -

设置释放EVT_CLICK事件的时间间隔。为0则不重复释放EVT_CLICK事件。 +* 函数功能： + +>

设置释放EVT_CLICK事件的时间间隔。为0则不重复释放EVT_CLICK事件。 #### repeat 属性 ----------------------- -

重复释放EVT_CLICK事件的时间间隔。为0则不重复释放EVT_CLICK事件。 +>

重复释放EVT_CLICK事件的时间间隔。为0则不重复释放EVT_CLICK事件。 * 类型：int32\_t diff --git a/docs/manual/calibration_win_t.md b/docs/manual/calibration_win_t.md index 7c4ae06de7..5ad567289b 100644 --- a/docs/manual/calibration_win_t.md +++ b/docs/manual/calibration_win_t.md @@ -1,8 +1,8 @@ ## calibration\_win\_t ### 概述 - 电阻屏校准屏幕。 ![image](images/calibration_win_t_0.png) + 电阻屏校准屏幕。 ### 函数

@@ -22,6 +22,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### calibration\_win\_create 函数 +* 函数原型： + +``` +widget_t* calibration_win_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -32,11 +40,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建calibration_win对象 +* 函数功能： + +>

创建calibration_win对象 #### calibration\_win\_set\_on\_click 函数 +* 函数原型： + +``` +ret_t calibration_win_set_on_click (widget_t* widget, calibration_win_on_click_t on_click, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -45,11 +63,21 @@ | widget | widget\_t* | widget对象。 | | on\_click | calibration\_win\_on\_click\_t | 回调函数。 | | ctx | void* | 回调函数的上下文。 | -

设置校准点击事件的处理函数。 +* 函数功能： + +>

设置校准点击事件的处理函数。 #### calibration\_win\_set\_on\_done 函数 +* 函数原型： + +``` +ret_t calibration_win_set_on_done (widget_t* widget, calibration_win_on_done_t on_done, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -58,7 +86,9 @@ | widget | widget\_t* | widget对象。 | | on\_done | calibration\_win\_on\_done\_t | 回调函数。 | | ctx | void* | 回调函数的上下文。 | -

设置校准完成的处理函数。 +* 函数功能： + +>

设置校准完成的处理函数。 diff --git a/docs/manual/candidates_t.md b/docs/manual/candidates_t.md index 7d42233295..cec104db6d 100644 --- a/docs/manual/candidates_t.md +++ b/docs/manual/candidates_t.md @@ -1,8 +1,8 @@ ## candidates\_t ### 概述 - 输入法候选字词控件。 ![image](images/candidates_t_0.png) + 输入法候选字词控件。 ### 函数

@@ -20,6 +20,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### candidates\_create 函数 +* 函数原型： + +``` +widget_t* candidates_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -30,7 +38,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建candidates对象 +* 函数功能： + +>

创建candidates对象 diff --git a/docs/manual/canvas_widget_t.md b/docs/manual/canvas_widget_t.md index b965768da7..be1b8c77db 100644 --- a/docs/manual/canvas_widget_t.md +++ b/docs/manual/canvas_widget_t.md @@ -1,8 +1,8 @@ ## canvas\_widget\_t ### 概述 - 画布控件。 ![image](images/canvas_widget_t_0.png) + 画布控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### canvas\_widget\_cast 函数 +* 函数原型： + +``` +widget_t* canvas_widget_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | canvas\_widget对象。 | | widget | widget\_t* | canvas\_widget对象。 | -

转换为canvas_widget对象(供脚本语言使用)。 +* 函数功能： + +>

转换为canvas_widget对象(供脚本语言使用)。 #### canvas\_widget\_create 函数 +* 函数原型： + +``` +widget_t* canvas_widget_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建canvas_widget对象 +* 函数功能： + +>

创建canvas_widget对象 diff --git a/docs/manual/check_button_t.md b/docs/manual/check_button_t.md index 2b9dad8074..6f8116aaca 100644 --- a/docs/manual/check_button_t.md +++ b/docs/manual/check_button_t.md @@ -1,8 +1,8 @@ ## check\_button\_t ### 概述 - 勾选控件。 ![image](images/check_button_t_0.png) + 勾选控件。 ### 函数

@@ -26,17 +26,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(勾选状态)即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值(勾选状态)改变事件。 | #### check\_button\_cast 函数 +* 函数原型： + +``` +widget_t* check_button_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | check\_button对象。 | | widget | widget\_t* | check\_button对象。 | -

转换check_button对象(供脚本语言使用)。 +* 函数功能： + +>

转换check_button对象(供脚本语言使用)。 #### check\_button\_create 函数 +* 函数原型： + +``` +widget_t* check_button_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -47,11 +65,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建check_button对象 +* 函数功能： + +>

创建check_button对象 #### check\_button\_create\_radio 函数 +* 函数原型： + +``` +widget_t* check_button_create_radio (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -62,11 +90,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建check_button对象 +* 函数功能： + +>

创建check_button对象 #### check\_button\_set\_value 函数 +* 函数原型： + +``` +ret_t check_button_set_value (widget_t* widget, bool_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -74,13 +112,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | check\_button对象。 | | value | bool\_t | 值 | -

设置控件的值。 +* 函数功能： + +>

设置控件的值。 #### value 属性 ----------------------- -

值。 +>

值。 * 类型：bool\_t diff --git a/docs/manual/children_layouter_t.md b/docs/manual/children_layouter_t.md index b022fcae6d..44dca3c400 100644 --- a/docs/manual/children_layouter_t.md +++ b/docs/manual/children_layouter_t.md @@ -28,18 +28,36 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### children\_layouter\_destroy 函数 +* 函数原型： + +``` +ret_t children_layouter_destroy (children_layouter_t* layouter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | layouter | children\_layouter\_t* | layouter对象。 | -

销毁layouter对象。 +* 函数功能： + +>

销毁layouter对象。 #### children\_layouter\_get\_param 函数 +* 函数原型： + +``` +ret_t children_layouter_get_param (children_layouter_t* layouter, const char* name, value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -48,12 +66,22 @@ | layouter | children\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | v | value\_t* | 返回参数的值。 | -

获取指定的参数。 +* 函数功能： + +>

获取指定的参数。 #### children\_layouter\_get\_param\_float 函数 +* 函数原型： + +``` +ret_t children_layouter_get_param_float (children_layouter_t* layouter, const char* name, float_t defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -62,12 +90,22 @@ | layouter | children\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | defval | float\_t | 缺省值。 | -

获取指定的浮点格式的参数。 +* 函数功能： + +>

获取指定的浮点格式的参数。 #### children\_layouter\_get\_param\_int 函数 +* 函数原型： + +``` +ret_t children_layouter_get_param_int (children_layouter_t* layouter, const char* name, int32_t defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -76,24 +114,44 @@ | layouter | children\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | defval | int32\_t | 缺省值。 | -

获取指定的整数格式的参数。 +* 函数功能： + +>

获取指定的整数格式的参数。 #### children\_layouter\_is\_valid 函数 +* 函数原型： + +``` +bool_t children_layouter_is_valid (children_layouter_t* layouter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bool\_t | 返回TRUE表示有效，否则表示无效。 | | layouter | children\_layouter\_t* | layouter对象。 | -

判断layouter对象是否有效。 +* 函数功能： + +>

判断layouter对象是否有效。 #### children\_layouter\_layout 函数 +* 函数原型： + +``` +ret_t children_layouter_layout (children_layouter_t* layouter, widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -101,12 +159,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | layouter | children\_layouter\_t* | layouter对象。 | | widget | widget\_t* | 控件。 | -

对子控件进行Layout。 +* 函数功能： + +>

对子控件进行Layout。 #### children\_layouter\_set\_param 函数 +* 函数原型： + +``` +ret_t children_layouter_set_param (children_layouter_t* layouter, const char* name, const value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -115,12 +183,22 @@ | layouter | children\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | v | const value\_t* | 参数的值。 | -

获取指定的参数。 +* 函数功能： + +>

获取指定的参数。 #### children\_layouter\_set\_param\_str 函数 +* 函数原型： + +``` +ret_t children_layouter_set_param_str (children_layouter_t* layouter, const char* name, const char* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -129,19 +207,31 @@ | layouter | children\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | value | const char* | 参数值。 | -

设置字符串格式的参数。 +* 函数功能： + +>

设置字符串格式的参数。 #### children\_layouter\_to\_string 函数 +* 函数原型： + +``` +ret_t children_layouter_to_string (children_layouter_t* layouter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回字符串格式的参数。 | | layouter | children\_layouter\_t* | layouter对象。 | -

获取全部参数。 +* 函数功能： + +>

获取全部参数。 diff --git a/docs/manual/clip_board_t.md b/docs/manual/clip_board_t.md index 3a0e5f7ee3..612cdad385 100644 --- a/docs/manual/clip_board_t.md +++ b/docs/manual/clip_board_t.md @@ -26,41 +26,79 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### clip\_board 函数 +* 函数原型： + +``` +ret_t clip_board (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回缺省剪切板对象。 | -

获取缺省的剪切板对象。 +* 函数功能： + +>

获取缺省的剪切板对象。 #### clip\_board\_clear 函数 +* 函数原型： + +``` +ret_t clip_board_clear (clip_board_t* cl); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | cl | clip\_board\_t* | 剪切板对象。 | -

清空剪切板中的数据。 +* 函数功能： + +>

清空剪切板中的数据。 #### clip\_board\_destroy 函数 +* 函数原型： + +``` +ret_t clip_board_destroy (clip_board_t* cl); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | cl | clip\_board\_t* | 剪切板对象。 | -

销毁剪切板对象。 +* 函数功能： + +>

销毁剪切板对象。 #### clip\_board\_get\_data 函数 +* 函数原型： + +``` +ret_t clip_board_get_data (clip_board_t* cl, clip_board_data_type_t* type, void** data data, uint32_t* size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -70,35 +108,65 @@ | type | clip\_board\_data\_type\_t* | 返回数据类型(可为NULL)。 | | data | void** data | 返回数据(可为NULL)。 | | size | uint32\_t* | 返回数据长度(可为NULL)。 | -

从剪切板中获取数据。 +* 函数功能： + +>

从剪切板中获取数据。 #### clip\_board\_get\_text 函数 +* 函数原型： + +``` +const char* clip_board_get_text (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | const char* | 返回文本数据。 | -

从剪切板中获取文本(UTF8)数据。 +* 函数功能： + +>

从剪切板中获取文本(UTF8)数据。 #### clip\_board\_set 函数 +* 函数原型： + +``` +ret_t clip_board_set (clip_board_t* cl); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | cl | clip\_board\_t* | 剪切板对象。 | -

设置缺省的剪切板对象。 +* 函数功能： + +>

设置缺省的剪切板对象。 #### clip\_board\_set\_data 函数 +* 函数原型： + +``` +ret_t clip_board_set_data (clip_board_t* cl, clip_board_data_type_t type, const void* data data, uint32_t size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -108,19 +176,31 @@ | type | clip\_board\_data\_type\_t | 数据类型。 | | data | const void* data | 数据。 | | size | uint32\_t | 数据长度 | -

设置数据到剪切板中。 +* 函数功能： + +>

设置数据到剪切板中。 #### clip\_board\_set\_text 函数 +* 函数原型： + +``` +ret_t clip_board_set_text (const char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | text | const char* | 文本。 | -

设置文本(UTF8)数据到剪切板。 +* 函数功能： + +>

设置文本(UTF8)数据到剪切板。 diff --git a/docs/manual/color_component_t.md b/docs/manual/color_component_t.md index a1ffc98458..37fde54ca1 100644 --- a/docs/manual/color_component_t.md +++ b/docs/manual/color_component_t.md @@ -1,11 +1,11 @@ ## color\_component\_t ### 概述 +![image](images/color_component_t_0.png) + 颜色选择器的颜色分量。 控件的名称有严格规定： COLOR_PICKER_CHILD_SV: 水平为Value/Brightness(递增)，垂直为Saturation(递减)。 COLOR_PICKER_CHILD_H: 水平为同色，垂直为Hue(递减)。 -![image](images/color_component_t_0.png) - ### 函数

@@ -27,6 +27,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### color\_component\_create 函数 +* 函数原型： + +``` +widget_t* color_component_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -37,44 +45,84 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建color_component对象 +* 函数功能： + +>

创建color_component对象 #### color\_component\_get\_h 函数 +* 函数原型： + +``` +float color_component_get_h (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | float | 返回h分量。 | | widget | widget\_t* | color\_component对象。 | -

获取h分量。 +* 函数功能： + +>

获取h分量。 #### color\_component\_get\_s 函数 +* 函数原型： + +``` +float color_component_get_s (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | float | 返回s分量。 | | widget | widget\_t* | color\_component对象。 | -

获取s分量。 +* 函数功能： + +>

获取s分量。 #### color\_component\_get\_v 函数 +* 函数原型： + +``` +float color_component_get_v (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | float | 返回v分量。 | | widget | widget\_t* | color\_component对象。 | -

获取v分量。 +* 函数功能： + +>

获取v分量。 #### color\_component\_set\_color 函数 +* 函数原型： + +``` +ret_t color_component_set_color (widget_t* widget, color_t c); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -82,7 +130,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | c | color\_t | 颜色。 | -

设置颜色。 +* 函数功能： + +>

设置颜色。 diff --git a/docs/manual/color_picker_t.md b/docs/manual/color_picker_t.md index bddea40da6..c23f18dcac 100644 --- a/docs/manual/color_picker_t.md +++ b/docs/manual/color_picker_t.md @@ -1,5 +1,7 @@ ## color\_picker\_t ### 概述 +![image](images/color_picker_t_0.png) + 颜色选择器。 其中的控件必须按下列规则命名： COLOR_PICKER_CHILD_R 红色分量。可以是spin_box、edit和slider。 COLOR_PICKER_CHILD_G 绿色分量。可以是spin_box、edit和slider。 @@ -10,8 +12,6 @@ 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。 -![image](images/color_picker_t_0.png) - ### 函数

@@ -34,17 +34,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(颜色)即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值(颜色)改变事件。 | #### color\_picker\_cast 函数 +* 函数原型： + +``` +widget_t* color_picker_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | color\_picker对象。 | | widget | widget\_t* | color\_picker对象。 | -

转换为color_picker对象(供脚本语言使用)。 +* 函数功能： + +>

转换为color_picker对象(供脚本语言使用)。 #### color\_picker\_create 函数 +* 函数原型： + +``` +widget_t* color_picker_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -55,11 +73,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建color_picker对象 +* 函数功能： + +>

创建color_picker对象 #### color\_picker\_set\_color 函数 +* 函数原型： + +``` +ret_t color_picker_set_color (widget_t* widget, const char* color); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -67,13 +95,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | color | const char* | 颜色。 | -

设置颜色。 +* 函数功能： + +>

设置颜色。 #### value 属性 ----------------------- -

颜色。 +>

颜色。 * 类型：const char* diff --git a/docs/manual/color_tile_t.md b/docs/manual/color_tile_t.md index ccab0fa8b7..d414916f22 100644 --- a/docs/manual/color_tile_t.md +++ b/docs/manual/color_tile_t.md @@ -1,8 +1,8 @@ ## color\_tile\_t ### 概述 - 色块控件。 ![image](images/color_tile_t_0.png) + 色块控件。 ### 函数

@@ -26,17 +26,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### color\_tile\_cast 函数 +* 函数原型： + +``` +widget_t* color_tile_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | color\_tile对象。 | | widget | widget\_t* | color\_tile对象。 | -

转换为color_tile对象(供脚本语言使用)。 +* 函数功能： + +>

转换为color_tile对象(供脚本语言使用)。 #### color\_tile\_create 函数 +* 函数原型： + +``` +widget_t* color_tile_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -47,11 +65,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建color_tile对象 +* 函数功能： + +>

创建color_tile对象 #### color\_tile\_set\_bg\_color 函数 +* 函数原型： + +``` +ret_t color_tile_set_bg_color (widget_t* widget, const char* color); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -59,11 +87,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | color | const char* | 背景颜色。 | -

设置背景颜色。 +* 函数功能： + +>

设置背景颜色。 #### color\_tile\_set\_border\_color 函数 +* 函数原型： + +``` +ret_t color_tile_set_border_color (widget_t* widget, const char* color); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -71,11 +109,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | color | const char* | 边框颜色。 | -

设置边框颜色。 +* 函数功能： + +>

设置边框颜色。 #### color\_tile\_set\_value 函数 +* 函数原型： + +``` +ret_t color_tile_set_value (widget_t* widget, color_t color); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -83,13 +131,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | color | color\_t | 背景颜色。 | -

设置背景颜色。 +* 函数功能： + +>

设置背景颜色。 #### bg\_color 属性 ----------------------- -

背景颜色。 +>

背景颜色。 * 类型：const char* @@ -106,7 +156,7 @@ | 支通过widget_set_prop修改 | 是 | #### border\_color 属性 ----------------------- -

边框颜色。 +>

边框颜色。 * 类型：const char* diff --git a/docs/manual/column_t.md b/docs/manual/column_t.md index 509482797f..8efb544525 100644 --- a/docs/manual/column_t.md +++ b/docs/manual/column_t.md @@ -1,9 +1,9 @@ ## column\_t ### 概述 - column。一个简单的容器控件，垂直排列一组控件。 - 它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。 ![image](images/column_t_0.png) + column。一个简单的容器控件，垂直排列一组控件。 + 它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。 ### 函数

@@ -22,17 +22,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### column\_cast 函数 +* 函数原型： + +``` +widget_t* column_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | column对象。 | | widget | widget\_t* | column对象。 | -

转换为column对象(供脚本语言使用)。 +* 函数功能： + +>

转换为column对象(供脚本语言使用)。 #### column\_create 函数 +* 函数原型： + +``` +widget_t* column_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -43,7 +61,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建column对象 +* 函数功能： + +>

创建column对象 diff --git a/docs/manual/combo_box_item_t.md b/docs/manual/combo_box_item_t.md index f253ab039b..835a8d6230 100644 --- a/docs/manual/combo_box_item_t.md +++ b/docs/manual/combo_box_item_t.md @@ -1,8 +1,8 @@ ## combo\_box\_item\_t ### 概述 - ComboBox Item控件。 ![image](images/combo_box_item_t_0.png) + ComboBox Item控件。 ### 函数

@@ -27,17 +27,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(勾选状态)即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值(勾选状态)改变事件。 | #### combo\_box\_item\_cast 函数 +* 函数原型： + +``` +widget_t* combo_box_item_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | combo\_box\_item对象。 | | widget | widget\_t* | combo\_box\_item对象。 | -

转换combo_box_item对象(供脚本语言使用)。 +* 函数功能： + +>

转换combo_box_item对象(供脚本语言使用)。 #### combo\_box\_item\_create 函数 +* 函数原型： + +``` +widget_t* combo_box_item_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -48,11 +66,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建combo_box_item对象 +* 函数功能： + +>

创建combo_box_item对象 #### combo\_box\_item\_set\_checked 函数 +* 函数原型： + +``` +ret_t combo_box_item_set_checked (widget_t* widget, bool_t checked); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -60,11 +88,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | combo\_box\_item对象。 | | checked | bool\_t | 是否被选中。 | -

设置控件是否被选中。 +* 函数功能： + +>

设置控件是否被选中。 #### combo\_box\_item\_set\_value 函数 +* 函数原型： + +``` +ret_t combo_box_item_set_value (widget_t* widget, int32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -72,13 +110,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | combo\_box\_item对象。 | | value | int32\_t | 值 | -

设置控件的值。 +* 函数功能： + +>

设置控件的值。 #### checked 属性 ----------------------- -

是否被选中。 +>

是否被选中。 * 类型：bool\_t @@ -95,7 +135,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

值。 +>

值。 * 类型：int32\_t diff --git a/docs/manual/combo_box_t.md b/docs/manual/combo_box_t.md index d44e3c7c6a..7924b19226 100644 --- a/docs/manual/combo_box_t.md +++ b/docs/manual/combo_box_t.md @@ -1,8 +1,8 @@ ## combo\_box\_t ### 概述 - combobox控件。 ![image](images/combo_box_t_0.png) + combobox控件。 ### 函数

@@ -36,6 +36,14 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值改变事件。 | #### combo\_box\_append\_option 函数 +* 函数原型： + +``` +ret_t combo_box_append_option (widget_t* widget, int32_t value, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -44,33 +52,63 @@ | widget | widget\_t* | combo\_box对象。 | | value | int32\_t | 值。 | | text | char* | 文本。 | -

追加一个选项。 +* 函数功能： + +>

追加一个选项。 #### combo\_box\_cast 函数 +* 函数原型： + +``` +widget_t* combo_box_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | combo\_box对象。 | | widget | widget\_t* | combo\_box对象。 | -

转换combo_box对象(供脚本语言使用)。 +* 函数功能： + +>

转换combo_box对象(供脚本语言使用)。 #### combo\_box\_count\_options 函数 +* 函数原型： + +``` +int32_t combo_box_count_options (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int32\_t | 返回选项个数。 | | widget | widget\_t* | combo\_box对象。 | -

获取选项个数。 +* 函数功能： + +>

获取选项个数。 #### combo\_box\_create 函数 +* 函数原型： + +``` +widget_t* combo_box_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -81,11 +119,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建combo_box对象 +* 函数功能： + +>

创建combo_box对象 #### combo\_box\_get\_option 函数 +* 函数原型： + +``` +combo_box_option_t* combo_box_get_option (widget_t* widget, uint32_t index); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -93,44 +141,84 @@ | 返回值 | combo\_box\_option\_t* | 返回index个选项。 | | widget | widget\_t* | combo\_box对象。 | | index | uint32\_t | 选项的索引。 | -

获取第index个选项。 +* 函数功能： + +>

获取第index个选项。 #### combo\_box\_get\_text 函数 +* 函数原型： + +``` +char* combo_box_get_text (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | char* | 返回文本。 | | widget | widget\_t* | combo\_box对象。 | -

获取combo_box的文本。 +* 函数功能： + +>

获取combo_box的文本。 #### combo\_box\_get\_value 函数 +* 函数原型： + +``` +int32_t combo_box_get_value (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int32\_t | 返回值。 | | widget | widget\_t* | combo\_box对象。 | -

获取combo_box的值。 +* 函数功能： + +>

获取combo_box的值。 #### combo\_box\_reset\_options 函数 +* 函数原型： + +``` +ret_t combo_box_reset_options (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | combo\_box对象。 | -

重置所有选项。 +* 函数功能： + +>

重置所有选项。 #### combo\_box\_set\_open\_window 函数 +* 函数原型： + +``` +ret_t combo_box_set_open_window (widget_t* widget, char* open_window); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -138,11 +226,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | combo\_box对象。 | | open\_window | char* | 弹出窗口的名称。 | -

点击按钮时可以打开popup窗口，本函数可设置窗口的名称。 +* 函数功能： + +>

点击按钮时可以打开popup窗口，本函数可设置窗口的名称。 #### combo\_box\_set\_options 函数 +* 函数原型： + +``` +ret_t combo_box_set_options (widget_t* widget, char* options); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -150,11 +248,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | combo\_box对象。 | | options | char* | 选项。 | -

设置选项。 +* 函数功能： + +>

设置选项。 #### combo\_box\_set\_selected\_index 函数 +* 函数原型： + +``` +ret_t combo_box_set_selected_index (widget_t* widget, uint32_t index); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -162,13 +270,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | combo\_box对象。 | | index | uint32\_t | 选项的索引。 | -

设置第index个选项为当前选中的选项。 +* 函数功能： + +>

设置第index个选项为当前选中的选项。 #### open\_window 属性 ----------------------- -

为点击按钮时，要打开窗口的名称。 +>

为点击按钮时，要打开窗口的名称。 * 类型：char* @@ -185,7 +295,7 @@ | 支通过widget_set_prop修改 | 是 | #### options 属性 ----------------------- -

设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。 +>

设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。 * 类型：char* @@ -202,7 +312,7 @@ | 支通过widget_set_prop修改 | 是 | #### selected\_index 属性 ----------------------- -

当前选中的选项。 +>

当前选中的选项。 * 类型：int32\_t @@ -219,7 +329,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

值。 +>

值。 * 类型：int32\_t diff --git a/docs/manual/custom_props_t.md b/docs/manual/custom_props_t.md index 0409c0d85f..43910c1a7c 100644 --- a/docs/manual/custom_props_t.md +++ b/docs/manual/custom_props_t.md @@ -21,28 +21,56 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### custom\_props\_create 函数 +* 函数原型： + +``` +custom_props_t* custom_props_create (uint32_t capacity); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | custom\_props\_t* | custom\_props对象。 | | capacity | uint32\_t | 初始容量。 | -

创建custom_props对象 +* 函数功能： + +>

创建custom_props对象 #### custom\_props\_destroy 函数 +* 函数原型： + +``` +ret_t custom_props_destroy (custom_props_t props); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | props | custom\_props\_t | 属性集合对象。 | -

销毁属性集合。 +* 函数功能： + +>

销毁属性集合。 #### custom\_props\_get 函数 +* 函数原型： + +``` +ret_t custom_props_get (custom_props_t props, char* name, value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -51,11 +79,21 @@ | props | custom\_props\_t | 属性集合对象。 | | name | char* | 属性的名称。 | | v | value\_t* | 用于返回属性的值。 | -

获取属性的值。 +* 函数功能： + +>

获取属性的值。 #### custom\_props\_set 函数 +* 函数原型： + +``` +ret_t custom_props_set (custom_props_t props, char* name, value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -64,7 +102,9 @@ | props | custom\_props\_t | 属性集合对象。 | | name | char* | 属性的名称。 | | v | value\_t* | 属性的值。 | -

设置属性的值。 +* 函数功能： + +>

设置属性的值。 diff --git a/docs/manual/date_time_t.md b/docs/manual/date_time_t.md index 4db0194f9c..e5620ef32d 100644 --- a/docs/manual/date_time_t.md +++ b/docs/manual/date_time_t.md @@ -28,55 +28,95 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### date\_time\_create 函数 +* 函数原型： + +``` +date_time_t* date_time_create (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | date\_time\_t* | 返回date\_time对象。 | -

创建date_time对象，并初始为当前日期和时间(一般供脚本语言中使用)。 +* 函数功能： + +>

创建date_time对象，并初始为当前日期和时间(一般供脚本语言中使用)。 #### date\_time\_date\_time\_set\_impl 函数 +* 函数原型： + +``` +ret_t date_time_date_time_set_impl (date_time_get_now_t date_time_get_now); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | date\_time\_get\_now | date\_time\_get\_now\_t | 获取当前日期和时间的函数。 | -

设置获取当前日期和时间的函数。 +* 函数功能： + +>

设置获取当前日期和时间的函数。 #### date\_time\_destroy 函数 +* 函数原型： + +``` +ret_t date_time_destroy (date_time_t* dt); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | dt | date\_time\_t* | date\_time对象。 | -

销毁date_time对象(一般供脚本语言中使用)。 +* 函数功能： + +>

销毁date_time对象(一般供脚本语言中使用)。 #### date\_time\_init 函数 +* 函数原型： + +``` +date_time_t* date_time_init (date_time_t* dt); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | date\_time\_t* | 返回date\_time对象。 | | dt | date\_time\_t* | date\_time对象。 | -

初始为当前日期和时间。 +* 函数功能： + +>

初始为当前日期和时间。 #### day 属性 ----------------------- -

日(1-31)。 +>

日(1-31)。 @@ -94,7 +134,7 @@ | 支通过widget_set_prop修改 | 否 | #### hour 属性 ----------------------- -

时(0 - 23)。 +>

时(0 - 23)。 @@ -112,7 +152,7 @@ | 支通过widget_set_prop修改 | 否 | #### minute 属性 ----------------------- -

分(0 - 59)。 +>

分(0 - 59)。 @@ -130,7 +170,7 @@ | 支通过widget_set_prop修改 | 否 | #### month 属性 ----------------------- -

月(1-12)。 +>

月(1-12)。 @@ -148,7 +188,7 @@ | 支通过widget_set_prop修改 | 否 | #### second 属性 ----------------------- -

秒(0 - 59)。 +>

秒(0 - 59)。 @@ -166,7 +206,7 @@ | 支通过widget_set_prop修改 | 否 | #### year 属性 ----------------------- -

年。 +>

年。 diff --git a/docs/manual/dialog_client_t.md b/docs/manual/dialog_client_t.md index 40457a4098..8d47c47d38 100644 --- a/docs/manual/dialog_client_t.md +++ b/docs/manual/dialog_client_t.md @@ -1,8 +1,8 @@ ## dialog\_client\_t ### 概述 - 对话框客户区控件。 ![image](images/dialog_client_t_0.png) + 对话框客户区控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### dialog\_client\_cast 函数 +* 函数原型： + +``` +widget_t* dialog_client_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | dialog\_client对象。 | | widget | widget\_t* | dialog\_client对象。 | -

转换为dialog_client对象(供脚本语言使用)。 +* 函数功能： + +>

转换为dialog_client对象(供脚本语言使用)。 #### dialog\_client\_create 函数 +* 函数原型： + +``` +widget_t* dialog_client_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建dialog对象。 +* 函数功能： + +>

创建dialog对象。 diff --git a/docs/manual/dialog_t.md b/docs/manual/dialog_t.md index ba868f9a0f..df5e3317dd 100644 --- a/docs/manual/dialog_t.md +++ b/docs/manual/dialog_t.md @@ -1,8 +1,8 @@ ## dialog\_t ### 概述 - 对话框控件。 ![image](images/dialog_t_0.png) + 对话框控件。 ### 函数

@@ -28,17 +28,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### dialog\_cast 函数 +* 函数原型： + +``` +widget_t* dialog_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | dialog对象。 | | widget | widget\_t* | dialog对象。 | -

转换dialog对象(供脚本语言使用)。 +* 函数功能： + +>

转换dialog对象(供脚本语言使用)。 #### dialog\_create 函数 +* 函数原型： + +``` +widget_t* dialog_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -49,11 +67,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建dialog对象。 +* 函数功能： + +>

创建dialog对象。 #### dialog\_create\_simple 函数 +* 函数原型： + +``` +widget_t* dialog_create_simple (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -64,56 +92,106 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建dialog对象，同时创建title/client。 +* 函数功能： + +>

创建dialog对象，同时创建title/client。 #### dialog\_get\_client 函数 +* 函数原型： + +``` +widget_t* dialog_get_client (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | client对象。 | | widget | widget\_t* | dialog对象。 | -

获取client控件。 +* 函数功能： + +>

获取client控件。 #### dialog\_get\_title 函数 +* 函数原型： + +``` +widget_t* dialog_get_title (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | title对象。 | | widget | widget\_t* | dialog对象。 | -

获取title控件。 +* 函数功能： + +>

获取title控件。 #### dialog\_modal 函数 +* 函数原型： + +``` +ret_t dialog_modal (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | dialog对象。 | -

模态显示对话框。 +* 函数功能： + +>

模态显示对话框。 dialog_modal返回后，dialog对象将在下一个idle函数中回收，也就是在dialog_modal调用完成后仍然可以访问dialog中控件，直到本次事件结束。 #### dialog\_open 函数 +* 函数原型： + +``` +widget_t* dialog_open (char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | 对象。 | | name | char* | dialog的名称。 | -

从资源文件中加载并创建Dialog对象。本函数在ui_loader/ui_builder_default里实现。 +* 函数功能： + +>

从资源文件中加载并创建Dialog对象。本函数在ui_loader/ui_builder_default里实现。 #### dialog\_quit 函数 +* 函数原型： + +``` +ret_t dialog_quit (widget_t* widget, uint32_t code); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -121,11 +199,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | dialog对象。 | | code | uint32\_t | 退出码，作为dialog\_modal的返回值。 | -

退出模态显示。 +* 函数功能： + +>

退出模态显示。 #### dialog\_set\_title 函数 +* 函数原型： + +``` +ret_t dialog_set_title (widget_t* widget, char* title); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -133,7 +221,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | dialog对象。 | | title | char* | 标题。 | -

设置对话框的标题文本。 +* 函数功能： + +>

设置对话框的标题文本。 diff --git a/docs/manual/dialog_title_t.md b/docs/manual/dialog_title_t.md index 4ec30abcfa..64d39e5fbb 100644 --- a/docs/manual/dialog_title_t.md +++ b/docs/manual/dialog_title_t.md @@ -1,8 +1,8 @@ ## dialog\_title\_t ### 概述 - 对话框标题控件。 ![image](images/dialog_title_t_0.png) + 对话框标题控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### dialog\_title\_cast 函数 +* 函数原型： + +``` +widget_t* dialog_title_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | dialog\_title对象。 | | widget | widget\_t* | dialog\_title对象。 | -

转换为dialog_title对象(供脚本语言使用)。 +* 函数功能： + +>

转换为dialog_title对象(供脚本语言使用)。 #### dialog\_title\_create 函数 +* 函数原型： + +``` +widget_t* dialog_title_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建dialog对象。 +* 函数功能： + +>

创建dialog对象。 diff --git a/docs/manual/digit_clock_t.md b/docs/manual/digit_clock_t.md index 8b2cc9d26f..0c1786a427 100644 --- a/docs/manual/digit_clock_t.md +++ b/docs/manual/digit_clock_t.md @@ -1,8 +1,8 @@ ## digit\_clock\_t ### 概述 - 数字时钟控件。 ![image](images/digit_clock_t_0.png) + 数字时钟控件。 ### 函数

@@ -23,17 +23,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### digit\_clock\_cast 函数 +* 函数原型： + +``` +widget_t* digit_clock_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | digit\_clock对象。 | | widget | widget\_t* | digit\_clock对象。 | -

转换为digit_clock对象(供脚本语言使用)。 +* 函数功能： + +>

转换为digit_clock对象(供脚本语言使用)。 #### digit\_clock\_create 函数 +* 函数原型： + +``` +widget_t* digit_clock_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -44,11 +62,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建digit_clock对象 +* 函数功能： + +>

创建digit_clock对象 #### digit\_clock\_set\_format 函数 +* 函数原型： + +``` +ret_t digit_clock_set_format (widget_t* widget, const char* format); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -56,13 +84,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | format | const char* | 格式。 | -

设置显示格式。 +* 函数功能： + +>

设置显示格式。 #### format 属性 ----------------------- -

显示格式。 +>

显示格式。 Y 代表年(完整显示) M 代表月(1-12) D 代表日(1-31) diff --git a/docs/manual/dragger_t.md b/docs/manual/dragger_t.md index 1832973bd8..e2a4c166f4 100644 --- a/docs/manual/dragger_t.md +++ b/docs/manual/dragger_t.md @@ -1,8 +1,8 @@ ## dragger\_t ### 概述 - dragger控件。 ![image](images/dragger_t_0.png) + dragger控件。 ### 函数

@@ -26,17 +26,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### dragger\_cast 函数 +* 函数原型： + +``` +widget_t* dragger_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | dragger对象。 | | widget | widget\_t* | dragger对象。 | -

转换为dragger对象(供脚本语言使用)。 +* 函数功能： + +>

转换为dragger对象(供脚本语言使用)。 #### dragger\_create 函数 +* 函数原型： + +``` +widget_t* dragger_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -47,11 +65,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建dragger对象。 +* 函数功能： + +>

创建dragger对象。 #### dragger\_set\_range 函数 +* 函数原型： + +``` +widget_t* dragger_set_range (widget_t* widget, xy_t x_min, xy_t y_min, xy_t x_max, xy_t y_max); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -62,13 +90,15 @@ | y\_min | xy\_t | y坐标最小值。 | | x\_max | xy\_t | x坐标最大值。 | | y\_max | xy\_t | y坐标最大值。 | -

设置拖动的范围。 +* 函数功能： + +>

设置拖动的范围。 #### x\_max 属性 ----------------------- -

x坐标的最大值。 +>

x坐标的最大值。 * 类型：xy\_t @@ -85,7 +115,7 @@ | 支通过widget_set_prop修改 | 是 | #### x\_min 属性 ----------------------- -

x坐标的最小值。 +>

x坐标的最小值。 * 类型：xy\_t @@ -102,7 +132,7 @@ | 支通过widget_set_prop修改 | 是 | #### y\_max 属性 ----------------------- -

y坐标的最大值。 +>

y坐标的最大值。 * 类型：xy\_t @@ -119,7 +149,7 @@ | 支通过widget_set_prop修改 | 是 | #### y\_min 属性 ----------------------- -

y坐标的最小值。 +>

y坐标的最小值。 * 类型：xy\_t diff --git a/docs/manual/edit_t.md b/docs/manual/edit_t.md index e9688e2679..3b47823246 100644 --- a/docs/manual/edit_t.md +++ b/docs/manual/edit_t.md @@ -1,8 +1,8 @@ ## edit\_t ### 概述 - 文本控件。 ![image](images/edit_t_0.png) + 文本控件。 ### 函数

@@ -47,17 +47,35 @@ | EVT\_VALUE\_CHANGING | event\_t | 文本正在改变事件(编辑中)。 | | EVT\_VALUE\_CHANGED | event\_t | 文本改变事件。 | #### edit\_cast 函数 +* 函数原型： + +``` +widget_t* edit_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | edit对象。 | | widget | widget\_t* | edit对象。 | -

转换为edit对象(供脚本语言使用)。 +* 函数功能： + +>

转换为edit对象(供脚本语言使用)。 #### edit\_create 函数 +* 函数原型： + +``` +widget_t* edit_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -68,33 +86,63 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建edit对象 +* 函数功能： + +>

创建edit对象 #### edit\_get\_double 函数 +* 函数原型： + +``` +double edit_get_double (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | double | 返回double的值。 | | widget | widget\_t* | widget对象。 | -

获取double类型的值。 +* 函数功能： + +>

获取double类型的值。 #### edit\_get\_int 函数 +* 函数原型： + +``` +int32_t edit_get_int (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int32\_t | 返回int的值。 | | widget | widget\_t* | widget对象。 | -

获取int类型的值。 +* 函数功能： + +>

获取int类型的值。 #### edit\_set\_auto\_fix 函数 +* 函数原型： + +``` +ret_t edit_set_auto_fix (widget_t* widget, bool_t auto_fix); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -102,11 +150,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | widget对象。 | | auto\_fix | bool\_t | 自动改正。 | -

设置编辑器是否为自动改正。 +* 函数功能： + +>

设置编辑器是否为自动改正。 #### edit\_set\_double 函数 +* 函数原型： + +``` +ret_t edit_set_double (widget_t* widget, double value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -114,11 +172,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | widget对象。 | | value | double | 值。 | -

设置double类型的值。 +* 函数功能： + +>

设置double类型的值。 #### edit\_set\_float\_limit 函数 +* 函数原型： + +``` +ret_t edit_set_float_limit (widget_t* widget, double min, double max, double step); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -128,11 +196,21 @@ | min | double | 最小值。 | | max | double | 最大值。 | | step | double | 步长。 | -

设置为浮点数输入及取值范围。 +* 函数功能： + +>

设置为浮点数输入及取值范围。 #### edit\_set\_input\_tips 函数 +* 函数原型： + +``` +ret_t edit_set_input_tips (widget_t* widget, char* tips); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -140,11 +218,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | widget对象。 | | tips | char* | 输入提示。 | -

设置编辑器的输入提示。 +* 函数功能： + +>

设置编辑器的输入提示。 #### edit\_set\_input\_type 函数 +* 函数原型： + +``` +ret_t edit_set_input_type (widget_t* widget, input_type_t type); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -152,11 +240,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | widget对象。 | | type | input\_type\_t | 输入类型。 | -

设置编辑器的输入类型。 +* 函数功能： + +>

设置编辑器的输入类型。 #### edit\_set\_int 函数 +* 函数原型： + +``` +ret_t edit_set_int (widget_t* widget, int32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -164,11 +262,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | widget对象。 | | value | int32\_t | 值。 | -

设置int类型的值。 +* 函数功能： + +>

设置int类型的值。 #### edit\_set\_int\_limit 函数 +* 函数原型： + +``` +ret_t edit_set_int_limit (widget_t* widget, int32_t min, int32_t max, int32_t step); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -178,11 +286,21 @@ | min | int32\_t | 最小值。 | | max | int32\_t | 最大值。 | | step | int32\_t | 步长。 | -

设置为整数输入及取值范围。 +* 函数功能： + +>

设置为整数输入及取值范围。 #### edit\_set\_password\_visible 函数 +* 函数原型： + +``` +ret_t edit_set_password_visible (widget_t* widget, bool_t password_visible); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -190,11 +308,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | widget对象。 | | password\_visible | bool\_t | 密码是否可见。 | -

当编辑器输入类型为密码时，设置密码是否可见。 +* 函数功能： + +>

当编辑器输入类型为密码时，设置密码是否可见。 #### edit\_set\_readonly 函数 +* 函数原型： + +``` +ret_t edit_set_readonly (widget_t* widget, bool_t readonly); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -202,11 +330,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | widget对象。 | | readonly | bool\_t | 只读。 | -

设置编辑器是否为只读。 +* 函数功能： + +>

设置编辑器是否为只读。 #### edit\_set\_text\_limit 函数 +* 函数原型： + +``` +ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -215,13 +353,15 @@ | widget | widget\_t* | widget对象。 | | min | uint32\_t | 最小长度。 | | max | uint32\_t | 最大长度。 | -

设置为文本输入及其长度限制，不允许输入超过max个字符，少于min个字符时进入error状态。 +* 函数功能： + +>

设置为文本输入及其长度限制，不允许输入超过max个字符，少于min个字符时进入error状态。 #### auto\_fix 属性 ----------------------- -

输入无效时，是否自动改正。 +>

输入无效时，是否自动改正。 * 类型：bool\_t @@ -238,7 +378,7 @@ | 支通过widget_set_prop修改 | 是 | #### bottom\_margin 属性 ----------------------- -

下边距。 +>

下边距。 * 类型：uint8\_t @@ -255,7 +395,7 @@ | 支通过widget_set_prop修改 | 是 | #### input\_type 属性 ----------------------- -

输入类型。XXX：需要在min/max/step之前设置。 +>

输入类型。XXX：需要在min/max/step之前设置。 * 类型：input\_type\_t @@ -272,7 +412,7 @@ | 支通过widget_set_prop修改 | 是 | #### left\_margin 属性 ----------------------- -

左边距。 +>

左边距。 * 类型：uint8\_t @@ -289,7 +429,7 @@ | 支通过widget_set_prop修改 | 是 | #### max 属性 ----------------------- -

最大值或最大长度。 +>

最大值或最大长度。 * 类型：char* @@ -306,7 +446,7 @@ | 支通过widget_set_prop修改 | 是 | #### min 属性 ----------------------- -

最小值或最小长度。 +>

最小值或最小长度。 * 类型：char* @@ -323,7 +463,7 @@ | 支通过widget_set_prop修改 | 是 | #### password\_visible 属性 ----------------------- -

密码是否可见。 +>

密码是否可见。 * 类型：bool\_t @@ -340,7 +480,7 @@ | 支通过widget_set_prop修改 | 是 | #### readonly 属性 ----------------------- -

编辑器是否为只读。 +>

编辑器是否为只读。 * 类型：bool\_t @@ -357,7 +497,7 @@ | 支通过widget_set_prop修改 | 是 | #### right\_margin 属性 ----------------------- -

右边距。 +>

右边距。 * 类型：uint8\_t @@ -374,7 +514,7 @@ | 支通过widget_set_prop修改 | 是 | #### step 属性 ----------------------- -

步长。 +>

步长。 * 类型：char* @@ -391,7 +531,7 @@ | 支通过widget_set_prop修改 | 是 | #### tips 属性 ----------------------- -

输入提示。 +>

输入提示。 * 类型：char* @@ -408,7 +548,7 @@ | 支通过widget_set_prop修改 | 是 | #### top\_margin 属性 ----------------------- -

上边距。 +>

上边距。 * 类型：uint8\_t diff --git a/docs/manual/emitter_t.md b/docs/manual/emitter_t.md index e8f01ab441..3428d6dfd8 100644 --- a/docs/manual/emitter_t.md +++ b/docs/manual/emitter_t.md @@ -32,53 +32,101 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### emitter\_create 函数 +* 函数原型： + +``` +emitter_t* emitter_create (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | emitter\_t* | 对象。 | -

创建emitter对象。 +* 函数功能： + +>

创建emitter对象。 #### emitter\_deinit 函数 +* 函数原型： + +``` +ret_t emitter_deinit (emitter_t* emitter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | emitter | emitter\_t* | emitter对象。 | -

析构。 +* 函数功能： + +>

析构。 #### emitter\_destroy 函数 +* 函数原型： + +``` +ret_t emitter_destroy (emitter_t* emitter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | emitter | emitter\_t* | emitter对象。 | -

销毁。 +* 函数功能： + +>

销毁。 #### emitter\_disable 函数 +* 函数原型： + +``` +ret_t emitter_disable (emitter_t* emitter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | emitter | emitter\_t* | emitter对象。 | -

禁用。禁用后emitter_dispatch无效，但可以注册和注销。 +* 函数功能： + +>

禁用。禁用后emitter_dispatch无效，但可以注册和注销。 #### emitter\_dispatch 函数 +* 函数原型： + +``` +ret_t emitter_dispatch (emitter_t* emitter, event_t* e); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -86,7 +134,9 @@ | 返回值 | ret\_t | | | emitter | emitter\_t* | emitter对象。 | | e | event\_t* | 事件对象。 | -

分发事件。如果当前分发的回调函数返回RET_REMOVE，该回调函数将被移出。 +* 函数功能： + +>

分发事件。如果当前分发的回调函数返回RET_REMOVE，该回调函数将被移出。 禁用状态下，本函数不做任何事情。 如果当前分发的回调函数返回RET_STOP，dispatch中断分发，并返回RET_STOP，否则返回RET_OK。 @@ -94,18 +144,36 @@ #### emitter\_enable 函数 +* 函数原型： + +``` +ret_t emitter_enable (emitter_t* emitter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | emitter | emitter\_t* | emitter对象。 | -

启用。 +* 函数功能： + +>

启用。 #### emitter\_find 函数 +* 函数原型： + +``` +ret_t emitter_find (emitter_t* emitter, uint32_t id); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -113,24 +181,44 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | emitter | emitter\_t* | emitter对象。 | | id | uint32\_t | emitter\_on返回的ID。 | -

通过ID查找emitter_item_t，主要用于辅助测试。 +* 函数功能： + +>

通过ID查找emitter_item_t，主要用于辅助测试。 #### emitter\_init 函数 +* 函数原型： + +``` +emitter_t* emitter_init (emitter_t* emitter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | emitter\_t* | 对象。 | | emitter | emitter\_t* | emitter对象。 | -

初始化emitter对象。 +* 函数功能： + +>

初始化emitter对象。 #### emitter\_off 函数 +* 函数原型： + +``` +ret_t emitter_off (emitter_t* emitter, uint32_t id); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -138,12 +226,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | emitter | emitter\_t* | emitter对象。 | | id | uint32\_t | emitter\_on返回的ID。 | -

注销指定事件的处理函数。 +* 函数功能： + +>

注销指定事件的处理函数。 #### emitter\_off\_by\_func 函数 +* 函数原型： + +``` +ret_t emitter_off_by_func (emitter_t* emitter, event_type_t type, event_func_t on_event, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -153,12 +251,22 @@ | type | event\_type\_t | 事件类型。 | | on\_event | event\_func\_t | 事件处理函数。 | | ctx | void* | 事件处理函数上下文。 | -

注销指定事件的处理函数。 +* 函数功能： + +>

注销指定事件的处理函数。 #### emitter\_on 函数 +* 函数原型： + +``` +uint32_t emitter_on (emitter_t* emitter, event_type_t type, event_func_t on_event, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -168,12 +276,22 @@ | type | event\_type\_t | 事件类型。 | | on\_event | event\_func\_t | 事件处理函数。 | | ctx | void* | 事件处理函数上下文。 | -

注册指定事件的处理函数。 +* 函数功能： + +>

注册指定事件的处理函数。 #### emitter\_set\_on\_destroy 函数 +* 函数原型： + +``` +ret_t emitter_set_on_destroy (emitter_t* emitter, uint32_t id, tk_destroy_t on_destroy, void* on_destroy_ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -183,26 +301,38 @@ | id | uint32\_t | emitter\_on返回的ID。 | | on\_destroy | tk\_destroy\_t | 回调函数。 | | on\_destroy\_ctx | void* | 回调函数上下文。 | -

设置一个回调函数，在emitter被销毁时调用(方便脚本语言去释放回调函数)。 +* 函数功能： + +>

设置一个回调函数，在emitter被销毁时调用(方便脚本语言去释放回调函数)。 #### emitter\_size 函数 +* 函数原型： + +``` +uint32_t emitter_size (emitter_t* emitter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint32\_t | 回调函数个数。 | | emitter | emitter\_t* | emitter对象。 | -

获取注册的回调函数个数，主要用于辅助测试。 +* 函数功能： + +>

获取注册的回调函数个数，主要用于辅助测试。 #### enable 属性 ----------------------- -

禁用标志。禁用时dispatch无效。 +>

禁用标志。禁用时dispatch无效。 diff --git a/docs/manual/event_t.md b/docs/manual/event_t.md index fa66e54d86..027b4d722c 100644 --- a/docs/manual/event_t.md +++ b/docs/manual/event_t.md @@ -22,20 +22,30 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### event\_cast 函数 +* 函数原型： + +``` +event_t* event_cast (event_t* event); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | event\_t* | 对象。 | | event | event\_t* | event对象。 | -

把event对象转wheel_event_t对象，主要给脚本语言使用。 +* 函数功能： + +>

把event对象转wheel_event_t对象，主要给脚本语言使用。 #### target 属性 ----------------------- -

事件发生的目标对象。 +>

事件发生的目标对象。 @@ -53,7 +63,7 @@ | 支通过widget_set_prop修改 | 否 | #### time 属性 ----------------------- -

事件发生的时间。 +>

事件发生的时间。 @@ -71,7 +81,7 @@ | 支通过widget_set_prop修改 | 否 | #### type 属性 ----------------------- -

类型。 +>

类型。 diff --git a/docs/manual/font_loader_t.md b/docs/manual/font_loader_t.md index f5b828d8e8..22f4d6351e 100644 --- a/docs/manual/font_loader_t.md +++ b/docs/manual/font_loader_t.md @@ -19,6 +19,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### font\_loader\_load 函数 +* 函数原型： + +``` +font_t* font_loader_load (font_loader_t* loader, const char* name, uint8_t* buff, uint32_t size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -28,7 +36,9 @@ | name | const char* | 字体名字。 | | buff | uint8\_t* | 字体数据。 | | size | uint32\_t | 字体数据长度。 | -

加载字体。 +* 函数功能： + +>

加载字体。 diff --git a/docs/manual/font_manager_t.md b/docs/manual/font_manager_t.md index 841982492e..2185bfc23e 100644 --- a/docs/manual/font_manager_t.md +++ b/docs/manual/font_manager_t.md @@ -32,16 +32,34 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### font\_manager 函数 +* 函数原型： + +``` +font_manager_t* font_manager (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | font\_manager\_t* | 返回字体管理器对象。 | -

获取缺省的字体管理器。 +* 函数功能： + +>

获取缺省的字体管理器。 #### font\_manager\_add 函数 +* 函数原型： + +``` +ret_t font_manager_add (font_manager_t* fm, char* name, font_t* font); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -50,48 +68,88 @@ | fm | font\_manager\_t* | 字体管理器对象。 | | name | char* | 字体名。 | | font | font\_t* | 字体。 | -

向缓存中加入字体。 +* 函数功能： + +>

向缓存中加入字体。 #### font\_manager\_create 函数 +* 函数原型： + +``` +font_manager_t* font_manager_create (font_loader_t* loader); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | font\_manager\_t* | 返回字体管理器对象。 | | loader | font\_loader\_t* | 字体加载器。 | -

创建字体管理器。 +* 函数功能： + +>

创建字体管理器。 #### font\_manager\_deinit 函数 +* 函数原型： + +``` +ret_t font_manager_deinit (font_manager_t* fm); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | fm | font\_manager\_t* | 字体管理器对象。 | -

析构字体管理器。 +* 函数功能： + +>

析构字体管理器。 #### font\_manager\_destroy 函数 +* 函数原型： + +``` +ret_t font_manager_destroy (font_manager_t* fm); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | fm | font\_manager\_t* | 字体管理器对象。 | -

析构并释放字体管理器。 +* 函数功能： + +>

析构并释放字体管理器。 #### font\_manager\_find 函数 +* 函数原型： + +``` +font_t* font_manager_find (font_manager_t* fm, char* name, uint16_t size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -100,12 +158,22 @@ | fm | font\_manager\_t* | 字体管理器对象。 | | name | char* | 字体名，为NULL时使用TK\_DEFAULT\_FONT。 | | size | uint16\_t | 字体的大小。 | -

从缓存中查找字体。 +* 函数功能： + +>

从缓存中查找字体。 #### font\_manager\_init 函数 +* 函数原型： + +``` +font_manager_t* font_manager_init (font_manager_t* fm, font_loader_t* loader); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -113,24 +181,44 @@ | 返回值 | font\_manager\_t* | 返回字体管理器对象。 | | fm | font\_manager\_t* | 字体管理器对象。 | | loader | font\_loader\_t* | 字体加载器。 | -

初始化字体管理器。 +* 函数功能： + +>

初始化字体管理器。 #### font\_manager\_set 函数 +* 函数原型： + +``` +ret_t font_manager_set (font_manager_t* fm); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | fm | font\_manager\_t* | 字体管理器对象。 | -

设置缺省的字体管理器。 +* 函数功能： + +>

设置缺省的字体管理器。 #### font\_manager\_set\_assets\_manager 函数 +* 函数原型： + +``` +ret_t font_manager_set_assets_manager (font_manager_t* imm, assets_manager_t* assets_manager); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -138,12 +226,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | imm | font\_manager\_t* | 图片管理器对象。 | | assets\_manager | assets\_manager\_t* | 资源管理器。 | -

设置资源管理器对象 +* 函数功能： + +>

设置资源管理器对象 #### g2d\_blend\_image 函数 +* 函数原型： + +``` +ret_t g2d_blend_image (bitmap_t* fb, bitmap_t* img, rect_t* dst, rect_t* src, uint8_t global_alpha); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -154,13 +252,23 @@ | dst | rect\_t* | 目的区域。 | | src | rect\_t* | 源区域。 | | global\_alpha | uint8\_t | 全局alpha。 | -

把图片指定的区域渲染到framebuffer指定的区域，src的大小和dst的大小不一致则进行缩放。 +* 函数功能： + +>

把图片指定的区域渲染到framebuffer指定的区域，src的大小和dst的大小不一致则进行缩放。 1.硬件不支持缩放，则返回NOT_IMPL。 2.硬件不支持全局alpha，global_alpha!=0xff时返回NOT_IMPL。 #### g2d\_copy\_image 函数 +* 函数原型： + +``` +ret_t g2d_copy_image (bitmap_t* fb, bitmap_t* img, rect_t* src, xy_t dx, xy_t dy); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -171,11 +279,21 @@ | src | rect\_t* | 要拷贝的区域。 | | dx | xy\_t | 目标位置的x坐标。 | | dy | xy\_t | 目标位置的y坐标。 | -

把图片指定的区域拷贝到framebuffer中。 +* 函数功能： + +>

把图片指定的区域拷贝到framebuffer中。 #### g2d\_copy\_image 函数 +* 函数原型： + +``` +ret_t g2d_copy_image (bitmap_t* fb, bitmap_t* img, rect_t* src, lcd_orientation_t o); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -185,11 +303,21 @@ | img | bitmap\_t* | 图片对象。 | | src | rect\_t* | 要旋转并拷贝的区域。 | | o | lcd\_orientation\_t | 旋转角度(一般支持90度即可)。 | -

把图片指定的区域进行旋转并拷贝到framebuffer相应的区域，本函数主要用于辅助实现横屏和竖屏的切换，一般支持90度旋转即可。 +* 函数功能： + +>

把图片指定的区域进行旋转并拷贝到framebuffer相应的区域，本函数主要用于辅助实现横屏和竖屏的切换，一般支持90度旋转即可。 #### g2d\_fill\_rect 函数 +* 函数原型： + +``` +ret_t g2d_fill_rect (bitmap_t* fb, rect_t* dst, color_t c); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -198,7 +326,9 @@ | fb | bitmap\_t* | framebuffer对象。 | | dst | rect\_t* | 要填充的目标区域。 | | c | color\_t | 颜色。 | -

用颜色填充指定的区域。 +* 函数功能： + +>

用颜色填充指定的区域。 diff --git a/docs/manual/func_call_parser_t.md b/docs/manual/func_call_parser_t.md index df14156447..b3977cc45f 100644 --- a/docs/manual/func_call_parser_t.md +++ b/docs/manual/func_call_parser_t.md @@ -30,18 +30,36 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### func\_call\_parser\_deinit 函数 +* 函数原型： + +``` +ret_t func_call_parser_deinit (func_call_parser_t* parser); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | parser | func\_call\_parser\_t* | parser对象。 | -

重置parser。 +* 函数功能： + +>

重置parser。 #### func\_call\_parser\_init 函数 +* 函数原型： + +``` +func_call_parser_t* func_call_parser_init (func_call_parser_t* parser, char* str, uint32_t size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -50,19 +68,31 @@ | parser | func\_call\_parser\_t* | parser对象。 | | str | char* | 要解析的字符串。 | | size | uint32\_t | 字符串长度。 | -

初始化parser对象。 +* 函数功能： + +>

初始化parser对象。 #### func\_call\_parser\_parse 函数 +* 函数原型： + +``` +ret_t func_call_parser_parse (func_call_parser_t* parser); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | parser | func\_call\_parser\_t* | parser对象。 | -

开始解析。 +* 函数功能： + +>

开始解析。 diff --git a/docs/manual/gif_image_t.md b/docs/manual/gif_image_t.md index 8b730d7ddb..dc217d68aa 100644 --- a/docs/manual/gif_image_t.md +++ b/docs/manual/gif_image_t.md @@ -1,8 +1,8 @@ ## gif\_image\_t ### 概述 - GIF图片控件。 ![image](images/gif_image_t_0.png) + GIF图片控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### gif\_image\_cast 函数 +* 函数原型： + +``` +widget_t* gif_image_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | gif\_image对象。 | | widget | widget\_t* | gif\_image对象。 | -

转换为gif_image对象(供脚本语言使用)。 +* 函数功能： + +>

转换为gif_image对象(供脚本语言使用)。 #### gif\_image\_create 函数 +* 函数原型： + +``` +widget_t* gif_image_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建gif_image对象 +* 函数功能： + +>

创建gif_image对象 diff --git a/docs/manual/grid_item_t.md b/docs/manual/grid_item_t.md index 3cf8416ede..f2722fa8f3 100644 --- a/docs/manual/grid_item_t.md +++ b/docs/manual/grid_item_t.md @@ -1,8 +1,8 @@ ## grid\_item\_t ### 概述 - grid_item。一个简单的容器控件，一般作为grid的子控件。 ![image](images/grid_item_t_0.png) + grid_item。一个简单的容器控件，一般作为grid的子控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### grid\_item\_cast 函数 +* 函数原型： + +``` +widget_t* grid_item_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | grid\_item对象。 | | widget | widget\_t* | grid\_item对象。 | -

转换为grid_item对象(供脚本语言使用)。 +* 函数功能： + +>

转换为grid_item对象(供脚本语言使用)。 #### grid\_item\_create 函数 +* 函数原型： + +``` +widget_t* grid_item_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建grid_item对象 +* 函数功能： + +>

创建grid_item对象 diff --git a/docs/manual/grid_t.md b/docs/manual/grid_t.md index 4b63acfffa..6aad37d5b8 100644 --- a/docs/manual/grid_t.md +++ b/docs/manual/grid_t.md @@ -1,9 +1,9 @@ ## grid\_t ### 概述 - grid。一个简单的容器控件，用于网格排列一组控件。 - 它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。 ![image](images/grid_t_0.png) + grid。一个简单的容器控件，用于网格排列一组控件。 + 它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。 ### 函数

@@ -22,17 +22,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### grid\_cast 函数 +* 函数原型： + +``` +widget_t* grid_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | grid对象。 | | widget | widget\_t* | grid对象。 | -

转换为grid对象(供脚本语言使用)。 +* 函数功能： + +>

转换为grid对象(供脚本语言使用)。 #### grid\_create 函数 +* 函数原型： + +``` +widget_t* grid_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -43,7 +61,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建grid对象 +* 函数功能： + +>

创建grid对象 diff --git a/docs/manual/group_box_t.md b/docs/manual/group_box_t.md index bd77251126..bf990553dc 100644 --- a/docs/manual/group_box_t.md +++ b/docs/manual/group_box_t.md @@ -1,8 +1,8 @@ ## group\_box\_t ### 概述 - 分组控件。 ![image](images/group_box_t_0.png) + 分组控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### group\_box\_cast 函数 +* 函数原型： + +``` +widget_t* group_box_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | group\_box对象。 | | widget | widget\_t* | group\_box对象。 | -

转换为group_box对象(供脚本语言使用)。 +* 函数功能： + +>

转换为group_box对象(供脚本语言使用)。 #### group\_box\_create 函数 +* 函数原型： + +``` +widget_t* group_box_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建group_box对象 +* 函数功能： + +>

创建group_box对象 diff --git a/docs/manual/guage_pointer_t.md b/docs/manual/guage_pointer_t.md index 25cf985a30..c3bf522e57 100644 --- a/docs/manual/guage_pointer_t.md +++ b/docs/manual/guage_pointer_t.md @@ -1,8 +1,8 @@ ## guage\_pointer\_t ### 概述 - 仪表指针控件。 ![image](images/guage_pointer_t_0.png) + 仪表指针控件。 ### 函数

@@ -25,17 +25,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### guage\_pointer\_cast 函数 +* 函数原型： + +``` +widget_t* guage_pointer_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | guage\_pointer对象。 | | widget | widget\_t* | guage\_pointer对象。 | -

转换为guage_pointer对象(供脚本语言使用)。 +* 函数功能： + +>

转换为guage_pointer对象(供脚本语言使用)。 #### guage\_pointer\_create 函数 +* 函数原型： + +``` +widget_t* guage_pointer_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -46,11 +64,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建guage_pointer对象 +* 函数功能： + +>

创建guage_pointer对象 #### guage\_pointer\_set\_angle 函数 +* 函数原型： + +``` +ret_t guage_pointer_set_angle (widget_t* widget, int32_t angle); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -58,11 +86,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | angle | int32\_t | 指针角度。 | -

设置指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。 +* 函数功能： + +>

设置指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。 #### guage\_pointer\_set\_image 函数 +* 函数原型： + +``` +ret_t guage_pointer_set_image (widget_t* widget, const char* image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -70,13 +108,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | image | const char* | 指针的图片。 | -

设置指针的图片。 +* 函数功能： + +>

设置指针的图片。 #### angle 属性 ----------------------- -

指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。 +>

指针角度。12点钟方向为0度，顺时钟方向为正，单位为度。 * 类型：int32\_t @@ -93,7 +133,7 @@ | 支通过widget_set_prop修改 | 是 | #### image 属性 ----------------------- -

指针图片。图片须垂直向上，图片的中心点为旋转方向。 +>

指针图片。图片须垂直向上，图片的中心点为旋转方向。 * 类型：char* diff --git a/docs/manual/guage_t.md b/docs/manual/guage_t.md index 998206baee..92c2e94c99 100644 --- a/docs/manual/guage_t.md +++ b/docs/manual/guage_t.md @@ -1,8 +1,8 @@ ## guage\_t ### 概述 - 表盘控件。 ![image](images/guage_t_0.png) + 表盘控件。 ### 函数

@@ -25,17 +25,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### guage\_cast 函数 +* 函数原型： + +``` +widget_t* guage_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | guage对象。 | | widget | widget\_t* | guage对象。 | -

转换为guage对象(供脚本语言使用)。 +* 函数功能： + +>

转换为guage对象(供脚本语言使用)。 #### guage\_create 函数 +* 函数原型： + +``` +widget_t* guage_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -46,11 +64,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建guage对象 +* 函数功能： + +>

创建guage对象 #### guage\_set\_draw\_type 函数 +* 函数原型： + +``` +ret_t guage_set_draw_type (widget_t* widget, image_draw_type_t draw_type); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -58,11 +86,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image对象。 | | draw\_type | image\_draw\_type\_t | 显示方式。 | -

设置图片的显示方式。 +* 函数功能： + +>

设置图片的显示方式。 #### guage\_set\_image 函数 +* 函数原型： + +``` +ret_t guage_set_image (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -70,13 +108,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image对象。 | | name | char* | 图片名称，该图片必须存在于资源管理器。 | -

设置背景图片的名称。 +* 函数功能： + +>

设置背景图片的名称。 #### draw\_type 属性 ----------------------- -

图片的绘制方式。 +>

图片的绘制方式。 * 类型：image\_draw\_type\_t @@ -93,7 +133,7 @@ | 支通过widget_set_prop修改 | 是 | #### image 属性 ----------------------- -

背景图片。 +>

背景图片。 * 类型：char* diff --git a/docs/manual/idle_t.md b/docs/manual/idle_t.md index 2e06fb3d3b..2189713bf6 100644 --- a/docs/manual/idle_t.md +++ b/docs/manual/idle_t.md @@ -23,6 +23,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### idle\_add 函数 +* 函数原型： + +``` +uint32_t idle_add (idle_func_t on_idle, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -30,23 +38,43 @@ | 返回值 | uint32\_t | 返回idle的ID，0表示失败。 | | on\_idle | idle\_func\_t | idle回调函数，回调函数返回RET\_REPEAT，则下次继续执行，否则自动移出。 | | ctx | void* | idle回调函数的上下文。 | -

增加一个idle。 +* 函数功能： + +>

增加一个idle。 #### idle\_count 函数 +* 函数原型： + +``` +uint32_t idle_count (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint32\_t | 返回idle的个数。 | -

返回idle的个数。 +* 函数功能： + +>

返回idle的个数。 #### idle\_queue 函数 +* 函数原型： + +``` +ret_t idle_queue (idle_func_t on_idle, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -54,24 +82,44 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | on\_idle | idle\_func\_t | idle回调函数。 | | ctx | void* | idle回调函数的上下文。 | -

用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。 +* 函数功能： + +>

用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。 #### idle\_remove 函数 +* 函数原型： + +``` +ret_t idle_remove (uint32_t idle_id); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | idle\_id | uint32\_t | idleID。 | -

删除指定的idle。 +* 函数功能： + +>

删除指定的idle。 #### idle\_set\_on\_destroy 函数 +* 函数原型： + +``` +ret_t idle_set_on_destroy (uint32_t idle_id, tk_destroy_t on_destroy, void* on_destroy_ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -80,7 +128,9 @@ | idle\_id | uint32\_t | idleID。 | | on\_destroy | tk\_destroy\_t | 回调函数。 | | on\_destroy\_ctx | void* | 回调函数上下文。 | -

设置一个回调函数，在idle被销毁时调用(方便脚本语言去释放回调函数)。 +* 函数功能： + +>

设置一个回调函数，在idle被销毁时调用(方便脚本语言去释放回调函数)。 diff --git a/docs/manual/im_action_button_info_event_t.md b/docs/manual/im_action_button_info_event_t.md index bac9146c78..34cd506b98 100644 --- a/docs/manual/im_action_button_info_event_t.md +++ b/docs/manual/im_action_button_info_event_t.md @@ -1,9 +1,9 @@ ## im\_action\_button\_info\_event\_t ### 概述 - 设置软键盘上的action按钮的信息事件。 - ![image](images/im_action_button_info_event_t_0.png) + 设置软键盘上的action按钮的信息事件。 + ### 函数

@@ -23,7 +23,7 @@ | -------- | ----- | ------- | #### enable 属性 ----------------------- -

软键盘上的action按钮启用。 +>

软键盘上的action按钮启用。 @@ -41,7 +41,7 @@ | 支通过widget_set_prop修改 | 否 | #### text 属性 ----------------------- -

软键盘上的action按钮显示的文本。 +>

软键盘上的action按钮显示的文本。 diff --git a/docs/manual/im_candidates_event_t.md b/docs/manual/im_candidates_event_t.md index e83e93f585..8a3dc46f4a 100644 --- a/docs/manual/im_candidates_event_t.md +++ b/docs/manual/im_candidates_event_t.md @@ -1,9 +1,9 @@ ## im\_candidates\_event\_t ### 概述 - 输入法请求显示候选字的事件。 - ![image](images/im_candidates_event_t_0.png) + 输入法请求显示候选字的事件。 + ### 函数

@@ -36,17 +36,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### input\_method 函数 +* 函数原型： + +``` +input_method_t* input_method (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | input\_method\_t* | 成功返回输入法对象，失败返回NULL。 | -

获取全局输入法对象。 +* 函数功能： + +>

获取全局输入法对象。 #### input\_method\_commit\_text 函数 +* 函数原型： + +``` +ret_t input_method_commit_text (input_method_t* im, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -54,35 +72,65 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | im | input\_method\_t* | 输入法对象。 | | text | char* | 文本。 | -

提交输入文本。 +* 函数功能： + +>

提交输入文本。 #### input\_method\_create 函数 +* 函数原型： + +``` +input_method_t* input_method_create (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | input\_method\_t* | 成功返回输入法对象，失败返回NULL。 | -

创建输入法对象。在具体实现中实现。 +* 函数功能： + +>

创建输入法对象。在具体实现中实现。 #### input\_method\_destroy 函数 +* 函数原型： + +``` +ret_t input_method_destroy (input_method_t* im); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | im | input\_method\_t* | 输入法对象。 | -

销毁输入法对象。在具体实现中实现。 +* 函数功能： + +>

销毁输入法对象。在具体实现中实现。 #### input\_method\_dispatch 函数 +* 函数原型： + +``` +ret_t input_method_dispatch (input_method_t* im, event_t* e); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -90,24 +138,44 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | im | input\_method\_t* | 控件对象。 | | e | event\_t* | 事件。 | -

分发一个事件。 +* 函数功能： + +>

分发一个事件。 #### input\_method\_dispatch\_action 函数 +* 函数原型： + +``` +ret_t input_method_dispatch_action (input_method_t* im); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | im | input\_method\_t* | 输入法对象。 | -

软键盘上的action按钮被点击时，调用本函数分发EVT_IM_ACTION事件。 +* 函数功能： + +>

软键盘上的action按钮被点击时，调用本函数分发EVT_IM_ACTION事件。 #### input\_method\_dispatch\_candidates 函数 +* 函数原型： + +``` +ret_t input_method_dispatch_candidates (input_method_t* im, char* strs, uint32_t nr); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -116,12 +184,22 @@ | im | input\_method\_t* | 输入法对象。 | | strs | char* | 候选字列表。 | | nr | uint32\_t | 候选字个数。 | -

请求显示候选字。 +* 函数功能： + +>

请求显示候选字。 #### input\_method\_dispatch\_key 函数 +* 函数原型： + +``` +ret_t input_method_dispatch_key (input_method_t* im, uint32_t key); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -129,12 +207,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | im | input\_method\_t* | 输入法对象。 | | key | uint32\_t | 键值。 | -

提交按键。 +* 函数功能： + +>

提交按键。 #### input\_method\_dispatch\_to\_widget 函数 +* 函数原型： + +``` +ret_t input_method_dispatch_to_widget (input_method_t* im, event_t* e); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -142,12 +230,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | im | input\_method\_t* | 控件对象。 | | e | event\_t* | 事件。 | -

分发一个事件当前焦点控件。 +* 函数功能： + +>

分发一个事件当前焦点控件。 #### input\_method\_off 函数 +* 函数原型： + +``` +ret_t input_method_off (input_method_t* im, uint32_t id); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -155,12 +253,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | im | input\_method\_t* | 输入法对象。 | | id | uint32\_t | input\_method\_on返回的ID。 | -

注销指定事件的处理函数。 +* 函数功能： + +>

注销指定事件的处理函数。 #### input\_method\_on 函数 +* 函数原型： + +``` +uint32_t input_method_on (input_method_t* im, event_type_t type, event_func_t on_event, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -170,12 +278,22 @@ | type | event\_type\_t | 事件类型。 | | on\_event | event\_func\_t | 事件处理函数。 | | ctx | void* | 事件处理函数上下文。 | -

注册指定事件的处理函数。 +* 函数功能： + +>

注册指定事件的处理函数。 #### input\_method\_request 函数 +* 函数原型： + +``` +ret_t input_method_request (input_method_t* im, widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -183,24 +301,44 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | im | input\_method\_t* | 输入法对象。 | | widget | widget\_t* | 焦点控件，为NULL时关闭输入法，非NULL时打开输入法。 | -

打开或关闭输入法。 +* 函数功能： + +>

打开或关闭输入法。 #### input\_method\_set 函数 +* 函数原型： + +``` +ret_t input_method_set (input_method_t* im); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | im | input\_method\_t* | 输入法对象。 | -

设置全局输入法对象。 +* 函数功能： + +>

设置全局输入法对象。 #### input\_method\_update\_action\_button\_info 函数 +* 函数原型： + +``` +ret_t input_method_update_action_button_info (input_method_t* im, char* text, bool_t enable); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -209,14 +347,16 @@ | im | input\_method\_t* | 输入法对象。 | | text | char* | 按钮的文本。 | | enable | bool\_t | 按钮的是否可用。 | -

设置软键盘上的action按钮的信息。 +* 函数功能： + +>

设置软键盘上的action按钮的信息。 #### candidates 属性 ----------------------- -

可选的文本，多个文本以\0分隔。如：里\0李\0力\0离\0 +>

可选的文本，多个文本以\0分隔。如：里\0李\0力\0离\0 @@ -234,7 +374,7 @@ | 支通过widget_set_prop修改 | 否 | #### candidates\_nr 属性 ----------------------- -

可选的文本的个数。 +>

可选的文本的个数。 diff --git a/docs/manual/im_commit_event_t.md b/docs/manual/im_commit_event_t.md index c698eabf0e..0d74734c88 100644 --- a/docs/manual/im_commit_event_t.md +++ b/docs/manual/im_commit_event_t.md @@ -1,9 +1,9 @@ ## im\_commit\_event\_t ### 概述 - 输入法提交输入的文本事件。 - ![image](images/im_commit_event_t_0.png) + 输入法提交输入的文本事件。 + ### 函数

@@ -22,7 +22,7 @@ | -------- | ----- | ------- | #### text 属性 ----------------------- -

提交的文本。 +>

提交的文本。 diff --git a/docs/manual/image_animation_t.md b/docs/manual/image_animation_t.md index 70d36390db..ea107165c8 100644 --- a/docs/manual/image_animation_t.md +++ b/docs/manual/image_animation_t.md @@ -1,8 +1,8 @@ ## image\_animation\_t ### 概述 - 图片动画控件，指定一个图片前缀，依次显示指定序列的图片，从而形成动画效果。 ![image](images/image_animation_t_0.png) + 图片动画控件，指定一个图片前缀，依次显示指定序列的图片，从而形成动画效果。 ### 函数

@@ -36,17 +36,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### image\_animation\_cast 函数 +* 函数原型： + +``` +widget_t* image_animation_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | image\_animation对象。 | | widget | widget\_t* | image\_animation对象。 | -

转换为image_animation对象(供脚本语言使用)。 +* 函数功能： + +>

转换为image_animation对象(供脚本语言使用)。 #### image\_animation\_create 函数 +* 函数原型： + +``` +widget_t* image_animation_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -57,33 +75,63 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建image_animation对象 +* 函数功能： + +>

创建image_animation对象 #### image\_animation\_pause 函数 +* 函数原型： + +``` +ret_t image_animation_pause (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_animation对象。 | -

暂停。 +* 函数功能： + +>

暂停。 #### image\_animation\_play 函数 +* 函数原型： + +``` +ret_t image_animation_play (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_animation对象。 | -

播放。 +* 函数功能： + +>

播放。 #### image\_animation\_set\_auto\_play 函数 +* 函数原型： + +``` +ret_t image_animation_set_auto_play (widget_t* widget, bool_t auto_play); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -91,11 +139,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_animation对象。 | | auto\_play | bool\_t | 是否自动播放。 | -

设置是否自动播放。 +* 函数功能： + +>

设置是否自动播放。 #### image\_animation\_set\_delay 函数 +* 函数原型： + +``` +ret_t image_animation_set_delay (widget_t* widget, uint32_t delay); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -103,11 +161,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_animation对象。 | | delay | uint32\_t | 延迟播放时间(毫秒)。 | -

设置延迟播放时间(仅适用于自动播放)。 +* 函数功能： + +>

设置延迟播放时间(仅适用于自动播放)。 #### image\_animation\_set\_image 函数 +* 函数原型： + +``` +ret_t image_animation_set_image (widget_t* widget, const char* image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -115,11 +183,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_animation对象。 | | image | const char* | 图片前缀。 | -

设置图片前缀。 +* 函数功能： + +>

设置图片前缀。 #### image\_animation\_set\_interval 函数 +* 函数原型： + +``` +ret_t image_animation_set_interval (widget_t* widget, uint32_t interval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -127,11 +205,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_animation对象。 | | interval | uint32\_t | 间隔时间(毫秒)。 | -

设置播放间隔时间。 +* 函数功能： + +>

设置播放间隔时间。 #### image\_animation\_set\_loop 函数 +* 函数原型： + +``` +ret_t image_animation_set_loop (widget_t* widget, bool_t loop); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -139,11 +227,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_animation对象。 | | loop | bool\_t | 是否循环播放。 | -

设置是否循环播放。 +* 函数功能： + +>

设置是否循环播放。 #### image\_animation\_set\_sequence 函数 +* 函数原型： + +``` +ret_t image_animation_set_sequence (widget_t* widget, const char* sequence); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -151,24 +249,36 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_animation对象。 | | sequence | const char* | 播放序列。 | -

设置播放序列。比如image为"fire"，sequence为"123", 将依次播放"fire1", "fire2", "fire3"。 +* 函数功能： + +>

设置播放序列。比如image为"fire"，sequence为"123", 将依次播放"fire1", "fire2", "fire3"。 #### image\_animation\_stop 函数 +* 函数原型： + +``` +ret_t image_animation_stop (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_animation对象。 | -

停止(并重置index为0)。 +* 函数功能： + +>

停止(并重置index为0)。 #### auto\_play 属性 ----------------------- -

是否自动播放。 +>

是否自动播放。 * 类型：bool\_t @@ -185,7 +295,7 @@ | 支通过widget_set_prop修改 | 是 | #### delay 属性 ----------------------- -

自动播放时延迟播放的时间(毫秒)。 +>

自动播放时延迟播放的时间(毫秒)。 * 类型：uint32\_t @@ -202,7 +312,7 @@ | 支通过widget_set_prop修改 | 是 | #### image 属性 ----------------------- -

图片名称的前缀。 +>

图片名称的前缀。 * 类型：char* @@ -219,7 +329,7 @@ | 支通过widget_set_prop修改 | 是 | #### interval 属性 ----------------------- -

每张图片播放的时间(毫秒)。 +>

每张图片播放的时间(毫秒)。 * 类型：uint32\_t @@ -236,7 +346,7 @@ | 支通过widget_set_prop修改 | 是 | #### loop 属性 ----------------------- -

是否循环播放。 +>

是否循环播放。 * 类型：bool\_t @@ -253,7 +363,7 @@ | 支通过widget_set_prop修改 | 是 | #### sequence 属性 ----------------------- -

播放的序列，字符可选值为:0-9,a-z,A-Z。 +>

播放的序列，字符可选值为:0-9,a-z,A-Z。 * 类型：char* diff --git a/docs/manual/image_base_t.md b/docs/manual/image_base_t.md index 2a12f8e992..53d15dcbec 100644 --- a/docs/manual/image_base_t.md +++ b/docs/manual/image_base_t.md @@ -1,8 +1,8 @@ ## image\_base\_t ### 概述 - 图片控件基类。 ![image](images/image_base_t_0.png) + 图片控件基类。 ### 函数

@@ -36,17 +36,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### image\_base\_cast 函数 +* 函数原型： + +``` +widget_t* image_base_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | image\_base对象。 | | widget | widget\_t* | image\_base对象。 | -

转换为image_base对象(供脚本语言使用)。 +* 函数功能： + +>

转换为image_base对象(供脚本语言使用)。 #### image\_set\_anchor 函数 +* 函数原型： + +``` +ret_t image_set_anchor (widget_t* widget, float_t anchor_x, float_t anchor_y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -55,11 +73,21 @@ | 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在控件底部。 | -

设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。 +* 函数功能： + +>

设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。 #### image\_set\_clickable 函数 +* 函数原型： + +``` +ret_t image_set_clickable (widget_t* widget, bool_t clickable); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -67,11 +95,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | clickable | bool\_t | 是否可以被点击。 | -

设置控件是否可以被点击。 +* 函数功能： + +>

设置控件是否可以被点击。 #### image\_set\_image 函数 +* 函数原型： + +``` +ret_t image_set_image (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -79,11 +117,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image对象。 | | name | char* | 图片名称，该图片必须存在于资源管理器。 | -

设置控件的图片名称。 +* 函数功能： + +>

设置控件的图片名称。 #### image\_set\_rotation 函数 +* 函数原型： + +``` +ret_t image_set_rotation (widget_t* widget, float_t rotation); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -91,11 +139,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | rotation | float\_t | 旋转角度(幅度)。 | -

设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。 +* 函数功能： + +>

设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。 #### image\_set\_scale 函数 +* 函数原型： + +``` +ret_t image_set_scale (widget_t* widget, float_t scale_x, float_t scale_y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -104,11 +162,21 @@ | widget | widget\_t* | 控件对象。 | | scale\_x | float\_t | X方向缩放比例。 | | scale\_y | float\_t | Y方向缩放比例。 | -

设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。 +* 函数功能： + +>

设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。 #### image\_set\_selectable 函数 +* 函数原型： + +``` +ret_t image_set_selectable (widget_t* widget, bool_t selectable); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -116,11 +184,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | selectable | bool\_t | 是否可以被选中。 | -

设置控件是否可以被选中。 +* 函数功能： + +>

设置控件是否可以被选中。 #### image\_set\_selected 函数 +* 函数原型： + +``` +ret_t image_set_selected (widget_t* widget, bool_t selected); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -128,13 +206,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | selected | bool\_t | 是否被选中。 | -

设置控件的选中状态。 +* 函数功能： + +>

设置控件的选中状态。 #### anchor\_x 属性 ----------------------- -

锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。 +>

锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。 * 类型：float\_t @@ -151,7 +231,7 @@ | 支通过widget_set_prop修改 | 是 | #### anchor\_y 属性 ----------------------- -

锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。 +>

锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。 * 类型：float\_t @@ -168,7 +248,7 @@ | 支通过widget_set_prop修改 | 是 | #### clickable 属性 ----------------------- -

点击时，是否触发EVT_CLICK事件。 +>

点击时，是否触发EVT_CLICK事件。 * 类型：bool\_t @@ -185,7 +265,7 @@ | 支通过widget_set_prop修改 | 是 | #### image 属性 ----------------------- -

图片的名称。 +>

图片的名称。 * 类型：char* @@ -202,7 +282,7 @@ | 支通过widget_set_prop修改 | 是 | #### rotation 属性 ----------------------- -

控件的旋转角度(幅度)。 +>

控件的旋转角度(幅度)。 * 类型：float\_t @@ -219,7 +299,7 @@ | 支通过widget_set_prop修改 | 是 | #### scale\_x 属性 ----------------------- -

控件在X方向上的缩放比例。 +>

控件在X方向上的缩放比例。 * 类型：float\_t @@ -236,7 +316,7 @@ | 支通过widget_set_prop修改 | 是 | #### scale\_y 属性 ----------------------- -

控件在Y方向上的缩放比例。 +>

控件在Y方向上的缩放比例。 * 类型：float\_t @@ -253,7 +333,7 @@ | 支通过widget_set_prop修改 | 是 | #### selectable 属性 ----------------------- -

是否设置选中状态。 +>

是否设置选中状态。 * 类型：bool\_t @@ -270,7 +350,7 @@ | 支通过widget_set_prop修改 | 是 | #### selected 属性 ----------------------- -

当前是否被选中。 +>

当前是否被选中。 * 类型：bool\_t diff --git a/docs/manual/image_loader_t.md b/docs/manual/image_loader_t.md index f70ceb33ed..75d547e7e0 100644 --- a/docs/manual/image_loader_t.md +++ b/docs/manual/image_loader_t.md @@ -19,6 +19,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### image\_loader\_load 函数 +* 函数原型： + +``` +ret_t image_loader_load (image_loader_t* loader, const asset_info_t* asset, bitmap_t* bitmap); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -27,7 +35,9 @@ | loader | image\_loader\_t* | loader对象。 | | asset | const asset\_info\_t* | 资源。 | | bitmap | bitmap\_t* | 用于返回位图对象。 | -

加载图片。 +* 函数功能： + +>

加载图片。 diff --git a/docs/manual/image_manager_t.md b/docs/manual/image_manager_t.md index af07cd0ed3..69f9fb464d 100644 --- a/docs/manual/image_manager_t.md +++ b/docs/manual/image_manager_t.md @@ -30,16 +30,34 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### image\_manager 函数 +* 函数原型： + +``` +image_manager_t* image_manager (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | image\_manager\_t* | 返回图片管理器对象。 | -

获取缺省的图片管理器。 +* 函数功能： + +>

获取缺省的图片管理器。 #### image\_manager\_add 函数 +* 函数原型： + +``` +ret_t image_manager_add (image_manager_t* imm, char* name, bitmap_t* image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -48,48 +66,88 @@ | imm | image\_manager\_t* | 图片管理器对象。 | | name | char* | 图片名。 | | image | bitmap\_t* | 图片信息。 | -

向缓存中加入一张图片 +* 函数功能： + +>

向缓存中加入一张图片 #### image\_manager\_create 函数 +* 函数原型： + +``` +image_manager_t* image_manager_create (image_loader_t* loader); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | image\_manager\_t* | 返回图片管理器对象。 | | loader | image\_loader\_t* | 图片加载器。 | -

创建图片管理器。 +* 函数功能： + +>

创建图片管理器。 #### image\_manager\_deinit 函数 +* 函数原型： + +``` +ret_t image_manager_deinit (image_manager_t* imm); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | imm | image\_manager\_t* | 图片管理器对象。 | -

析构图片管理器。 +* 函数功能： + +>

析构图片管理器。 #### image\_manager\_destroy 函数 +* 函数原型： + +``` +ret_t image_manager_destroy (image_manager_t* imm); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | imm | image\_manager\_t* | 图片管理器对象。 | -

析构并释放图片管理器。 +* 函数功能： + +>

析构并释放图片管理器。 #### image\_manager\_init 函数 +* 函数原型： + +``` +image_manager_t* image_manager_init (image_manager_t* imm, image_loader_t* loader); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -97,12 +155,22 @@ | 返回值 | image\_manager\_t* | 返回图片管理器对象。 | | imm | image\_manager\_t* | 图片管理器对象。 | | loader | image\_loader\_t* | 图片加载器。 | -

初始化图片管理器。 +* 函数功能： + +>

初始化图片管理器。 #### image\_manager\_load 函数 +* 函数原型： + +``` +ret_t image_manager_load (image_manager_t* imm, char* name, bitmap_t* image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -111,12 +179,22 @@ | imm | image\_manager\_t* | 图片管理器对象。 | | name | char* | 图片名称。 | | image | bitmap\_t* | 用于返回图片。 | -

加载指定的图片。 +* 函数功能： + +>

加载指定的图片。 #### image\_manager\_lookup 函数 +* 函数原型： + +``` +ret_t image_manager_lookup (image_manager_t* imm, char* name, bitmap_t* image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -125,24 +203,44 @@ | imm | image\_manager\_t* | 图片管理器对象。 | | name | char* | 图片名。 | | image | bitmap\_t* | 返回图片信息。 | -

从缓存中查找图片 +* 函数功能： + +>

从缓存中查找图片 #### image\_manager\_set 函数 +* 函数原型： + +``` +ret_t image_manager_set (image_manager_t* imm); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | imm | image\_manager\_t* | 图片管理器对象。 | -

设置缺省的图片管理器。 +* 函数功能： + +>

设置缺省的图片管理器。 #### image\_manager\_set\_assets\_manager 函数 +* 函数原型： + +``` +ret_t image_manager_set_assets_manager (image_manager_t* imm, assets_manager_t* assets_manager); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -150,12 +248,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | imm | image\_manager\_t* | 图片管理器对象。 | | assets\_manager | assets\_manager\_t* | 资源管理器。 | -

设置资源管理器对象 +* 函数功能： + +>

设置资源管理器对象 #### image\_manager\_unload\_unused 函数 +* 函数原型： + +``` +ret_t image_manager_unload_unused (image_manager_t* imm, uint32_t time_delta_s); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -163,12 +271,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | imm | image\_manager\_t* | 图片管理器对象。 | | time\_delta\_s | uint32\_t | 时间范围，单位为秒。 | -

从图片管理器中卸载指定时间内没有使用的图片。 +* 函数功能： + +>

从图片管理器中卸载指定时间内没有使用的图片。 #### image\_manager\_update\_specific 函数 +* 函数原型： + +``` +ret_t image_manager_update_specific (image_manager_t* imm, bitmap_t* image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -176,7 +294,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | imm | image\_manager\_t* | 图片管理器对象。 | | image | bitmap\_t* | 返回图片信息。 | -

更新缓存中图片的specific信息。 +* 函数功能： + +>

更新缓存中图片的specific信息。 diff --git a/docs/manual/image_t.md b/docs/manual/image_t.md index 6ae3b90198..45a42e71e6 100644 --- a/docs/manual/image_t.md +++ b/docs/manual/image_t.md @@ -1,8 +1,8 @@ ## image\_t ### 概述 - 图片控件。 ![image](images/image_t_0.png) + 图片控件。 ### 函数

@@ -23,17 +23,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### image\_cast 函数 +* 函数原型： + +``` +widget_t* image_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | image对象。 | | widget | widget\_t* | image对象。 | -

转换为image对象(供脚本语言使用)。 +* 函数功能： + +>

转换为image对象(供脚本语言使用)。 #### image\_create 函数 +* 函数原型： + +``` +widget_t* image_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -44,11 +62,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建image对象 +* 函数功能： + +>

创建image对象 #### image\_set\_draw\_type 函数 +* 函数原型： + +``` +ret_t image_set_draw_type (widget_t* widget, image_draw_type_t draw_type); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -56,13 +84,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image对象。 | | draw\_type | image\_draw\_type\_t | 显示方式(仅在没有旋转和缩放时生效)。 | -

设置图片的显示方式。 +* 函数功能： + +>

设置图片的显示方式。 #### draw\_type 属性 ----------------------- -

图片的绘制方式(仅在没有旋转和缩放时生效)。 +>

图片的绘制方式(仅在没有旋转和缩放时生效)。 * 类型：image\_draw\_type\_t diff --git a/docs/manual/image_value_t.md b/docs/manual/image_value_t.md index fb1c736220..d04add5886 100644 --- a/docs/manual/image_value_t.md +++ b/docs/manual/image_value_t.md @@ -1,12 +1,12 @@ ## image\_value\_t ### 概述 +![image](images/image_value_t_0.png) + image_value控件。可以用图片来表示如电池电量、WIFI信号强度和其它各种数值的值。 其原理如下： * 1.把value以format为格式转换成字符串。 * 2.把每个字符与image(图片文件名前缀)映射成一个图片名。 * 3.最后把这些图片显示出来。 -![image](images/image_value_t_0.png) - ### 函数

@@ -31,17 +31,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### image\_value\_cast 函数 +* 函数原型： + +``` +widget_t* image_value_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | image\_value对象。 | | widget | widget\_t* | image\_value对象。 | -

转换为image_value对象(供脚本语言使用)。 +* 函数功能： + +>

转换为image_value对象(供脚本语言使用)。 #### image\_value\_create 函数 +* 函数原型： + +``` +widget_t* image_value_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -52,11 +70,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建image_value对象 +* 函数功能： + +>

创建image_value对象 #### image\_value\_set\_format 函数 +* 函数原型： + +``` +ret_t image_value_set_format (widget_t* widget, const char* format); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -64,11 +92,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_value对象。 | | format | const char* | 格式。 | -

设置格式。 +* 函数功能： + +>

设置格式。 #### image\_value\_set\_image 函数 +* 函数原型： + +``` +ret_t image_value_set_image (widget_t* widget, const char* image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -76,11 +114,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_value对象。 | | image | const char* | 图片前缀。 | -

设置图片前缀。 +* 函数功能： + +>

设置图片前缀。 #### image\_value\_set\_value 函数 +* 函数原型： + +``` +ret_t image_value_set_value (widget_t* widget, float_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -88,13 +136,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | image\_value对象。 | | value | float\_t | 值。 | -

设置值。 +* 函数功能： + +>

设置值。 #### format 属性 ----------------------- -

数值到字符串转换时的格式，缺省为"%d"。 +>

数值到字符串转换时的格式，缺省为"%d"。 * 类型：char* @@ -111,7 +161,7 @@ | 支通过widget_set_prop修改 | 是 | #### image 属性 ----------------------- -

图片名称的前缀。 +>

图片名称的前缀。 * 类型：char* @@ -128,7 +178,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

值。 +>

值。 * 类型：float\_t diff --git a/docs/manual/input_device_status_t.md b/docs/manual/input_device_status_t.md index 6449a61e60..6f6993b22b 100644 --- a/docs/manual/input_device_status_t.md +++ b/docs/manual/input_device_status_t.md @@ -19,17 +19,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### input\_device\_status\_init 函数 +* 函数原型： + +``` +input_device_status_t* input_device_status_init (input_device_status_t* ids); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | input\_device\_status\_t* | 返回输入设备状态管理器对象。 | | ids | input\_device\_status\_t* | 输入设备状态管理器对象。 | -

初始化输入设备状态管理器。 +* 函数功能： + +>

初始化输入设备状态管理器。 #### input\_device\_status\_on\_input\_event 函数 +* 函数原型： + +``` +ret_t input_device_status_on_input_event (input_device_status_t* ids, widget_t* widget, event_t* e); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -38,7 +56,9 @@ | ids | input\_device\_status\_t* | 输入设备状态管理器对象。 | | widget | widget\_t* | 窗口管理器对象。 | | e | event\_t* | 事件对象。 | -

对输入事件进行处理，然后分发给widget。 +* 函数功能： + +>

对输入事件进行处理，然后分发给widget。 diff --git a/docs/manual/input_engine_t.md b/docs/manual/input_engine_t.md index 81c1f411bd..789facaf53 100644 --- a/docs/manual/input_engine_t.md +++ b/docs/manual/input_engine_t.md @@ -22,30 +22,58 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### input\_engine\_create 函数 +* 函数原型： + +``` +input_engine_t* input_engine_create (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | input\_engine\_t* | 返回输入法引擎对象。 | -

创建输入法引擎对象。 +* 函数功能： + +>

创建输入法引擎对象。 #### input\_engine\_destroy 函数 +* 函数原型： + +``` +ret_t input_engine_destroy (input_engine_t* engine); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | engine | input\_engine\_t* | 输入法引擎对象。 | -

@deconstructor +* 函数功能： + +>

@deconstructor 销毁输入法引擎对象。 #### input\_engine\_input 函数 +* 函数原型： + +``` +ret_t input_engine_input (input_engine_t* engine, int key); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -53,19 +81,31 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | engine | input\_engine\_t* | 输入法引擎对象。 | | key | int | 键值。 | -

输入新的按键，并更新候选字。 +* 函数功能： + +>

输入新的按键，并更新候选字。 #### input\_engine\_reset\_input 函数 +* 函数原型： + +``` +ret_t input_engine_reset_input (input_engine_t* engine); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | engine | input\_engine\_t* | 输入法引擎对象。 | -

清除所有输入的按键组合和候选字。 +* 函数功能： + +>

清除所有输入的按键组合和候选字。 diff --git a/docs/manual/input_method_t.md b/docs/manual/input_method_t.md index a1809a6cb6..5fafe53c54 100644 --- a/docs/manual/input_method_t.md +++ b/docs/manual/input_method_t.md @@ -22,7 +22,7 @@ | -------- | ----- | ------- | #### action\_button\_enable 属性 ----------------------- -

软键盘的上的action按钮是否可用。 +>

软键盘的上的action按钮是否可用。 @@ -40,7 +40,7 @@ | 支通过widget_set_prop修改 | 否 | #### action\_button\_enable 属性 ----------------------- -

软键盘的上的action按钮文本。 +>

软键盘的上的action按钮文本。 @@ -58,7 +58,7 @@ | 支通过widget_set_prop修改 | 否 | #### input\_type 属性 ----------------------- -

当前输入的类型。 +>

当前输入的类型。 diff --git a/docs/manual/key_event_t.md b/docs/manual/key_event_t.md index ada025945d..9ee01f769e 100644 --- a/docs/manual/key_event_t.md +++ b/docs/manual/key_event_t.md @@ -1,9 +1,9 @@ ## key\_event\_t ### 概述 - 按键事件。 - ![image](images/key_event_t_0.png) + 按键事件。 + ### 函数

@@ -26,20 +26,30 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### key\_event\_cast 函数 +* 函数原型： + +``` +key_event_t* key_event_cast (event_t* event); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | key\_event\_t* | 对象。 | | event | event\_t* | event对象。 | -

把event对象转key_event_t对象，主要给脚本语言使用。 +* 函数功能： + +>

把event对象转key_event_t对象，主要给脚本语言使用。 #### alt 属性 ----------------------- -

alt键是否按下。 +>

alt键是否按下。 @@ -57,7 +67,7 @@ | 支通过widget_set_prop修改 | 否 | #### capslock 属性 ----------------------- -

capslock键是否按下。 +>

capslock键是否按下。 @@ -75,7 +85,7 @@ | 支通过widget_set_prop修改 | 否 | #### ctrl 属性 ----------------------- -

ctrl键是否按下。 +>

ctrl键是否按下。 @@ -93,7 +103,7 @@ | 支通过widget_set_prop修改 | 否 | #### key 属性 ----------------------- -

键值。 +>

键值。 @@ -111,7 +121,7 @@ | 支通过widget_set_prop修改 | 否 | #### shift 属性 ----------------------- -

shift键是否按下。 +>

shift键是否按下。 diff --git a/docs/manual/keyboard_t.md b/docs/manual/keyboard_t.md index 85a846e476..fb73c71121 100644 --- a/docs/manual/keyboard_t.md +++ b/docs/manual/keyboard_t.md @@ -1,8 +1,8 @@ ## keyboard\_t ### 概述 - 键盘。 ![image](images/keyboard_t_0.png) + 键盘。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### keyboard\_close 函数 +* 函数原型： + +``` +ret_t keyboard_close (widget_t* parent); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | parent | widget\_t* | keyboard对象。 | -

关闭keyboard窗口。 +* 函数功能： + +>

关闭keyboard窗口。 #### keyboard\_create 函数 +* 函数原型： + +``` +widget_t* keyboard_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建keyboard对象 +* 函数功能： + +>

创建keyboard对象 diff --git a/docs/manual/label_t.md b/docs/manual/label_t.md index f90698822a..601beff9c6 100644 --- a/docs/manual/label_t.md +++ b/docs/manual/label_t.md @@ -1,27 +1,70 @@ ## label\_t ### 概述 - 文本控件。 ![image](images/label_t_0.png) + + 文本控件，用于显示一行或多行文本。 + 文本控件不会根据文本的长度自动换行，只有文本内容包含换行符时才会换行。 + 如需自动换行请使用[rich\_text\_t](rich_text_t.md)控件。 + + label\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于label\_t控件。 + + 在xml中使用"label"标签创建文本控件。如： + + ```xml +

| 函数名称 | 说明 | | -------- | ------------ | | label\_create | 创建label对象 | -| label\_set\_length | 设置最大可显示字符数。 | +| label\_set\_length | 设置最大可显示字符个数。 | ### 属性

| 名属性称 | 类型 | 说明 | | -------- | ----- | ------------ | -| length | int32_t | 显示字符的长度。主要用于动态改变显示字符的个数，来实现类似[拨号中...]的动画效果。 | +| length | int32_t | 显示字符的长度(小余0时全部显示)。 | ### 事件

| 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### label\_create 函数 +* 函数原型： + +``` +widget_t* label_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -32,25 +75,38 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建label对象 +* 函数功能： + +>

创建label对象 #### label\_set\_length 函数 +* 函数原型： + +``` +ret_t label_set_length (widget_t* widget, int32_t length); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | -| repeat | int32\_t | 释放EVT\_CLICK事件的时间间隔(毫秒)。 | -

设置最大可显示字符数。 +| length | int32\_t | 最大可显示字符个数。 | +* 函数功能： + +>

设置最大可显示字符个数。 #### length 属性 ----------------------- -

显示字符的长度。主要用于动态改变显示字符的个数，来实现类似[拨号中...]的动画效果。 +>

显示字符的长度(小余0时全部显示)。 + 主要用于动态改变显示字符的个数，来实现类似[拨号中...]的动画效果。 * 类型：int32\_t diff --git a/docs/manual/lcd_t.md b/docs/manual/lcd_t.md index bfb5031aa0..7615ac65af 100644 --- a/docs/manual/lcd_t.md +++ b/docs/manual/lcd_t.md @@ -54,6 +54,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### lcd\_begin\_frame 函数 +* 函数原型： + +``` +ret_t lcd_begin_frame (lcd_t* lcd, rect_t* dirty_rect, bool_t anim_mode); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -62,11 +70,21 @@ | lcd | lcd\_t* | lcd对象。 | | dirty\_rect | rect\_t* | 需要绘制的区域。 | | anim\_mode | bool\_t | 动画模式，如果可能，直接画到显存而不是离线的framebuffer。 | -

准备绘制。 +* 函数功能： + +>

准备绘制。 #### lcd\_draw\_glyph 函数 +* 函数原型： + +``` +ret_t lcd_draw_glyph (lcd_t* lcd, glyph_t* glyph, rect_t* src, xy_t x, xy_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -77,11 +95,21 @@ | src | rect\_t* | 只绘制指定区域的部分。 | | x | xy\_t | x坐标。 | | y | xy\_t | y坐标。 | -

绘制字符。如果实现了measure_text/draw_text则不需要实现本函数。 +* 函数功能： + +>

绘制字符。如果实现了measure_text/draw_text则不需要实现本函数。 #### lcd\_draw\_hline 函数 +* 函数原型： + +``` +ret_t lcd_draw_hline (lcd_t* lcd, xy_t* x, xy_t* y, xy_t* w); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -91,11 +119,21 @@ | x | xy\_t* | x坐标。 | | y | xy\_t* | y坐标。 | | w | xy\_t* | 直线宽度。 | -

绘制一条水平线。 +* 函数功能： + +>

绘制一条水平线。 #### lcd\_draw\_image 函数 +* 函数原型： + +``` +ret_t lcd_draw_image (lcd_t* lcd, bitmap_t* img, rect_t* src, rect_t* dst); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -105,11 +143,21 @@ | img | bitmap\_t* | 图片。 | | src | rect\_t* | 只绘制指定区域的部分。 | | dst | rect\_t* | 绘制到目标区域。 | -

绘制图片。 +* 函数功能： + +>

绘制图片。 #### lcd\_draw\_image\_matrix 函数 +* 函数原型： + +``` +ret_t lcd_draw_image_matrix (lcd_t* lcd, draw_image_info_t* info); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -117,11 +165,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | info | draw\_image\_info\_t* | 绘制参数。 | -

绘制图片。 +* 函数功能： + +>

绘制图片。 #### lcd\_draw\_points 函数 +* 函数原型： + +``` +ret_t lcd_draw_points (lcd_t* lcd, point_t* points, uint32_t nr); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -130,11 +188,21 @@ | lcd | lcd\_t* | lcd对象。 | | points | point\_t* | 要绘制的点集合。 | | nr | uint32\_t | 点的个数。 | -

绘制一组点。 +* 函数功能： + +>

绘制一组点。 #### lcd\_draw\_text 函数 +* 函数原型： + +``` +ret_t lcd_draw_text (lcd_t* lcd, wchar_t* str, uint32_t nr, xy_t x, xy_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -145,11 +213,21 @@ | nr | uint32\_t | 字符数。 | | x | xy\_t | x坐标。 | | y | xy\_t | y坐标。 | -

绘制字符。 +* 函数功能： + +>

绘制字符。 #### lcd\_draw\_vline 函数 +* 函数原型： + +``` +ret_t lcd_draw_vline (lcd_t* lcd, xy_t* x, xy_t* y, xy_t* h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -159,22 +237,42 @@ | x | xy\_t* | x坐标。 | | y | xy\_t* | y坐标。 | | h | xy\_t* | 直线高度。 | -

绘制一条垂直线。 +* 函数功能： + +>

绘制一条垂直线。 #### lcd\_end\_frame 函数 +* 函数原型： + +``` +ret_t lcd_end_frame (lcd_t* lcd); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | -

完成绘制，同步到显示设备。 +* 函数功能： + +>

完成绘制，同步到显示设备。 #### lcd\_fill\_rect 函数 +* 函数原型： + +``` +ret_t lcd_fill_rect (lcd_t* lcd, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -185,11 +283,21 @@ | y | xy\_t | y坐标。 | | w | wh\_t | 宽度。 | | h | wh\_t | 高度。 | -

绘制实心矩形。 +* 函数功能： + +>

绘制实心矩形。 #### lcd\_get\_clip\_rect 函数 +* 函数原型： + +``` +ret_t lcd_get_clip_rect (lcd_t* lcd, rect_t* rect); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -197,11 +305,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | rect | rect\_t* | 裁剪区域。 | -

获取裁剪区域。 +* 函数功能： + +>

获取裁剪区域。 #### lcd\_get\_point\_color\_t 函数 +* 函数原型： + +``` +ret_t lcd_get_point_color_t (lcd_t* lcd, xy_t x, xy_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -210,33 +328,63 @@ | lcd | lcd\_t* | lcd对象。 | | x | xy\_t | x坐标。 | | y | xy\_t | y坐标。 | -

获取指定点的颜色，对于基于非FrameBuffer的LCD，返回当前的fill_color。 +* 函数功能： + +>

获取指定点的颜色，对于基于非FrameBuffer的LCD，返回当前的fill_color。 #### lcd\_get\_vgcanvas 函数 +* 函数原型： + +``` +vgcanvas_t* lcd_get_vgcanvas (lcd_t* lcd); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | vgcanvas\_t* | 返回矢量图canvas。 | | lcd | lcd\_t* | lcd对象。 | -

获取矢量图canvas。 +* 函数功能： + +>

获取矢量图canvas。 #### lcd\_is\_swappable 函数 +* 函数原型： + +``` +bool_t lcd_is_swappable (lcd_t* lcd); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bool\_t | 返回是否支持swap。 | | lcd | lcd\_t* | lcd对象。 | -

判读lcd是否支持swap。 +* 函数功能： + +>

判读lcd是否支持swap。 #### lcd\_measure\_text 函数 +* 函数原型： + +``` +float_t lcd_measure_text (lcd_t* lcd, wchar_t* str, uint32_t nr); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -245,11 +393,21 @@ | lcd | lcd\_t* | lcd对象。 | | str | wchar\_t* | 字符串。 | | nr | uint32\_t | 字符数。 | -

测量字符串占用的宽度。 +* 函数功能： + +>

测量字符串占用的宽度。 #### lcd\_resize 函数 +* 函数原型： + +``` +ret_t lcd_resize (lcd_t* lcd, wh_t w, wh_t h, uint32_t line_length); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -259,12 +417,22 @@ | w | wh\_t | 新的宽度。 | | h | wh\_t | 新的高度。 | | line\_length | uint32\_t | line\_length。 | -

基于SDL的PC软件，在SDL窗口resize时，需要调用本函数resize lcd。 +* 函数功能： + +>

基于SDL的PC软件，在SDL窗口resize时，需要调用本函数resize lcd。 屏幕旋转时会调用本函数，调整LCD的大小。 #### lcd\_set\_clip\_rect 函数 +* 函数原型： + +``` +ret_t lcd_set_clip_rect (lcd_t* lcd, rect_t* rect); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -272,11 +440,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | rect | rect\_t* | 裁剪区域。 | -

设置裁剪区域。 +* 函数功能： + +>

设置裁剪区域。 #### lcd\_set\_fill\_color 函数 +* 函数原型： + +``` +ret_t lcd_set_fill_color (lcd_t* lcd, color_t color); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -284,11 +462,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | color | color\_t | 颜色。 | -

设置填充颜色。 +* 函数功能： + +>

设置填充颜色。 #### lcd\_set\_font\_name 函数 +* 函数原型： + +``` +ret_t lcd_set_font_name (lcd_t* lcd, const char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -296,11 +484,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | name | const char* | 字体名称。 | -

设置字体名称。 +* 函数功能： + +>

设置字体名称。 #### lcd\_set\_font\_size 函数 +* 函数原型： + +``` +ret_t lcd_set_font_size (lcd_t* lcd, uint32_t font_size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -308,11 +506,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | font\_size | uint32\_t | 字体大小。 | -

设置字体大小。 +* 函数功能： + +>

设置字体大小。 #### lcd\_set\_global\_alpha 函数 +* 函数原型： + +``` +ret_t lcd_set_global_alpha (lcd_t* lcd, uint8_t alpha); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -320,11 +528,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | alpha | uint8\_t | 全局alpha。 | -

设置全局alpha。 +* 函数功能： + +>

设置全局alpha。 #### lcd\_set\_stroke\_color 函数 +* 函数原型： + +``` +ret_t lcd_set_stroke_color (lcd_t* lcd, color_t color); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -332,11 +550,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | color | color\_t | 颜色。 | -

设置线条颜色。 +* 函数功能： + +>

设置线条颜色。 #### lcd\_set\_text\_color 函数 +* 函数原型： + +``` +ret_t lcd_set_text_color (lcd_t* lcd, color_t color); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -344,11 +572,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | color | color\_t | 颜色。 | -

设置文本颜色。 +* 函数功能： + +>

设置文本颜色。 #### lcd\_stroke\_rect 函数 +* 函数原型： + +``` +ret_t lcd_stroke_rect (lcd_t* lcd, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -359,11 +597,21 @@ | y | xy\_t | y坐标。 | | w | wh\_t | 宽度。 | | h | wh\_t | 高度。 | -

绘制矩形。 +* 函数功能： + +>

绘制矩形。 #### lcd\_take\_snapshot 函数 +* 函数原型： + +``` +ret_t lcd_take_snapshot (lcd_t* lcd, bitmap_t* img, bool_t auto_rotate); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -372,13 +620,15 @@ | lcd | lcd\_t* | lcd对象。 | | img | bitmap\_t* | 返回快照图片。 | | auto\_rotate | bool\_t | 是否根据LCD实际方向自动旋转。 | -

拍摄快照，一般用于窗口动画，只有framebuffer模式，才支持。 +* 函数功能： + +>

拍摄快照，一般用于窗口动画，只有framebuffer模式，才支持。 #### draw\_mode 属性 ----------------------- -

绘制模式。 +>

绘制模式。 * 类型：lcd\_draw\_mode\_t @@ -395,7 +645,7 @@ | 支通过widget_set_prop修改 | 否 | #### fill\_color 属性 ----------------------- -

填充颜色 +>

填充颜色 * 类型：color\_t @@ -412,7 +662,7 @@ | 支通过widget_set_prop修改 | 否 | #### font\_name 属性 ----------------------- -

字体名称。 +>

字体名称。 * 类型：char* @@ -429,7 +679,7 @@ | 支通过widget_set_prop修改 | 否 | #### font\_size 属性 ----------------------- -

字体大小。 +>

字体大小。 * 类型：uint32\_t @@ -446,7 +696,7 @@ | 支通过widget_set_prop修改 | 否 | #### global\_alpha 属性 ----------------------- -

全局alpha +>

全局alpha * 类型：uint8\_t @@ -463,7 +713,7 @@ | 支通过widget_set_prop修改 | 否 | #### height 属性 ----------------------- -

屏幕的高度 +>

屏幕的高度 * 类型：wh\_t @@ -480,7 +730,7 @@ | 支通过widget_set_prop修改 | 否 | #### ratio 属性 ----------------------- -

屏幕密度。 +>

屏幕密度。 * 类型：float\_t @@ -497,7 +747,7 @@ | 支通过widget_set_prop修改 | 否 | #### stroke\_color 属性 ----------------------- -

线条颜色 +>

线条颜色 * 类型：color\_t @@ -514,7 +764,7 @@ | 支通过widget_set_prop修改 | 否 | #### support\_dirty\_rect 属性 ----------------------- -

是否支持脏矩形。 +>

是否支持脏矩形。 * 类型：bool\_t @@ -531,7 +781,7 @@ | 支通过widget_set_prop修改 | 否 | #### text\_color 属性 ----------------------- -

文本颜色 +>

文本颜色 * 类型：color\_t @@ -548,7 +798,7 @@ | 支通过widget_set_prop修改 | 否 | #### type 属性 ----------------------- -

LCD的类型。 +>

LCD的类型。 * 类型：lcd\_type\_t @@ -565,7 +815,7 @@ | 支通过widget_set_prop修改 | 否 | #### w 属性 ----------------------- -

屏幕的宽度 +>

屏幕的宽度 * 类型：wh\_t diff --git a/docs/manual/list_item_t.md b/docs/manual/list_item_t.md index 80e775f786..9bdca6151a 100644 --- a/docs/manual/list_item_t.md +++ b/docs/manual/list_item_t.md @@ -1,8 +1,8 @@ ## list\_item\_t ### 概述 - list item控件。 ![image](images/list_item_t_0.png) + list item控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### list\_item\_cast 函数 +* 函数原型： + +``` +widget_t* list_item_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | list\_item对象。 | | widget | widget\_t* | list\_item对象。 | -

转换为list_item对象(供脚本语言使用)。 +* 函数功能： + +>

转换为list_item对象(供脚本语言使用)。 #### list\_item\_create 函数 +* 函数原型： + +``` +widget_t* list_item_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建list_item对象 +* 函数功能： + +>

创建list_item对象 diff --git a/docs/manual/list_view_h_t.md b/docs/manual/list_view_h_t.md index 005c550668..229bb27f09 100644 --- a/docs/manual/list_view_h_t.md +++ b/docs/manual/list_view_h_t.md @@ -1,8 +1,8 @@ ## list\_view\_h\_t ### 概述 - 水平ListView控件。 ![image](images/list_view_h_t_0.png) + 水平ListView控件。 ### 函数

@@ -25,17 +25,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### list\_view\_h\_cast 函数 +* 函数原型： + +``` +widget_t* list_view_h_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | list\_view\_h对象。 | | widget | widget\_t* | list\_view\_h对象。 | -

转换为list_view_h对象(供脚本语言使用)。 +* 函数功能： + +>

转换为list_view_h对象(供脚本语言使用)。 #### list\_view\_h\_create 函数 +* 函数原型： + +``` +widget_t* list_view_h_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -46,11 +64,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建list_view_h对象 +* 函数功能： + +>

创建list_view_h对象 #### list\_view\_h\_set\_item\_width 函数 +* 函数原型： + +``` +ret_t list_view_h_set_item_width (widget_t* widget, int32_t item_width); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -58,11 +86,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | item\_width | int32\_t | 列表项的宽度。 | -

设置列表项的宽度。 +* 函数功能： + +>

设置列表项的宽度。 #### list\_view\_h\_set\_spacing 函数 +* 函数原型： + +``` +ret_t list_view_h_set_spacing (widget_t* widget, int32_t spacing); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -70,13 +108,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | spacing | int32\_t | 列表项的间距。 | -

设置列表项的间距。 +* 函数功能： + +>

设置列表项的间距。 #### item\_width 属性 ----------------------- -

列表项的宽度。 +>

列表项的宽度。 * 类型：int32\_t @@ -93,7 +133,7 @@ | 支通过widget_set_prop修改 | 是 | #### spacing 属性 ----------------------- -

间距。 +>

间距。 * 类型：int32\_t diff --git a/docs/manual/list_view_t.md b/docs/manual/list_view_t.md index ccd9061e0b..3d3ae655b7 100644 --- a/docs/manual/list_view_t.md +++ b/docs/manual/list_view_t.md @@ -1,8 +1,8 @@ ## list\_view\_t ### 概述 - ListView控件。 ![image](images/list_view_t_0.png) + ListView控件。 ### 函数

@@ -27,17 +27,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### list\_view\_cast 函数 +* 函数原型： + +``` +widget_t* list_view_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | list\_view对象。 | | widget | widget\_t* | list\_view对象。 | -

转换为list_view对象(供脚本语言使用)。 +* 函数功能： + +>

转换为list_view对象(供脚本语言使用)。 #### list\_view\_create 函数 +* 函数原型： + +``` +widget_t* list_view_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -48,11 +66,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建list_view对象 +* 函数功能： + +>

创建list_view对象 #### list\_view\_set\_auto\_hide\_scroll\_bar 函数 +* 函数原型： + +``` +ret_t list_view_set_auto_hide_scroll_bar (widget_t* widget, bool_t auto_hide_scroll_bar); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -60,11 +88,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | auto\_hide\_scroll\_bar | bool\_t | 列表项的高度。 | -

设置是否自动隐藏滚动条。 +* 函数功能： + +>

设置是否自动隐藏滚动条。 #### list\_view\_set\_default\_item\_height 函数 +* 函数原型： + +``` +ret_t list_view_set_default_item_height (widget_t* widget, int32_t default_item_height); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -72,11 +110,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | default\_item\_height | int32\_t | 列表项的高度。 | -

设置列表项的缺省高度。 +* 函数功能： + +>

设置列表项的缺省高度。 #### list\_view\_set\_item\_height 函数 +* 函数原型： + +``` +ret_t list_view_set_item_height (widget_t* widget, int32_t item_height); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -84,13 +132,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | item\_height | int32\_t | 列表项的高度。 | -

设置列表项的高度。 +* 函数功能： + +>

设置列表项的高度。 #### auto\_hide\_scroll\_bar 属性 ----------------------- -

如果不需要滚动条时，自动隐藏滚动条。 +>

如果不需要滚动条时，自动隐藏滚动条。 * 类型：bool\_t @@ -107,7 +157,7 @@ | 支通过widget_set_prop修改 | 是 | #### default\_item\_height 属性 ----------------------- -

列表项的缺省高度。如果item_height <= 0 而且列表项自身的高度 <= 0，则使用缺省高度。 +>

列表项的缺省高度。如果item_height <= 0 而且列表项自身的高度 <= 0，则使用缺省高度。 * 类型：int32\_t @@ -124,7 +174,7 @@ | 支通过widget_set_prop修改 | 是 | #### item\_height 属性 ----------------------- -

列表项的高度。如果 item_height > 0，所有列表项使用固定高度，否则使用列表项自身的高度。 +>

列表项的高度。如果 item_height > 0，所有列表项使用固定高度，否则使用列表项自身的高度。 * 类型：int32\_t diff --git a/docs/manual/locale_info_t.md b/docs/manual/locale_info_t.md index c45f49fd1f..685b4a368b 100644 --- a/docs/manual/locale_info_t.md +++ b/docs/manual/locale_info_t.md @@ -30,17 +30,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### locale\_info 函数 +* 函数原型： + +``` +locale_info_t* locale_info (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | locale\_info\_t* | 返回locale\_info对象。 | -

获取缺省locale_info。 +* 函数功能： + +>

获取缺省locale_info。 #### locale\_info\_change 函数 +* 函数原型： + +``` +ret_t locale_info_change (locale_info_t* locale_info, char* language, char* country); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -49,12 +67,22 @@ | locale\_info | locale\_info\_t* | locale\_info对象。 | | language | char* | 语言。 | | country | char* | 国家或地区。 | -

设置当前的国家和语言。 +* 函数功能： + +>

设置当前的国家和语言。 #### locale\_info\_create 函数 +* 函数原型： + +``` +locale_info_t* locale_info_create (char* language, char* country); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -62,36 +90,66 @@ | 返回值 | locale\_info\_t* | 返回locale\_info对象。 | | language | char* | 语言。 | | country | char* | 国家或地区。 | -

创建locale_info。 +* 函数功能： + +>

创建locale_info。 #### locale\_info\_deinit 函数 +* 函数原型： + +``` +ret_t locale_info_deinit (locale_info_t* locale_info); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | locale\_info | locale\_info\_t* | locale\_info对象。 | -

释放全部资源。 +* 函数功能： + +>

释放全部资源。 #### locale\_info\_destroy 函数 +* 函数原型： + +``` +ret_t locale_info_destroy (locale_info_t* locale_info); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | locale\_info | locale\_info\_t* | locale\_info对象。 | -

释放全部资源并销毁locale_info对象。 +* 函数功能： + +>

释放全部资源并销毁locale_info对象。 #### locale\_info\_init 函数 +* 函数原型： + +``` +locale_info_t* locale_info_init (locale_info_t* locale_info, char* language, char* country); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -100,12 +158,22 @@ | locale\_info | locale\_info\_t* | locale\_info对象。 | | language | char* | 语言。 | | country | char* | 国家或地区。 | -

初始化locale_info。 +* 函数功能： + +>

初始化locale_info。 #### locale\_info\_off 函数 +* 函数原型： + +``` +ret_t locale_info_off (locale_info_t* locale_info, uint32_t id); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -113,12 +181,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | locale\_info | locale\_info\_t* | 控件对象。 | | id | uint32\_t | locale\_info\_on返回的ID。 | -

注销指定事件的处理函数。 +* 函数功能： + +>

注销指定事件的处理函数。 #### locale\_info\_on 函数 +* 函数原型： + +``` +uint32_t locale_info_on (locale_info_t* locale_info, event_type_t type, event_func_t on_event, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -128,24 +206,44 @@ | type | event\_type\_t | 事件类型，目前固定为EVT\_LOCALE\_CHANGED。 | | on\_event | event\_func\_t | 事件处理函数。 | | ctx | void* | 事件处理函数上下文。 | -

注册指定事件的处理函数。 +* 函数功能： + +>

注册指定事件的处理函数。 #### locale\_info\_set 函数 +* 函数原型： + +``` +ret_t locale_info_set (locale_info_t* locale_info); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | locale\_info | locale\_info\_t* | locale\_info对象。 | -

设置缺省locale_info。 +* 函数功能： + +>

设置缺省locale_info。 #### locale\_info\_tr 函数 +* 函数原型： + +``` +char* locale_info_tr (locale_info_t* locale_info, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -153,14 +251,16 @@ | 返回值 | char* | 返回翻译之后的字符串。 | | locale\_info | locale\_info\_t* | locale\_info对象。 | | text | char* | 待翻译的文本。 | -

翻译字符串。 +* 函数功能： + +>

翻译字符串。 #### country; 属性 ----------------------- -

国家或地区。如：CN +>

国家或地区。如：CN @@ -178,7 +278,7 @@ | 支通过widget_set_prop修改 | 否 | #### language 属性 ----------------------- -

语言。如：zh +>

语言。如：zh diff --git a/docs/manual/pages_t.md b/docs/manual/pages_t.md index ef4b268b0b..1e8da5c3a3 100644 --- a/docs/manual/pages_t.md +++ b/docs/manual/pages_t.md @@ -1,8 +1,8 @@ ## pages\_t ### 概述 - Pages。只有一个Page处于active状态，处于active状态的Page才能显示并接收事件。 ![image](images/pages_t_0.png) + Pages。只有一个Page处于active状态，处于active状态的Page才能显示并接收事件。 ### 函数

@@ -26,17 +26,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(当前页)即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值(当前页)改变事件。 | #### pages\_cast 函数 +* 函数原型： + +``` +widget_t* pages_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | pages对象。 | | widget | widget\_t* | pages对象。 | -

转换为pages对象(供脚本语言使用)。 +* 函数功能： + +>

转换为pages对象(供脚本语言使用)。 #### pages\_create 函数 +* 函数原型： + +``` +widget_t* pages_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -47,11 +65,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建pages对象 +* 函数功能： + +>

创建pages对象 #### pages\_set\_active 函数 +* 函数原型： + +``` +ret_t pages_set_active (widget_t* widget, uint32_t index); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -59,11 +87,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | index | uint32\_t | 当前Page的序号。 | -

设置当前的Page。 +* 函数功能： + +>

设置当前的Page。 #### pages\_set\_active\_by\_name 函数 +* 函数原型： + +``` +ret_t pages_set_active_by_name (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -71,13 +109,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | name | char* | 当前Page的名字。 | -

通过页面的名字设置当前的Page。 +* 函数功能： + +>

通过页面的名字设置当前的Page。 #### active 属性 ----------------------- -

当前活跃的page。 +>

当前活跃的page。 * 类型：uint32\_t diff --git a/docs/manual/paint_event_t.md b/docs/manual/paint_event_t.md index 2b24b0caf7..71cca20d7f 100644 --- a/docs/manual/paint_event_t.md +++ b/docs/manual/paint_event_t.md @@ -1,9 +1,9 @@ ## paint\_event\_t ### 概述 - 绘制事件。 - ![image](images/paint_event_t_0.png) + 绘制事件。 + ### 函数

@@ -22,20 +22,30 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### paint\_event\_cast 函数 +* 函数原型： + +``` +paint_event_t* paint_event_cast (event_t* event); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | paint\_event\_t* | 对象。 | | event | event\_t* | event对象。 | -

把event对象转paint_event_t对象。主要给脚本语言使用。 +* 函数功能： + +>

把event对象转paint_event_t对象。主要给脚本语言使用。 #### c 属性 ----------------------- -

canvas。 +>

canvas。 diff --git a/docs/manual/point_t.md b/docs/manual/point_t.md index f06690a820..f04050953e 100644 --- a/docs/manual/point_t.md +++ b/docs/manual/point_t.md @@ -21,7 +21,7 @@ | -------- | ----- | ------- | #### x 属性 ----------------------- -

x坐标。 +>

x坐标。 @@ -39,7 +39,7 @@ | 支通过widget_set_prop修改 | 否 | #### y 属性 ----------------------- -

y坐标。 +>

y坐标。 diff --git a/docs/manual/pointer_event_t.md b/docs/manual/pointer_event_t.md index c0743aa4e4..34e30eba87 100644 --- a/docs/manual/pointer_event_t.md +++ b/docs/manual/pointer_event_t.md @@ -1,9 +1,9 @@ ## pointer\_event\_t ### 概述 - 指针事件。 - ![image](images/pointer_event_t_0.png) + 指针事件。 + ### 函数

@@ -28,20 +28,30 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### pointer\_event\_cast 函数 +* 函数原型： + +``` +pointer_event_t* pointer_event_cast (event_t* event); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | pointer\_event\_t* | 对象。 | | event | event\_t* | event对象。 | -

把event对象转pointer_event_t对象，主要给脚本语言使用。 +* 函数功能： + +>

把event对象转pointer_event_t对象，主要给脚本语言使用。 #### alt 属性 ----------------------- -

alt键是否按下。 +>

alt键是否按下。 @@ -59,7 +69,7 @@ | 支通过widget_set_prop修改 | 否 | #### button 属性 ----------------------- -

button。 +>

button。 @@ -77,7 +87,7 @@ | 支通过widget_set_prop修改 | 否 | #### ctrl 属性 ----------------------- -

ctrl键是否按下。 +>

ctrl键是否按下。 @@ -95,7 +105,7 @@ | 支通过widget_set_prop修改 | 否 | #### pressed 属性 ----------------------- -

指针是否按下。 +>

指针是否按下。 @@ -113,7 +123,7 @@ | 支通过widget_set_prop修改 | 否 | #### shift 属性 ----------------------- -

shift键是否按下。 +>

shift键是否按下。 @@ -131,7 +141,7 @@ | 支通过widget_set_prop修改 | 否 | #### x 属性 ----------------------- -

x坐标。 +>

x坐标。 @@ -149,7 +159,7 @@ | 支通过widget_set_prop修改 | 否 | #### y 属性 ----------------------- -

y坐标。 +>

y坐标。 diff --git a/docs/manual/popup_t.md b/docs/manual/popup_t.md index bd5475b65e..2f5b4ec985 100644 --- a/docs/manual/popup_t.md +++ b/docs/manual/popup_t.md @@ -1,8 +1,8 @@ ## popup\_t ### 概述 - popup窗口。 ![image](images/popup_t_0.png) + popup窗口。 ### 函数

@@ -29,17 +29,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值改变事件。 | #### progress\_bar\_cast 函数 +* 函数原型： + +``` +widget_t* progress_bar_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | progress\_bar对象。 | | widget | widget\_t* | progress\_bar对象。 | -

转换为progress_bar对象(供脚本语言使用)。 +* 函数功能： + +>

转换为progress_bar对象(供脚本语言使用)。 #### progress\_bar\_create 函数 +* 函数原型： + +``` +widget_t* progress_bar_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -50,11 +68,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建progress_bar对象 +* 函数功能： + +>

创建progress_bar对象 #### progress\_bar\_set\_show\_text 函数 +* 函数原型： + +``` +ret_t progress_bar_set_show_text (widget_t* widget, bool_t show_text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -62,11 +90,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | show\_text | bool\_t | 是否显示文本。 | -

设置进度条的是否显示文本。 +* 函数功能： + +>

设置进度条的是否显示文本。 #### progress\_bar\_set\_value 函数 +* 函数原型： + +``` +ret_t progress_bar_set_value (widget_t* widget, uint8_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -74,11 +112,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | value | uint8\_t | 进度 | -

设置进度条的进度。 +* 函数功能： + +>

设置进度条的进度。 #### progress\_bar\_set\_vertical 函数 +* 函数原型： + +``` +ret_t progress_bar_set_vertical (widget_t* widget, bool_t vertical); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -86,13 +134,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | vertical | bool\_t | 是否为垂直方向。 | -

设置进度条的方向。 +* 函数功能： + +>

设置进度条的方向。 #### show\_text 属性 ----------------------- -

是否显示文本。 +>

是否显示文本。 * 类型：bool\_t @@ -109,7 +159,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

进度条的值[0-100]。 +>

进度条的值[0-100]。 * 类型：uint8\_t @@ -126,7 +176,7 @@ | 支通过widget_set_prop修改 | 是 | #### vertical 属性 ----------------------- -

进度条的是否为垂直方向。 +>

进度条的是否为垂直方向。 * 类型：bool\_t diff --git a/docs/manual/progress_circle_t.md b/docs/manual/progress_circle_t.md index 16a61ebcd2..3cc9475870 100644 --- a/docs/manual/progress_circle_t.md +++ b/docs/manual/progress_circle_t.md @@ -1,8 +1,8 @@ ## progress\_circle\_t ### 概述 - 进度圆环控件。 ![image](images/progress_circle_t_0.png) + 进度圆环控件。 ### 函数

@@ -37,17 +37,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值改变事件。 | #### progress\_circle\_cast 函数 +* 函数原型： + +``` +widget_t* progress_circle_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | progress\_circle对象。 | | widget | widget\_t* | progress\_circle对象。 | -

转换为progress_circle对象(供脚本语言使用)。 +* 函数功能： + +>

转换为progress_circle对象(供脚本语言使用)。 #### progress\_circle\_create 函数 +* 函数原型： + +``` +widget_t* progress_circle_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -58,11 +76,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建progress_circle对象 +* 函数功能： + +>

创建progress_circle对象 #### progress\_circle\_set\_counter\_clock\_wise 函数 +* 函数原型： + +``` +ret_t progress_circle_set_counter_clock_wise (widget_t* widget, bool_t counter_clock_wise); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -70,11 +98,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | counter\_clock\_wise | bool\_t | 是否为逆时针方向。 | -

设置是否为逆时针方向。 +* 函数功能： + +>

设置是否为逆时针方向。 #### progress\_circle\_set\_line\_width 函数 +* 函数原型： + +``` +ret_t progress_circle_set_line_width (widget_t* widget, uint32_t line_width); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -82,11 +120,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | line\_width | uint32\_t | 环线的厚度。 | -

设置环线的厚度。 +* 函数功能： + +>

设置环线的厚度。 #### progress\_circle\_set\_max 函数 +* 函数原型： + +``` +ret_t progress_circle_set_max (widget_t* widget, uint32_t max); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -94,11 +142,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | max | uint32\_t | 最大值。 | -

设置最大值。 +* 函数功能： + +>

设置最大值。 #### progress\_circle\_set\_show\_text 函数 +* 函数原型： + +``` +ret_t progress_circle_set_show_text (widget_t* widget, bool_t show_text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -106,11 +164,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | show\_text | bool\_t | 是否显示文本。 | -

设置是否显示文本。 +* 函数功能： + +>

设置是否显示文本。 #### progress\_circle\_set\_start\_angle 函数 +* 函数原型： + +``` +ret_t progress_circle_set_start_angle (widget_t* widget, int32_t start_angle); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -118,11 +186,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | start\_angle | int32\_t | 起始角度。 | -

设置起始角度。 +* 函数功能： + +>

设置起始角度。 #### progress\_circle\_set\_unit 函数 +* 函数原型： + +``` +ret_t progress_circle_set_unit (widget_t* widget, const char* unit); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -130,11 +208,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | unit | const char* | 单位。 | -

设置单位。 +* 函数功能： + +>

设置单位。 #### progress\_circle\_set\_value 函数 +* 函数原型： + +``` +ret_t progress_circle_set_value (widget_t* widget, float_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -142,13 +230,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | value | float\_t | 值。 | -

设置值。 +* 函数功能： + +>

设置值。 #### counter\_clock\_wise 属性 ----------------------- -

是否为逆时针方向(缺省为FALSE)。 +>

是否为逆时针方向(缺省为FALSE)。 * 类型：bool\_t @@ -165,7 +255,7 @@ | 支通过widget_set_prop修改 | 是 | #### line\_width 属性 ----------------------- -

环线的厚度(缺省为8)。 +>

环线的厚度(缺省为8)。 * 类型：uint32\_t @@ -182,7 +272,7 @@ | 支通过widget_set_prop修改 | 是 | #### max 属性 ----------------------- -

最大值(缺省为100)。 +>

最大值(缺省为100)。 * 类型：uint32\_t @@ -199,7 +289,7 @@ | 支通过widget_set_prop修改 | 是 | #### show\_text 属性 ----------------------- -

是否显示文本(缺省为TRUE)。 +>

是否显示文本(缺省为TRUE)。 * 类型：bool\_t @@ -216,7 +306,7 @@ | 支通过widget_set_prop修改 | 是 | #### start\_angle 属性 ----------------------- -

起始角度(单位为度，缺省-90)。 +>

起始角度(单位为度，缺省-90)。 * 类型：int32\_t @@ -233,7 +323,7 @@ | 支通过widget_set_prop修改 | 是 | #### unit 属性 ----------------------- -

单元(缺省无)。 +>

单元(缺省无)。 * 类型：char* @@ -250,7 +340,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

值(缺省为0)。 +>

值(缺省为0)。 * 类型：float\_t diff --git a/docs/manual/prop_change_event_t.md b/docs/manual/prop_change_event_t.md index a1cb205b78..3cb9e6e734 100644 --- a/docs/manual/prop_change_event_t.md +++ b/docs/manual/prop_change_event_t.md @@ -1,9 +1,9 @@ ## prop\_change\_event\_t ### 概述 - 对象属性变化事件。 - ![image](images/prop_change_event_t_0.png) + 对象属性变化事件。 + ### 函数

@@ -23,20 +23,30 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### prop\_change\_event\_cast 函数 +* 函数原型： + +``` +prop_change_event_t* prop_change_event_cast (event_t* event); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | prop\_change\_event\_t* | 对象。 | | event | event\_t* | event对象。 | -

把event对象转prop_change_event_t对象，主要给脚本语言使用。 +* 函数功能： + +>

把event对象转prop_change_event_t对象，主要给脚本语言使用。 #### name 属性 ----------------------- -

属性的名称。 +>

属性的名称。 @@ -54,7 +64,7 @@ | 支通过widget_set_prop修改 | 否 | #### value 属性 ----------------------- -

属性的值。 +>

属性的值。 diff --git a/docs/manual/rbuffer_t.md b/docs/manual/rbuffer_t.md index 918a0d0f11..0ea9dcb728 100644 --- a/docs/manual/rbuffer_t.md +++ b/docs/manual/rbuffer_t.md @@ -33,18 +33,36 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### rbuffer\_has\_more 函数 +* 函数原型： + +``` +bool_t rbuffer_has_more (rbuffer_t* rbuffer); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bool\_t | 返回TRUE表示还有数据可读，否则表示无数据可读。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | -

判断是否还有数据可读。 +* 函数功能： + +>

判断是否还有数据可读。 #### rbuffer\_init 函数 +* 函数原型： + +``` +rbuffer_t* rbuffer_init (rbuffer_t* rbuffer, uint8_t* data, uint16_t capacity); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -53,12 +71,22 @@ | rbuffer | rbuffer\_t* | rbuffer对象。 | | data | uint8\_t* | 缓冲区。 | | capacity | uint16\_t | 缓冲区的容量。 | -

初始rbuffer对象。 +* 函数功能： + +>

初始rbuffer对象。 #### rbuffer\_peek\_uint16 函数 +* 函数原型： + +``` +ret_t rbuffer_peek_uint16 (rbuffer_t* rbuffer, uint16_t* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -66,12 +94,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | | value | uint16\_t* | 读取的数据。 | -

读取uint16数据，但不改变cursor的位置。 +* 函数功能： + +>

读取uint16数据，但不改变cursor的位置。 #### rbuffer\_peek\_uint32 函数 +* 函数原型： + +``` +ret_t rbuffer_peek_uint32 (rbuffer_t* rbuffer, uint32_t* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -79,12 +117,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | | value | uint32\_t* | 读取的数据。 | -

读取uint32数据，但不改变cursor的位置。 +* 函数功能： + +>

读取uint32数据，但不改变cursor的位置。 #### rbuffer\_peek\_uint8 函数 +* 函数原型： + +``` +ret_t rbuffer_peek_uint8 (rbuffer_t* rbuffer, uint8_t* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -92,12 +140,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | | value | uint8\_t* | 读取的数据。 | -

读取uint8数据，但不改变cursor的位置。 +* 函数功能： + +>

读取uint8数据，但不改变cursor的位置。 #### rbuffer\_read\_binary 函数 +* 函数原型： + +``` +ret_t rbuffer_read_binary (rbuffer_t* rbuffer, void* data, uint32_t size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -106,12 +164,22 @@ | rbuffer | rbuffer\_t* | rbuffer对象。 | | data | void* | 读取的数据。 | | size | uint32\_t | 读取的数据长度。 | -

读取指定长度的二进制数据。 +* 函数功能： + +>

读取指定长度的二进制数据。 #### rbuffer\_read\_float 函数 +* 函数原型： + +``` +ret_t rbuffer_read_float (rbuffer_t* rbuffer, float_t* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -119,12 +187,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | | value | float\_t* | 读取的数据。 | -

读取float数据。 +* 函数功能： + +>

读取float数据。 #### rbuffer\_read\_string 函数 +* 函数原型： + +``` +ret_t rbuffer_read_string (rbuffer_t* rbuffer, char** str); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -132,12 +210,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | | str | char** | 用于返回字符串。 | -

读取字符串。 +* 函数功能： + +>

读取字符串。 #### rbuffer\_read\_uint16 函数 +* 函数原型： + +``` +ret_t rbuffer_read_uint16 (rbuffer_t* rbuffer, uint16_t* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -145,12 +233,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | | value | uint16\_t* | 读取的数据。 | -

读取uint16数据。 +* 函数功能： + +>

读取uint16数据。 #### rbuffer\_read\_uint32 函数 +* 函数原型： + +``` +ret_t rbuffer_read_uint32 (rbuffer_t* rbuffer, uint32_t* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -158,12 +256,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | | value | uint32\_t* | 读取的数据。 | -

读取uint32数据。 +* 函数功能： + +>

读取uint32数据。 #### rbuffer\_read\_uint8 函数 +* 函数原型： + +``` +ret_t rbuffer_read_uint8 (rbuffer_t* rbuffer, uint8_t* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -171,12 +279,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | | value | uint8\_t* | 读取的数据。 | -

读取uint8数据。 +* 函数功能： + +>

读取uint8数据。 #### rbuffer\_skip 函数 +* 函数原型： + +``` +ret_t rbuffer_skip (rbuffer_t* rbuffer, int32_t offset); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -184,14 +302,16 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | rbuffer | rbuffer\_t* | rbuffer对象。 | | offset | int32\_t | 跳过的偏移量，正数往前负数往回跳。 | -

跳过指定的长度。 +* 函数功能： + +>

跳过指定的长度。 #### capacity 属性 ----------------------- -

缓存区最大容量。 +>

缓存区最大容量。 @@ -209,7 +329,7 @@ | 支通过widget_set_prop修改 | 否 | #### cursor 属性 ----------------------- -

当前读取位置。 +>

当前读取位置。 @@ -227,7 +347,7 @@ | 支通过widget_set_prop修改 | 否 | #### data 属性 ----------------------- -

缓存区。 +>

缓存区。 diff --git a/docs/manual/rect_t.md b/docs/manual/rect_t.md index 93afe63d66..f47da0fbd3 100644 --- a/docs/manual/rect_t.md +++ b/docs/manual/rect_t.md @@ -23,7 +23,7 @@ | -------- | ----- | ------- | #### h 属性 ----------------------- -

高度。 +>

高度。 @@ -41,7 +41,7 @@ | 支通过widget_set_prop修改 | 否 | #### w 属性 ----------------------- -

宽度。 +>

宽度。 @@ -59,7 +59,7 @@ | 支通过widget_set_prop修改 | 否 | #### x 属性 ----------------------- -

x坐标。 +>

x坐标。 @@ -77,7 +77,7 @@ | 支通过widget_set_prop修改 | 否 | #### y 属性 ----------------------- -

y坐标。 +>

y坐标。 diff --git a/docs/manual/rich_text_t.md b/docs/manual/rich_text_t.md index e56da98de4..1c567d2c0b 100644 --- a/docs/manual/rich_text_t.md +++ b/docs/manual/rich_text_t.md @@ -1,9 +1,9 @@ ## rich\_text\_t ### 概述 - rich_text控件，实现简单的图文混排。 - ![image](images/rich_text_t_0.png) + rich_text控件，实现简单的图文混排。 + ### 函数

@@ -23,6 +23,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### rich\_text\_create 函数 +* 函数原型： + +``` +widget_t* rich_text_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -33,12 +41,22 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建rich_text对象 +* 函数功能： + +>

创建rich_text对象 #### rich\_text\_set\_text 函数 +* 函数原型： + +``` +ret_t rich_text_set_text (widget_t* widget, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -46,14 +64,16 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | text | char* | 文本。 | -

设置文本。 +* 函数功能： + +>

设置文本。 #### line\_gap 属性 ----------------------- -

行间距。 +>

行间距。 diff --git a/docs/manual/row_t.md b/docs/manual/row_t.md index 43d3d97a24..a67bd06edd 100644 --- a/docs/manual/row_t.md +++ b/docs/manual/row_t.md @@ -1,9 +1,9 @@ ## row\_t ### 概述 - row。一个简单的容器控件，用于水平排列一组控件。 - 它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。 ![image](images/row_t_0.png) + row。一个简单的容器控件，用于水平排列一组控件。 + 它本身不提供布局功能(可用layout参数指定)，和view功能一致，仅提供具有语义的标签，让xml更具有可读性。 ### 函数

@@ -22,17 +22,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### row\_cast 函数 +* 函数原型： + +``` +widget_t* row_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | row对象。 | | widget | widget\_t* | row对象。 | -

转换为row对象(供脚本语言使用)。 +* 函数功能： + +>

转换为row对象(供脚本语言使用)。 #### row\_create 函数 +* 函数原型： + +``` +widget_t* row_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -43,7 +61,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建row对象 +* 函数功能： + +>

创建row对象 diff --git a/docs/manual/scroll_bar_t.md b/docs/manual/scroll_bar_t.md index b191a370de..b9d056ece3 100644 --- a/docs/manual/scroll_bar_t.md +++ b/docs/manual/scroll_bar_t.md @@ -1,8 +1,8 @@ ## scroll\_bar\_t ### 概述 - scroll_bar控件。 ![image](images/scroll_bar_t_0.png) + scroll_bar控件。 ### 函数

@@ -34,6 +34,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### scroll\_bar\_add\_delta 函数 +* 函数原型： + +``` +ret_t scroll_bar_add_delta (widget_t* widget, int32_t delta); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -41,22 +49,42 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | scroll\_bar控件。 | | delta | int32\_t | 值。 | -

在当前的值上增加一个值，并触发EVT_VALUE_CHANGED事件。 +* 函数功能： + +>

在当前的值上增加一个值，并触发EVT_VALUE_CHANGED事件。 #### scroll\_bar\_cast 函数 +* 函数原型： + +``` +widget_t* scroll_bar_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | scroll\_bar对象。 | | widget | widget\_t* | scroll\_bar对象。 | -

转换为scroll_bar对象(供脚本语言使用)。 +* 函数功能： + +>

转换为scroll_bar对象(供脚本语言使用)。 #### scroll\_bar\_create 函数 +* 函数原型： + +``` +widget_t* scroll_bar_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -67,11 +95,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建scroll_bar对象(根据宏WITH_DESKTOP_STYLE决定创建desktop风格还是mobile风格的滚动条) +* 函数功能： + +>

创建scroll_bar对象(根据宏WITH_DESKTOP_STYLE决定创建desktop风格还是mobile风格的滚动条) #### scroll\_bar\_create\_desktop 函数 +* 函数原型： + +``` +widget_t* scroll_bar_create_desktop (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -82,11 +120,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建desktop风格的scroll_bar对象 +* 函数功能： + +>

创建desktop风格的scroll_bar对象 #### scroll\_bar\_create\_mobile 函数 +* 函数原型： + +``` +widget_t* scroll_bar_create_mobile (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -97,22 +145,42 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建mobile风格的scroll_bar对象 +* 函数功能： + +>

创建mobile风格的scroll_bar对象 #### scroll\_bar\_is\_mobile 函数 +* 函数原型： + +``` +bool_t scroll_bar_is_mobile (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bool\_t | 返回TRUE表示是mobile风格的，否则表示不是mobile风格的。 | | widget | widget\_t* | scroll\_bar控件。 | -

判断是否是mobile风格的滚动条。 +* 函数功能： + +>

判断是否是mobile风格的滚动条。 #### scroll\_bar\_scroll\_delta 函数 +* 函数原型： + +``` +ret_t scroll_bar_scroll_delta (widget_t* widget, int32_t delta); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -120,11 +188,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | scroll\_bar控件。 | | delta | int32\_t | 值。 | -

在当前的值上增加一个值，并滚动到新的值，并触发EVT_VALUE_CHANGED事件。 +* 函数功能： + +>

在当前的值上增加一个值，并滚动到新的值，并触发EVT_VALUE_CHANGED事件。 #### scroll\_bar\_scroll\_to 函数 +* 函数原型： + +``` +ret_t scroll_bar_scroll_to (widget_t* widget, int32_t value, int32_t duration); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -133,11 +211,21 @@ | widget | widget\_t* | scroll\_bar控件。 | | value | int32\_t | 值。 | | duration | int32\_t | 时间。 | -

滚动到指定的值。 +* 函数功能： + +>

滚动到指定的值。 #### scroll\_bar\_set\_params 函数 +* 函数原型： + +``` +ret_t scroll_bar_set_params (widget_t* widget, int32_t virtual_size, int32_t row); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -146,11 +234,21 @@ | widget | widget\_t* | scroll\_bar控件。 | | virtual\_size | int32\_t | 最大值。 | | row | int32\_t | 每一行的高度。 | -

设置参数。 +* 函数功能： + +>

设置参数。 #### scroll\_bar\_set\_value 函数 +* 函数原型： + +``` +ret_t scroll_bar_set_value (widget_t* widget, int32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -158,11 +256,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | scroll\_bar控件。 | | value | int32\_t | 值。 | -

设置值，并触发EVT_VALUE_CHANGED事件。 +* 函数功能： + +>

设置值，并触发EVT_VALUE_CHANGED事件。 #### scroll\_bar\_set\_value\_only 函数 +* 函数原型： + +``` +ret_t scroll_bar_set_value_only (widget_t* widget, int32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -170,13 +278,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | scroll\_bar控件。 | | value | int32\_t | 值。 | -

设置值，但不触发EVT_VALUE_CHANGED事件。 +* 函数功能： + +>

设置值，但不触发EVT_VALUE_CHANGED事件。 #### animatable 属性 ----------------------- -

滚动时是否启用动画。 +>

滚动时是否启用动画。 * 类型：bool\_t @@ -193,7 +303,7 @@ | 支通过widget_set_prop修改 | 是 | #### row 属性 ----------------------- -

行的高度。 +>

行的高度。 * 类型：int32\_t @@ -210,7 +320,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

当前的值。 +>

当前的值。 * 类型：int32\_t @@ -227,7 +337,7 @@ | 支通过widget_set_prop修改 | 是 | #### virtual\_size 属性 ----------------------- -

虚拟宽度或高度。 +>

虚拟宽度或高度。 * 类型：int32\_t diff --git a/docs/manual/scroll_view_t.md b/docs/manual/scroll_view_t.md index 9146d6f6f0..280f87a17d 100644 --- a/docs/manual/scroll_view_t.md +++ b/docs/manual/scroll_view_t.md @@ -1,8 +1,8 @@ ## scroll\_view\_t ### 概述 - 滚动视图。 ![image](images/scroll_view_t_0.png) + 滚动视图。 ### 函数

@@ -33,17 +33,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### scroll\_view\_cast 函数 +* 函数原型： + +``` +widget_t* scroll_view_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | scroll\_view对象。 | | widget | widget\_t* | scroll\_view对象。 | -

转换为scroll_view对象(供脚本语言使用)。 +* 函数功能： + +>

转换为scroll_view对象(供脚本语言使用)。 #### scroll\_view\_create 函数 +* 函数原型： + +``` +widget_t* scroll_view_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -54,11 +72,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建scroll_view对象 +* 函数功能： + +>

创建scroll_view对象 #### scroll\_view\_scroll\_to 函数 +* 函数原型： + +``` +ret_t scroll_view_scroll_to (widget_t* widget, int32_t xoffset_end, int32_t yoffset_end, int32_t duration); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -68,11 +96,21 @@ | xoffset\_end | int32\_t | x偏移量。 | | yoffset\_end | int32\_t | y偏移量。 | | duration | int32\_t | 时间。 | -

滚动到指定的偏移量。 +* 函数功能： + +>

滚动到指定的偏移量。 #### scroll\_view\_set\_offset 函数 +* 函数原型： + +``` +ret_t scroll_view_set_offset (widget_t* widget, int32_t xoffset, int32_t yoffset); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -81,11 +119,21 @@ | widget | widget\_t* | 控件对象。 | | xoffset | int32\_t | x偏移量。 | | yoffset | int32\_t | y偏移量。 | -

设置偏移量。 +* 函数功能： + +>

设置偏移量。 #### scroll\_view\_set\_virtual\_h 函数 +* 函数原型： + +``` +ret_t scroll_view_set_virtual_h (widget_t* widget, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -93,11 +141,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | h | wh\_t | 虚拟高度。 | -

设置虚拟高度。 +* 函数功能： + +>

设置虚拟高度。 #### scroll\_view\_set\_virtual\_w 函数 +* 函数原型： + +``` +ret_t scroll_view_set_virtual_w (widget_t* widget, wh_t w); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -105,11 +163,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | w | wh\_t | 虚拟宽度。 | -

设置虚拟宽度。 +* 函数功能： + +>

设置虚拟宽度。 #### scroll\_view\_set\_xslidable 函数 +* 函数原型： + +``` +ret_t scroll_view_set_xslidable (widget_t* widget, bool_t xslidable); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -117,11 +185,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | xslidable | bool\_t | 是否允许滑动。 | -

设置是否允许x方向滑动。 +* 函数功能： + +>

设置是否允许x方向滑动。 #### scroll\_view\_set\_yslidable 函数 +* 函数原型： + +``` +ret_t scroll_view_set_yslidable (widget_t* widget, bool_t yslidable); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -129,13 +207,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | yslidable | bool\_t | 是否允许滑动。 | -

设置是否允许y方向滑动。 +* 函数功能： + +>

设置是否允许y方向滑动。 #### virtual\_h 属性 ----------------------- -

虚拟高度。 +>

虚拟高度。 * 类型：wh\_t @@ -152,7 +232,7 @@ | 支通过widget_set_prop修改 | 是 | #### virtual\_w 属性 ----------------------- -

虚拟宽度。 +>

虚拟宽度。 * 类型：wh\_t @@ -169,7 +249,7 @@ | 支通过widget_set_prop修改 | 是 | #### xoffset 属性 ----------------------- -

x偏移量。 +>

x偏移量。 * 类型：int32\_t @@ -186,7 +266,7 @@ | 支通过widget_set_prop修改 | 是 | #### xslidable 属性 ----------------------- -

是否允许x方向滑动。 +>

是否允许x方向滑动。 * 类型：bool\_t @@ -203,7 +283,7 @@ | 支通过widget_set_prop修改 | 是 | #### yoffset 属性 ----------------------- -

y偏移量。 +>

y偏移量。 * 类型：int32\_t @@ -220,7 +300,7 @@ | 支通过widget_set_prop修改 | 是 | #### yslidable 属性 ----------------------- -

是否允许y方向滑动。 +>

是否允许y方向滑动。 * 类型：bool\_t diff --git a/docs/manual/self_layouter_t.md b/docs/manual/self_layouter_t.md index b59233d02a..f8a7900bd1 100644 --- a/docs/manual/self_layouter_t.md +++ b/docs/manual/self_layouter_t.md @@ -27,18 +27,36 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### self\_layouter\_destroy 函数 +* 函数原型： + +``` +ret_t self_layouter_destroy (self_layouter_t* layouter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | layouter | self\_layouter\_t* | layouter对象。 | -

销毁layouter对象。 +* 函数功能： + +>

销毁layouter对象。 #### self\_layouter\_get\_param 函数 +* 函数原型： + +``` +ret_t self_layouter_get_param (self_layouter_t* layouter, const char* name, value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -47,12 +65,22 @@ | layouter | self\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | v | value\_t* | 返回参数的值。 | -

获取指定的参数。 +* 函数功能： + +>

获取指定的参数。 #### self\_layouter\_get\_param\_float 函数 +* 函数原型： + +``` +ret_t self_layouter_get_param_float (self_layouter_t* layouter, const char* name, float_t defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -61,12 +89,22 @@ | layouter | self\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | defval | float\_t | 缺省值。 | -

获取指定的浮点格式的参数。 +* 函数功能： + +>

获取指定的浮点格式的参数。 #### self\_layouter\_get\_param\_int 函数 +* 函数原型： + +``` +ret_t self_layouter_get_param_int (self_layouter_t* layouter, const char* name, int32_t defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -75,12 +113,22 @@ | layouter | self\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | defval | int32\_t | 缺省值。 | -

获取指定的整数格式的参数。 +* 函数功能： + +>

获取指定的整数格式的参数。 #### self\_layouter\_layout 函数 +* 函数原型： + +``` +ret_t self_layouter_layout (self_layouter_t* layouter, widget_t* widget, rect_t* area); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -89,12 +137,22 @@ | layouter | self\_layouter\_t* | layouter对象。 | | widget | widget\_t* | 控件。 | | area | rect\_t* | 可以使用的区域。 | -

对控件进行Layout。 +* 函数功能： + +>

对控件进行Layout。 #### self\_layouter\_set\_param 函数 +* 函数原型： + +``` +ret_t self_layouter_set_param (self_layouter_t* layouter, const char* name, const value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -103,12 +161,22 @@ | layouter | self\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | v | const value\_t* | 参数的值。 | -

获取指定的参数。 +* 函数功能： + +>

获取指定的参数。 #### self\_layouter\_set\_param\_str 函数 +* 函数原型： + +``` +ret_t self_layouter_set_param_str (self_layouter_t* layouter, const char* name, const char* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -117,19 +185,31 @@ | layouter | self\_layouter\_t* | layouter对象。 | | name | const char* | 参数名。 | | value | const char* | 参数值。 | -

设置字符串格式的参数。 +* 函数功能： + +>

设置字符串格式的参数。 #### self\_layouter\_to\_string 函数 +* 函数原型： + +``` +ret_t self_layouter_to_string (self_layouter_t* layouter); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回字符串格式的参数。 | | layouter | self\_layouter\_t* | layouter对象。 | -

获取全部参数。 +* 函数功能： + +>

获取全部参数。 diff --git a/docs/manual/slide_menu_t.md b/docs/manual/slide_menu_t.md index 6439ef766e..811d622107 100644 --- a/docs/manual/slide_menu_t.md +++ b/docs/manual/slide_menu_t.md @@ -1,10 +1,10 @@ ## slide\_menu\_t ### 概述 +![image](images/slide_menu_t_0.png) + slide menu。 一般用一组按钮作为子控件，通过左右滑动改变当前的项。 除了当菜单使用外，也可以用来切换页面。 -![image](images/slide_menu_t_0.png) - ### 函数

@@ -31,17 +31,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(当前项)即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值(当前项)改变事件。 | #### slide\_menu\_cast 函数 +* 函数原型： + +``` +widget_t* slide_menu_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | slide\_menu对象。 | | widget | widget\_t* | slide\_menu对象。 | -

转换slide_menu对象(供脚本语言使用)。 +* 函数功能： + +>

转换slide_menu对象(供脚本语言使用)。 #### slide\_menu\_create 函数 +* 函数原型： + +``` +widget_t* slide_menu_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -52,11 +70,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建slide_menu对象 +* 函数功能： + +>

创建slide_menu对象 #### slide\_menu\_set\_align\_v 函数 +* 函数原型： + +``` +ret_t slide_menu_set_align_v (widget_t* widget, align_v_t align_v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -64,11 +92,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | slide\_menu对象。 | | align\_v | align\_v\_t | 对齐方式。 | -

设置垂直对齐方式。 +* 函数功能： + +>

设置垂直对齐方式。 #### slide\_menu\_set\_min\_scale 函数 +* 函数原型： + +``` +ret_t slide_menu_set_min_scale (widget_t* widget, float_t min_scale); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -76,11 +114,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | slide\_menu对象。 | | min\_scale | float\_t | 最小缩放比例，范围[0.5-1]。 | -

设置最小缩放比例。 +* 函数功能： + +>

设置最小缩放比例。 #### slide\_menu\_set\_value 函数 +* 函数原型： + +``` +ret_t slide_menu_set_value (widget_t* widget, uint32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -88,13 +136,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | slide\_menu对象。 | | value | uint32\_t | 当前项的索引。 | -

设置当前项。 +* 函数功能： + +>

设置当前项。 #### align\_v 属性 ----------------------- -

垂直对齐方式。 +>

垂直对齐方式。 * 类型：align\_v\_t @@ -111,7 +161,7 @@ | 支通过widget_set_prop修改 | 是 | #### min\_scale 属性 ----------------------- -

最小缩放比例。 +>

最小缩放比例。 * 类型：float\_t @@ -128,7 +178,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

值。代表当前选中项的索引。 +>

值。代表当前选中项的索引。 * 类型：int32\_t diff --git a/docs/manual/slide_view_t.md b/docs/manual/slide_view_t.md index 87b6d7f88c..5df54dfd16 100644 --- a/docs/manual/slide_view_t.md +++ b/docs/manual/slide_view_t.md @@ -1,8 +1,8 @@ ## slide\_view\_t ### 概述 - slide view。 ![image](images/slide_view_t_0.png) + slide view。 ### 函数

@@ -28,17 +28,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(当前页)即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值(当前页)改变事件。 | #### slide\_view\_cast 函数 +* 函数原型： + +``` +widget_t* slide_view_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | slide\_view对象。 | | widget | widget\_t* | slide\_view对象。 | -

转换为slide_view对象(供脚本语言使用)。 +* 函数功能： + +>

转换为slide_view对象(供脚本语言使用)。 #### slide\_view\_create 函数 +* 函数原型： + +``` +widget_t* slide_view_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -49,11 +67,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建slide_view对象 +* 函数功能： + +>

创建slide_view对象 #### slide\_view\_set\_active 函数 +* 函数原型： + +``` +ret_t slide_view_set_active (widget_t* widget, uint32_t index); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -61,11 +89,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | slide\_view对象。 | | index | uint32\_t | 当前页的序号。 | -

设置当前页的序号。 +* 函数功能： + +>

设置当前页的序号。 #### slide\_view\_set\_auto\_play 函数 +* 函数原型： + +``` +ret_t slide_view_set_auto_play (widget_t* widget, uint16_t auto_play); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -73,11 +111,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | slide\_view对象。 | | auto\_play | uint16\_t | 0表示禁止自动播放，非0表示自动播放时每一页播放的时间。 | -

设置为自动播放模式。 +* 函数功能： + +>

设置为自动播放模式。 #### slide\_view\_set\_vertical 函数 +* 函数原型： + +``` +ret_t slide_view_set_vertical (widget_t* widget, bool_t vertical); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -85,13 +133,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | slide\_view对象。 | | vertical | bool\_t | TRUE表示上下滑动，FALSE表示左右滑动。 | -

设置为上下滑动(缺省为左右滑动)。 +* 函数功能： + +>

设置为上下滑动(缺省为左右滑动)。 #### auto\_play 属性 ----------------------- -

自动播放。0表示禁止自动播放，非0表示自动播放时每一页播放的时间。 +>

自动播放。0表示禁止自动播放，非0表示自动播放时每一页播放的时间。 * 类型：uint16\_t @@ -108,7 +158,7 @@ | 支通过widget_set_prop修改 | 是 | #### vertical 属性 ----------------------- -

是否为上下滑动模式。 +>

是否为上下滑动模式。 * 类型：bool\_t diff --git a/docs/manual/slider_t.md b/docs/manual/slider_t.md index fdc9ad4fa1..3e808e52f5 100644 --- a/docs/manual/slider_t.md +++ b/docs/manual/slider_t.md @@ -1,8 +1,8 @@ ## slider\_t ### 概述 - 滑块控件。 ![image](images/slider_t_0.png) + 滑块控件。 ### 函数

@@ -34,17 +34,35 @@ | EVT\_VALUE\_CHANGING | event\_t | 值正在改变事件(拖动中)。 | | EVT\_VALUE\_CHANGED | event\_t | 值改变事件。 | #### slider\_cast 函数 +* 函数原型： + +``` +widget_t* slider_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | slider对象。 | | widget | widget\_t* | slider对象。 | -

转换为slider对象(供脚本语言使用)。 +* 函数功能： + +>

转换为slider对象(供脚本语言使用)。 #### slider\_create 函数 +* 函数原型： + +``` +widget_t* slider_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -55,11 +73,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建slider对象 +* 函数功能： + +>

创建slider对象 #### slider\_set\_max 函数 +* 函数原型： + +``` +ret_t slider_set_max (widget_t* widget, uint16_t max); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -67,11 +95,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | max | uint16\_t | 最大值 | -

设置滑块的最大值。 +* 函数功能： + +>

设置滑块的最大值。 #### slider\_set\_min 函数 +* 函数原型： + +``` +ret_t slider_set_min (widget_t* widget, uint16_t min); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -79,11 +117,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | min | uint16\_t | 最小值 | -

设置滑块的最小值。 +* 函数功能： + +>

设置滑块的最小值。 #### slider\_set\_step 函数 +* 函数原型： + +``` +ret_t slider_set_step (widget_t* widget, uint16_t step); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -91,11 +139,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | step | uint16\_t | 拖动的最小单位。 | -

设置滑块的拖动的最小单位。 +* 函数功能： + +>

设置滑块的拖动的最小单位。 #### slider\_set\_value 函数 +* 函数原型： + +``` +ret_t slider_set_value (widget_t* widget, uint16_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -103,11 +161,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | value | uint16\_t | 值 | -

设置滑块的值。 +* 函数功能： + +>

设置滑块的值。 #### slider\_set\_vertical 函数 +* 函数原型： + +``` +ret_t slider_set_vertical (widget_t* widget, bool_t vertical); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -115,13 +183,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | vertical | bool\_t | 是否为垂直方向。 | -

设置滑块的方向。 +* 函数功能： + +>

设置滑块的方向。 #### max 属性 ----------------------- -

最大值。 +>

最大值。 * 类型：uint16\_t @@ -138,7 +208,7 @@ | 支通过widget_set_prop修改 | 是 | #### min 属性 ----------------------- -

最小值。 +>

最小值。 * 类型：uint16\_t @@ -155,7 +225,7 @@ | 支通过widget_set_prop修改 | 是 | #### step 属性 ----------------------- -

拖动的最小单位。 +>

拖动的最小单位。 * 类型：uint16\_t @@ -172,7 +242,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

值。 +>

值。 * 类型：uint16\_t @@ -189,7 +259,7 @@ | 支通过widget_set_prop修改 | 是 | #### vertical 属性 ----------------------- -

滑块的是否为垂直方向。 +>

滑块的是否为垂直方向。 * 类型：bool\_t diff --git a/docs/manual/spin_box_t.md b/docs/manual/spin_box_t.md index c1468ee995..763676c934 100644 --- a/docs/manual/spin_box_t.md +++ b/docs/manual/spin_box_t.md @@ -1,8 +1,8 @@ ## spin\_box\_t ### 概述 - spinbox控件。 ![image](images/spin_box_t_0.png) + spinbox控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### spin\_box\_cast 函数 +* 函数原型： + +``` +widget_t* spin_box_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | spin\_box对象。 | | widget | widget\_t* | spin\_box对象。 | -

转换为spin_box对象(供脚本语言使用)。 +* 函数功能： + +>

转换为spin_box对象(供脚本语言使用)。 #### spin\_box\_create 函数 +* 函数原型： + +``` +widget_t* spin_box_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建spin_box对象 +* 函数功能： + +>

创建spin_box对象 diff --git a/docs/manual/str_t.md b/docs/manual/str_t.md index b0ac35cced..1b95c6d77b 100644 --- a/docs/manual/str_t.md +++ b/docs/manual/str_t.md @@ -49,6 +49,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### str\_append 函数 +* 函数原型： + +``` +ret_t str_append (str_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -56,12 +64,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | text | char* | 要追加的字符串。 | -

追加字符串。 +* 函数功能： + +>

追加字符串。 #### str\_append\_char 函数 +* 函数原型： + +``` +ret_t str_append_char (str_t* str, char c); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -69,12 +87,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | c | char | 要追加的字符。 | -

追加一个字符。 +* 函数功能： + +>

追加一个字符。 #### str\_append\_with\_len 函数 +* 函数原型： + +``` +ret_t str_append_with_len (str_t* str, char* text, uint32_t len); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -83,12 +111,22 @@ | str | str\_t* | str对象。 | | text | char* | 要追加的字符串。 | | len | uint32\_t | 字符串长度。 | -

追加字符串。 +* 函数功能： + +>

追加字符串。 #### str\_decode\_xml\_entity 函数 +* 函数原型： + +``` +ret_t str_decode_xml_entity (str_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -96,12 +134,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | text | char* | 要解码的XML文本。 | -

对XML基本的entity进行解码，目前仅支持<>"a;&。 +* 函数功能： + +>

对XML基本的entity进行解码，目前仅支持<>"a;&。 #### str\_decode\_xml\_entity\_with\_len 函数 +* 函数原型： + +``` +ret_t str_decode_xml_entity_with_len (str_t* str, char* text, uint32_t len); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -110,12 +158,22 @@ | str | str\_t* | str对象。 | | text | char* | 要解码的XML文本。 | | len | uint32\_t | 字符串长度。 | -

对XML基本的entity进行解码，目前仅支持<>"a;&。 +* 函数功能： + +>

对XML基本的entity进行解码，目前仅支持<>"a;&。 #### str\_end\_with 函数 +* 函数原型： + +``` +bool_t str_end_with (str_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -123,12 +181,22 @@ | 返回值 | bool\_t | 返回是否以指定的子串结尾。 | | str | str\_t* | str对象。 | | text | char* | 子字符串。 | -

判断字符串是否以指定的子串结尾。 +* 函数功能： + +>

判断字符串是否以指定的子串结尾。 #### str\_eq 函数 +* 函数原型： + +``` +bool_t str_eq (str_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -136,12 +204,22 @@ | 返回值 | bool\_t | 返回是否相等。 | | str | str\_t* | str对象。 | | text | char* | 待比较的字符串。 | -

判断两个字符串是否相等。 +* 函数功能： + +>

判断两个字符串是否相等。 #### str\_from\_float 函数 +* 函数原型： + +``` +ret_t str_from_float (str_t* str, float v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -149,12 +227,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | v | float | 浮点数。 | -

用浮点数初始化字符串。 +* 函数功能： + +>

用浮点数初始化字符串。 #### str\_from\_int 函数 +* 函数原型： + +``` +ret_t str_from_int (str_t* str, int32_t v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -162,12 +250,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | v | int32\_t | 整数。 | -

用整数初始化字符串。 +* 函数功能： + +>

用整数初始化字符串。 #### str\_from\_value 函数 +* 函数原型： + +``` +ret_t str_from_value (str_t* str, value_t v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -175,12 +273,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | v | value\_t | value。 | -

用value初始化字符串。 +* 函数功能： + +>

用value初始化字符串。 #### str\_from\_wstr 函数 +* 函数原型： + +``` +ret_t str_from_wstr (str_t* str, wchar_t* wstr); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -188,12 +296,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | wstr | wchar\_t* | wstr。 | -

用value初始化字符串。 +* 函数功能： + +>

用value初始化字符串。 #### str\_init 函数 +* 函数原型： + +``` +str_t* str_init (str_t* str, uint32_t capacity); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -201,12 +319,22 @@ | 返回值 | str\_t* | str对象本身。 | | str | str\_t* | str对象。 | | capacity | uint32\_t | 初始容量。 | -

初始化字符串对象。 +* 函数功能： + +>

初始化字符串对象。 #### str\_insert 函数 +* 函数原型： + +``` +ret_t str_insert (str_t* str, uint32_t offset, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -215,12 +343,22 @@ | str | str\_t* | str对象。 | | offset | uint32\_t | 偏移量。 | | text | char* | 要插入的字符串。 | -

插入子字符串。 +* 函数功能： + +>

插入子字符串。 #### str\_insert\_with\_len 函数 +* 函数原型： + +``` +ret_t str_insert_with_len (str_t* str, uint32_t offset, char* text, uint32_t len); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -230,12 +368,22 @@ | offset | uint32\_t | 偏移量。 | | text | char* | 要插入的字符串。 | | len | uint32\_t | 字符串长度。 | -

插入子字符串。 +* 函数功能： + +>

插入子字符串。 #### str\_remove 函数 +* 函数原型： + +``` +ret_t str_remove (str_t* str, uint32_t offset, uint32_t len); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -244,12 +392,22 @@ | str | str\_t* | str对象。 | | offset | uint32\_t | 偏移量。 | | len | uint32\_t | 长度。 | -

删除子字符串。 +* 函数功能： + +>

删除子字符串。 #### str\_replace 函数 +* 函数原型： + +``` +ret_t str_replace (str_t* str, char* text, char* new_text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -258,24 +416,44 @@ | str | str\_t* | str对象。 | | text | char* | 待替换的子串。 | | new\_text | char* | 将替换成的子串。 | -

字符串替换。 +* 函数功能： + +>

字符串替换。 #### str\_reset 函数 +* 函数原型： + +``` +ret_t str_reset (str_t* str); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | -

重置字符串为空。 +* 函数功能： + +>

重置字符串为空。 #### str\_set 函数 +* 函数原型： + +``` +ret_t str_set (str_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -283,12 +461,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | text | char* | 要设置的字符串。 | -

设置字符串。 +* 函数功能： + +>

设置字符串。 #### str\_set\_with\_len 函数 +* 函数原型： + +``` +ret_t str_set_with_len (str_t* str, char* text, uint32_t len); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -297,12 +485,22 @@ | str | str\_t* | str对象。 | | text | char* | 要设置的字符串。 | | len | uint32\_t | 字符串长度。 | -

设置字符串。 +* 函数功能： + +>

设置字符串。 #### str\_start\_with 函数 +* 函数原型： + +``` +bool_t str_start_with (str_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -310,12 +508,22 @@ | 返回值 | bool\_t | 返回是否以指定的子串开头。 | | str | str\_t* | str对象。 | | text | char* | 子字符串。 | -

判断字符串是否以指定的子串开头。 +* 函数功能： + +>

判断字符串是否以指定的子串开头。 #### str\_to\_float 函数 +* 函数原型： + +``` +ret_t str_to_float (str_t* str, float* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -323,12 +531,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | v | float* | 用于返回浮点数。 | -

将字符串转成浮点数。 +* 函数功能： + +>

将字符串转成浮点数。 #### str\_to\_int 函数 +* 函数原型： + +``` +ret_t str_to_int (str_t* str, int32_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -336,36 +554,66 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | v | int32\_t* | 用于返回整数。 | -

将字符串转成整数。 +* 函数功能： + +>

将字符串转成整数。 #### str\_to\_lower 函数 +* 函数原型： + +``` +ret_t str_to_lower (str_t* str); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | -

将字符串转成小写。 +* 函数功能： + +>

将字符串转成小写。 #### str\_to\_upper 函数 +* 函数原型： + +``` +ret_t str_to_upper (str_t* str); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | -

将字符串转成大写。 +* 函数功能： + +>

将字符串转成大写。 #### str\_trim 函数 +* 函数原型： + +``` +ret_t str_trim (str_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -373,12 +621,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | text | char* | 要去除的字符集合。 | -

去除首尾指定的字符。 +* 函数功能： + +>

去除首尾指定的字符。 #### str\_trim\_left 函数 +* 函数原型： + +``` +ret_t str_trim_left (str_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -386,12 +644,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | text | char* | 要去除的字符集合。 | -

去除首部指定的字符。 +* 函数功能： + +>

去除首部指定的字符。 #### str\_trim\_right 函数 +* 函数原型： + +``` +ret_t str_trim_right (str_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -399,26 +667,38 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | | text | char* | 要去除的字符集合。 | -

去除尾部指定的字符。 +* 函数功能： + +>

去除尾部指定的字符。 #### str\_unescape 函数 +* 函数原型： + +``` +ret_t str_unescape (str_t* str); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | str\_t* | str对象。 | -

对字符串进行反转义。如：把"\n"转换成'\n'。 +* 函数功能： + +>

对字符串进行反转义。如：把"\n"转换成'\n'。 #### capacity 属性 ----------------------- -

容量。 +>

容量。 @@ -436,7 +716,7 @@ | 支通过widget_set_prop修改 | 否 | #### size 属性 ----------------------- -

长度。 +>

长度。 @@ -454,7 +734,7 @@ | 支通过widget_set_prop修改 | 否 | #### str 属性 ----------------------- -

字符串。 +>

字符串。 diff --git a/docs/manual/style_factory_t.md b/docs/manual/style_factory_t.md index bf268545a8..f955b65139 100644 --- a/docs/manual/style_factory_t.md +++ b/docs/manual/style_factory_t.md @@ -21,16 +21,34 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### style\_factory 函数 +* 函数原型： + +``` +style_factory_t* style_factory (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | style\_factory\_t* | 返回style factory对象。 | -

获取缺省的style factory。 +* 函数功能： + +>

获取缺省的style factory。 #### style\_factory\_create\_style 函数 +* 函数原型： + +``` +style_t* style_factory_create_style (style_factory_t* factory, widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -38,19 +56,31 @@ | 返回值 | style\_t* | 返回style对象。 | | factory | style\_factory\_t* | factory对象。 | | widget | widget\_t* | 控件对象。 | -

创建style。 +* 函数功能： + +>

创建style。 #### style\_factory\_set 函数 +* 函数原型： + +``` +ret_t style_factory_set (style_factory_t* factory); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | factory | style\_factory\_t* | factory对象。 | -

设置缺省的style factory(需要自定义的style factory才设置)。 +* 函数功能： + +>

设置缺省的style factory(需要自定义的style factory才设置)。 diff --git a/docs/manual/style_mutable_t.md b/docs/manual/style_mutable_t.md index d3d17102aa..45181403b8 100644 --- a/docs/manual/style_mutable_t.md +++ b/docs/manual/style_mutable_t.md @@ -1,9 +1,9 @@ ## style\_mutable\_t ### 概述 - 控件风格(可实时修改并生效，用于在designer中被编辑的控件)。 - ![image](images/style_mutable_t_0.png) + 控件风格(可实时修改并生效，用于在designer中被编辑的控件)。 + ### 函数

@@ -29,18 +29,36 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### style\_mutable\_create 函数 +* 函数原型： + +``` +style_t* style_mutable_create (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | style\_t* | style对象。 | | widget | widget\_t* | 控件 | -

创建style_mutable对象。除了测试程序外不需要直接调用，widget会通过style_factory_create创建。 +* 函数功能： + +>

创建style_mutable对象。除了测试程序外不需要直接调用，widget会通过style_factory_create创建。 #### style\_mutable\_foreach 函数 +* 函数原型： + +``` +ret_t style_mutable_foreach (style_t* s, tk_on_style_item_t on_style_item, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -49,35 +67,65 @@ | s | style\_t* | style对象。 | | on\_style\_item | tk\_on\_style\_item\_t | 回调函数。 | | ctx | void* | 回调函数的上下文。 | -

遍历。对每项调用回调函数on_style_item。 +* 函数功能： + +>

遍历。对每项调用回调函数on_style_item。 #### style\_mutable\_get\_name 函数 +* 函数原型： + +``` +const char* style_mutable_get_name (style_t* s); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | const char* | style的名称。 | | s | style\_t* | style对象。 | -

获取style的名称。 +* 函数功能： + +>

获取style的名称。 #### style\_mutable\_register 函数 +* 函数原型： + +``` +ret_t style_mutable_register (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | -

将自己注册到style_factory。 +* 函数功能： + +>

将自己注册到style_factory。 #### style\_mutable\_set\_color 函数 +* 函数原型： + +``` +ret_t style_mutable_set_color (style_t* s, widget_state_t state, style_id_t id, color_t val); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -87,12 +135,22 @@ | state | widget\_state\_t | 控件状态。 | | id | style\_id\_t | 属性ID。 | | val | color\_t | 值。 | -

设置指定id的颜色值。 +* 函数功能： + +>

设置指定id的颜色值。 #### style\_mutable\_set\_int 函数 +* 函数原型： + +``` +ret_t style_mutable_set_int (style_t* s, widget_state_t state, style_id_t id, int32_t val); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -102,12 +160,22 @@ | state | widget\_state\_t | 控件状态。 | | id | style\_id\_t | 属性ID。 | | val | int32\_t | 值。 | -

设置指定id整数格式的值。 +* 函数功能： + +>

设置指定id整数格式的值。 #### style\_mutable\_set\_name 函数 +* 函数原型： + +``` +ret_t style_mutable_set_name (style_t* s, const char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -115,12 +183,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | s | style\_t* | style对象。 | | name | const char* | 名称。 | -

设置style的名称。 +* 函数功能： + +>

设置style的名称。 #### style\_mutable\_set\_str 函数 +* 函数原型： + +``` +ret_t style_mutable_set_str (style_t* s, widget_state_t state, style_id_t id, const char* val); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -130,14 +208,16 @@ | state | widget\_state\_t | 控件状态。 | | id | style\_id\_t | 属性ID。 | | val | const char* | 值。 | -

设置指定id字符串的值。 +* 函数功能： + +>

设置指定id字符串的值。 #### name 属性 ----------------------- -

名称。 +>

名称。 diff --git a/docs/manual/style_t.md b/docs/manual/style_t.md index 62f1e20a66..327f05cae4 100644 --- a/docs/manual/style_t.md +++ b/docs/manual/style_t.md @@ -24,18 +24,36 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### style\_destroy 函数 +* 函数原型： + +``` +ret_t style_destroy (style_t* s); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | s | style\_t* | style对象。 | -

销毁style对象 +* 函数功能： + +>

销毁style对象 #### style\_get\_color 函数 +* 函数原型： + +``` +color_t style_get_color (style_t* s, style_id_t id, color_t defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -44,12 +62,22 @@ | s | style\_t* | style对象。 | | id | style\_id\_t | 属性ID。 | | defval | color\_t | 缺省值。 | -

获取指定id的颜色值。 +* 函数功能： + +>

获取指定id的颜色值。 #### style\_get\_int 函数 +* 函数原型： + +``` +int32_t style_get_int (style_t* s, style_id_t id, int32_t defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -58,12 +86,22 @@ | s | style\_t* | style对象。 | | id | style\_id\_t | 属性ID。 | | defval | int32\_t | 缺省值。 | -

获取指定id的整数格式的值。 +* 函数功能： + +>

获取指定id的整数格式的值。 #### style\_get\_str 函数 +* 函数原型： + +``` +const char* style_get_str (style_t* s, style_id_t id, const char* defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -72,24 +110,44 @@ | s | style\_t* | style对象。 | | id | style\_id\_t | 属性ID。 | | defval | const char* | 缺省值。 | -

获取指定id的字符串格式的值。 +* 函数功能： + +>

获取指定id的字符串格式的值。 #### style\_is\_valid 函数 +* 函数原型： + +``` +bool_t style_is_valid (style_t* s); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bool\_t | 返回是否有效。 | | s | style\_t* | style对象。 | -

检查style对象是否有效 +* 函数功能： + +>

检查style对象是否有效 #### style\_notify\_widget\_state\_changed 函数 +* 函数原型： + +``` +ret_t style_notify_widget_state_changed (style_t* s, widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -97,7 +155,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | s | style\_t* | style对象。 | | widget | widget\_t* | 控件对象。 | -

widget状态改变时，通知style更新数据。 +* 函数功能： + +>

widget状态改变时，通知style更新数据。 diff --git a/docs/manual/suggest_words_t.md b/docs/manual/suggest_words_t.md index 582b429e38..597d179176 100644 --- a/docs/manual/suggest_words_t.md +++ b/docs/manual/suggest_words_t.md @@ -21,31 +21,59 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### suggest\_words\_create 函数 +* 函数原型： + +``` +suggest_words_t* suggest_words_create (asset_info_t* res); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | suggest\_words\_t* | 返回联想字对象。 | | res | asset\_info\_t* | 数据资源。 | -

创建联想字对象。 +* 函数功能： + +>

创建联想字对象。 #### suggest\_words\_destroy 函数 +* 函数原型： + +``` +ret_t suggest_words_destroy (suggest_words_t* suggest_words); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | suggest\_words | suggest\_words\_t* | 联想字对象。 | -

@deconstructor +* 函数功能： + +>

@deconstructor 销毁联想字对象。 #### suggest\_words\_find 函数 +* 函数原型： + +``` +ret_t suggest_words_find (suggest_words_t* suggest_words, wchar_t c); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -53,7 +81,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | suggest\_words | suggest\_words\_t* | 联想字对象。 | | c | wchar\_t | 字符。 | -

查找prefix对应的联想字列表，成功后会更新words/words_nr。 +* 函数功能： + +>

查找prefix对应的联想字列表，成功后会更新words/words_nr。 diff --git a/docs/manual/svg_image_t.md b/docs/manual/svg_image_t.md index 75220eb7d6..5f2084418b 100644 --- a/docs/manual/svg_image_t.md +++ b/docs/manual/svg_image_t.md @@ -1,8 +1,8 @@ ## svg\_image\_t ### 概述 - SVG图片控件。 ![image](images/svg_image_t_0.png) + SVG图片控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### svg\_image\_cast 函数 +* 函数原型： + +``` +widget_t* svg_image_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | svg\_image对象。 | | widget | widget\_t* | svg\_image对象。 | -

转换为svg_image对象(供脚本语言使用)。 +* 函数功能： + +>

转换为svg_image对象(供脚本语言使用)。 #### svg\_image\_create 函数 +* 函数原型： + +``` +widget_t* svg_image_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建svg_image对象 +* 函数功能： + +>

创建svg_image对象 diff --git a/docs/manual/switch_t.md b/docs/manual/switch_t.md index 3301319f33..28dbf1ef67 100644 --- a/docs/manual/switch_t.md +++ b/docs/manual/switch_t.md @@ -1,8 +1,8 @@ ## switch\_t ### 概述 - 开关控件。 ![image](images/switch_t_0.png) + 开关控件。 ### 函数

@@ -27,17 +27,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(开关状态)即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值(开关状态)改变事件。 | #### switch\_cast 函数 +* 函数原型： + +``` +widget_t* switch_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | switch对象。 | | widget | widget\_t* | switch对象。 | -

转换switch对象(供脚本语言使用)。 +* 函数功能： + +>

转换switch对象(供脚本语言使用)。 #### switch\_create 函数 +* 函数原型： + +``` +widget_t* switch_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -48,11 +66,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建switch对象 +* 函数功能： + +>

创建switch对象 #### switch\_set\_value 函数 +* 函数原型： + +``` +ret_t switch_set_value (widget_t* widget, bool_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -60,13 +88,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | switch对象。 | | value | bool\_t | 值 | -

设置控件的值。 +* 函数功能： + +>

设置控件的值。 #### max\_xoffset\_ratio 属性 ----------------------- -

当开关处于关闭时，图片偏移相对于图片宽度的比例(缺省为1/3)。 +>

当开关处于关闭时，图片偏移相对于图片宽度的比例(缺省为1/3)。 * 类型：float\_t @@ -83,7 +113,7 @@ | 支通过widget_set_prop修改 | 是 | #### round\_radius 属性 ----------------------- -

图片的圆角半径。 +>

图片的圆角半径。 * 类型：int32\_t @@ -100,7 +130,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

值。 +>

值。 * 类型：bool\_t diff --git a/docs/manual/system_bar_t.md b/docs/manual/system_bar_t.md index 814bfbba76..bff34740e2 100644 --- a/docs/manual/system_bar_t.md +++ b/docs/manual/system_bar_t.md @@ -1,11 +1,11 @@ ## system\_bar\_t ### 概述 +![image](images/system_bar_t_0.png) + system_bar窗口。独占LCD顶部区域，用来显示系统状态和当前窗口的标题等信息。 system_bar对两个子控件会做特殊处理： * 1.名为"title"的label控件，自动显示当前主窗口的name或text。 * 2.名为"close"的button控件，点击之后向当前主窗口发送EVT_REQUEST_CLOSE_WINDOW消息。 -![image](images/system_bar_t_0.png) - ### 函数

@@ -24,17 +24,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### system\_bar\_cast 函数 +* 函数原型： + +``` +widget_t* system_bar_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | system\_bar对象。 | | widget | widget\_t* | system\_bar对象。 | -

转换为system_bar对象(供脚本语言使用)。 +* 函数功能： + +>

转换为system_bar对象(供脚本语言使用)。 #### system\_bar\_create 函数 +* 函数原型： + +``` +widget_t* system_bar_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -45,7 +63,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建system_bar对象。 +* 函数功能： + +>

创建system_bar对象。 diff --git a/docs/manual/system_info_t.md b/docs/manual/system_info_t.md index 5665dd9099..dc76a8136a 100644 --- a/docs/manual/system_info_t.md +++ b/docs/manual/system_info_t.md @@ -28,16 +28,34 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### system\_info 函数 +* 函数原型： + +``` +system_info_t* system_info (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | system\_info\_t* | 返回system\_info对象。 | -

获取system_info对象。 +* 函数功能： + +>

获取system_info对象。 #### system\_info\_init 函数 +* 函数原型： + +``` +ret_t system_info_init (app_type_t app_type, const char* app_name, const char* app_root); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -46,14 +64,16 @@ | app\_type | app\_type\_t | 应用程序的类型。 | | app\_name | const char* | 应用程序的名称。 | | app\_root | const char* | 应用程序的根目录，用于定位资源文件。 | -

初始化system_info对象(PC软件才需调用)。 +* 函数功能： + +>

初始化system_info对象(PC软件才需调用)。 #### app\_name 属性 ----------------------- -

应用程序的名称。 +>

应用程序的名称。 @@ -71,7 +91,7 @@ | 支通过widget_set_prop修改 | 否 | #### app\_root 属性 ----------------------- -

应用程序的根目录，用于定位资源文件。 +>

应用程序的根目录，用于定位资源文件。 @@ -89,7 +109,7 @@ | 支通过widget_set_prop修改 | 否 | #### app\_type 属性 ----------------------- -

应用程序的类型。 +>

应用程序的类型。 @@ -107,7 +127,7 @@ | 支通过widget_set_prop修改 | 否 | #### device\_pixel\_ratio 属性 ----------------------- -

显示屏的密度。 +>

显示屏的密度。 @@ -125,7 +145,7 @@ | 支通过widget_set_prop修改 | 否 | #### lcd\_h 属性 ----------------------- -

显示屏的高度。 +>

显示屏的高度。 @@ -143,7 +163,7 @@ | 支通过widget_set_prop修改 | 否 | #### lcd\_orientation 属性 ----------------------- -

显示屏的旋转角度。 +>

显示屏的旋转角度。 @@ -161,7 +181,7 @@ | 支通过widget_set_prop修改 | 否 | #### lcd\_type 属性 ----------------------- -

显示屏的类型。 +>

显示屏的类型。 @@ -179,7 +199,7 @@ | 支通过widget_set_prop修改 | 否 | #### lcd\_w 属性 ----------------------- -

显示屏的宽度。 +>

显示屏的宽度。 diff --git a/docs/manual/tab_button_group_t.md b/docs/manual/tab_button_group_t.md index ac312c85a4..404931f977 100644 --- a/docs/manual/tab_button_group_t.md +++ b/docs/manual/tab_button_group_t.md @@ -1,8 +1,8 @@ ## tab\_button\_group\_t ### 概述 - Tab Button Group控件。 ![image](images/tab_button_group_t_0.png) + Tab Button Group控件。 ### 函数

@@ -22,17 +22,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### tab\_button\_group\_cast 函数 +* 函数原型： + +``` +widget_t* tab_button_group_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | tab\_button\_group对象。 | | widget | widget\_t* | tab\_button\_group对象。 | -

转换tab_button_group对象(供脚本语言使用)。 +* 函数功能： + +>

转换tab_button_group对象(供脚本语言使用)。 #### tab\_button\_group\_create 函数 +* 函数原型： + +``` +widget_t* tab_button_group_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -43,13 +61,15 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建tab_button_group对象 +* 函数功能： + +>

创建tab_button_group对象 #### compact 属性 ----------------------- -

紧凑型排版子控件。 +>

紧凑型排版子控件。 * 类型：bool\_t diff --git a/docs/manual/tab_button_t.md b/docs/manual/tab_button_t.md index 9ba9fb997e..6c484a765c 100644 --- a/docs/manual/tab_button_t.md +++ b/docs/manual/tab_button_t.md @@ -1,8 +1,8 @@ ## tab\_button\_t ### 概述 - 标签按钮控件。 ![image](images/tab_button_t_0.png) + 标签按钮控件。 ### 函数

@@ -29,17 +29,35 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(激活状态)即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值(激活状态)改变事件。 | #### tab\_button\_cast 函数 +* 函数原型： + +``` +widget_t* tab_button_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | tab\_button对象。 | | widget | widget\_t* | tab\_button对象。 | -

转换tab_button对象(供脚本语言使用)。 +* 函数功能： + +>

转换tab_button对象(供脚本语言使用)。 #### tab\_button\_create 函数 +* 函数原型： + +``` +widget_t* tab_button_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -50,11 +68,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建tab_button对象 +* 函数功能： + +>

创建tab_button对象 #### tab\_button\_set\_active\_icon 函数 +* 函数原型： + +``` +ret_t tab_button_set_active_icon (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -62,11 +90,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | tab\_button对象。 | | name | char* | 当前项的图标。 | -

设置控件的active图标。 +* 函数功能： + +>

设置控件的active图标。 #### tab\_button\_set\_icon 函数 +* 函数原型： + +``` +ret_t tab_button_set_icon (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -74,11 +112,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | tab\_button对象。 | | name | char* | 当前项的图标。 | -

设置控件的图标。 +* 函数功能： + +>

设置控件的图标。 #### tab\_button\_set\_value 函数 +* 函数原型： + +``` +ret_t tab_button_set_value (widget_t* widget, uint32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -86,13 +134,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | tab\_button对象。 | | value | uint32\_t | 值 | -

设置控件的值。 +* 函数功能： + +>

设置控件的值。 #### active\_icon 属性 ----------------------- -

当前项的图标的名称。 +>

当前项的图标的名称。 * 类型：char* @@ -109,7 +159,7 @@ | 支通过widget_set_prop修改 | 是 | #### icon 属性 ----------------------- -

非当前项的图标的名称。 +>

非当前项的图标的名称。 * 类型：char* @@ -126,7 +176,7 @@ | 支通过widget_set_prop修改 | 是 | #### value 属性 ----------------------- -

值。 +>

值。 * 类型：bool\_t diff --git a/docs/manual/tab_control_t.md b/docs/manual/tab_control_t.md index b96e2e3c1d..bb5004e95f 100644 --- a/docs/manual/tab_control_t.md +++ b/docs/manual/tab_control_t.md @@ -1,8 +1,8 @@ ## tab\_control\_t ### 概述 - 标签控件。 ![image](images/tab_control_t_0.png) + 标签控件。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### tab\_control\_cast 函数 +* 函数原型： + +``` +widget_t* tab_control_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | tab\_control对象。 | | widget | widget\_t* | tab\_control对象。 | -

转换tab_control对象(供脚本语言使用)。 +* 函数功能： + +>

转换tab_control对象(供脚本语言使用)。 #### tab\_control\_create 函数 +* 函数原型： + +``` +widget_t* tab_control_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建tab_control对象 +* 函数功能： + +>

创建tab_control对象 diff --git a/docs/manual/text_selector_t.md b/docs/manual/text_selector_t.md index 391b56edbb..6d27212642 100644 --- a/docs/manual/text_selector_t.md +++ b/docs/manual/text_selector_t.md @@ -1,9 +1,9 @@ ## text\_selector\_t ### 概述 - 文本选择器控件，通常用于选择年月日等。 - XXX: 目前需要先设置options和visible_nr，再设置其它参数(在XML中也需要按此顺序)。 ![image](images/text_selector_t_0.png) + 文本选择器控件，通常用于选择年月日等。 + XXX: 目前需要先设置options和visible_nr，再设置其它参数(在XML中也需要按此顺序)。 ### 函数

@@ -39,6 +39,14 @@ | EVT\_VALUE\_WILL\_CHANGE | event\_t | 值(当前项)即将改变事件。 | | EVT\_VALUE\_CHANGED | event\_t | 值(当前项)改变事件。 | #### text\_selector\_append\_option 函数 +* 函数原型： + +``` +ret_t text_selector_append_option (widget_t* widget, int32_t value, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -47,33 +55,63 @@ | widget | widget\_t* | text\_selector对象。 | | value | int32\_t | 值。 | | text | char* | 文本。 | -

追加一个选项。 +* 函数功能： + +>

追加一个选项。 #### text\_selector\_cast 函数 +* 函数原型： + +``` +widget_t* text_selector_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | text\_selector对象。 | | widget | widget\_t* | text\_selector对象。 | -

转换text_selector对象(供脚本语言使用)。 +* 函数功能： + +>

转换text_selector对象(供脚本语言使用)。 #### text\_selector\_count\_options 函数 +* 函数原型： + +``` +int32_t text_selector_count_options (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int32\_t | 返回选项个数。 | | widget | widget\_t* | text\_selector对象。 | -

获取选项个数。 +* 函数功能： + +>

获取选项个数。 #### text\_selector\_create 函数 +* 函数原型： + +``` +widget_t* text_selector_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -84,11 +122,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建text_selector对象 +* 函数功能： + +>

创建text_selector对象 #### text\_selector\_get\_option 函数 +* 函数原型： + +``` +text_selector_option_t* text_selector_get_option (widget_t* widget, uint32_t index); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -96,44 +144,84 @@ | 返回值 | text\_selector\_option\_t* | 成功返回选项，失败返回NULL。 | | widget | widget\_t* | text\_selector对象。 | | index | uint32\_t | 选项的索引。 | -

获取第index个选项。 +* 函数功能： + +>

获取第index个选项。 #### text\_selector\_get\_text 函数 +* 函数原型： + +``` +char* text_selector_get_text (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | char* | 返回文本。 | | widget | widget\_t* | text\_selector对象。 | -

获取text_selector的文本。 +* 函数功能： + +>

获取text_selector的文本。 #### text\_selector\_get\_value 函数 +* 函数原型： + +``` +int32_t text_selector_get_value (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int32\_t | 返回值。 | | widget | widget\_t* | text\_selector对象。 | -

获取text_selector的值。 +* 函数功能： + +>

获取text_selector的值。 #### text\_selector\_reset\_options 函数 +* 函数原型： + +``` +ret_t text_selector_reset_options (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | text\_selector对象。 | -

重置所有选项。 +* 函数功能： + +>

重置所有选项。 #### text\_selector\_set\_options 函数 +* 函数原型： + +``` +ret_t text_selector_set_options (widget_t* widget, char* options); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -141,11 +229,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | text\_selector对象。 | | options | char* | 选项。 | -

设置选项。 +* 函数功能： + +>

设置选项。 #### text\_selector\_set\_range\_options 函数 +* 函数原型： + +``` +ret_t text_selector_set_range_options (widget_t* widget, int32_t start, uint32_t nr, int32_t step); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -155,11 +253,21 @@ | start | int32\_t | 起始值。 | | nr | uint32\_t | 个数。 | | step | int32\_t | 步长。 | -

设置一系列的整数选项。 +* 函数功能： + +>

设置一系列的整数选项。 #### text\_selector\_set\_selected\_index 函数 +* 函数原型： + +``` +ret_t text_selector_set_selected_index (widget_t* widget, uint32_t index); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -167,11 +275,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | text\_selector对象。 | | index | uint32\_t | 选项的索引。 | -

设置第index个选项为当前选中的选项。 +* 函数功能： + +>

设置第index个选项为当前选中的选项。 #### text\_selector\_set\_text 函数 +* 函数原型： + +``` +ret_t text_selector_set_text (widget_t* widget, const char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -179,11 +297,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | text\_selector对象。 | | text | const char* | 文本。 | -

设置text_selector的文本。 +* 函数功能： + +>

设置text_selector的文本。 #### text\_selector\_set\_value 函数 +* 函数原型： + +``` +ret_t text_selector_set_value (widget_t* widget, int32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -191,11 +319,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | text\_selector对象。 | | value | int32\_t | 值。 | -

设置text_selector的值。 +* 函数功能： + +>

设置text_selector的值。 #### text\_selector\_set\_visible\_nr 函数 +* 函数原型： + +``` +ret_t text_selector_set_visible_nr (widget_t* widget, uint32_t visible_nr); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -203,13 +341,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | text\_selector对象。 | | visible\_nr | uint32\_t | 选项数。 | -

设置可见的选项数。 +* 函数功能： + +>

设置可见的选项数。 #### options 属性 ----------------------- -

设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。 +>

设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。 对于数值选项，也可以指定一个范围，用『-』分隔起始值和结束值，如："1-7"表示1到7。 @@ -227,7 +367,7 @@ | 支通过widget_set_prop修改 | 是 | #### selected\_index 属性 ----------------------- -

当前选中的选项。 +>

当前选中的选项。 * 类型：int32\_t @@ -244,7 +384,7 @@ | 支通过widget_set_prop修改 | 是 | #### visible\_nr 属性 ----------------------- -

可见的选项数量(只能是3或者5，缺省为5)。 +>

可见的选项数量(只能是3或者5，缺省为5)。 * 类型：uint32\_t diff --git a/docs/manual/theme_t.md b/docs/manual/theme_t.md index 7d8470cd3f..308f391ec8 100644 --- a/docs/manual/theme_t.md +++ b/docs/manual/theme_t.md @@ -25,52 +25,100 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### theme 函数 +* 函数原型： + +``` +theme_t* theme (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | theme\_t* | 返回主题对象。 | -

获取缺省的主题对象。 +* 函数功能： + +>

获取缺省的主题对象。 #### theme\_create 函数 +* 函数原型： + +``` +theme_t* theme_create (const uint8_t* data); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | theme\_t* | 返回主题对象。 | | data | const uint8\_t* | 主题数据。 | -

创建主题对象。 +* 函数功能： + +>

创建主题对象。 #### theme\_deinit 函数 +* 函数原型： + +``` +ret_t theme_deinit (theme_t* theme); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | theme | theme\_t* | 主题对象。 | -

析构主题对象。 +* 函数功能： + +>

析构主题对象。 #### theme\_destroy 函数 +* 函数原型： + +``` +ret_t theme_destroy (theme_t* theme); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | theme | theme\_t* | 主题对象。 | -

析构并释放主题对象。 +* 函数功能： + +>

析构并释放主题对象。 #### theme\_find\_style 函数 +* 函数原型： + +``` +theme_t* theme_find_style (theme_t* data, const char* widget_type, const char* name, widget_state_t widget_state); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -80,12 +128,22 @@ | widget\_type | const char* | 控件的类型名。 | | name | const char* | style的名称。 | | widget\_state | widget\_state\_t | 控件的状态。 | -

查找满足条件的style。 +* 函数功能： + +>

查找满足条件的style。 #### theme\_init 函数 +* 函数原型： + +``` +theme_t* theme_init (theme_t* theme, const uint8_t* data); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -93,19 +151,31 @@ | 返回值 | theme\_t* | 返回主题对象。 | | theme | theme\_t* | 主题对象。 | | data | const uint8\_t* | 主题数据。 | -

初始化主题对象。 +* 函数功能： + +>

初始化主题对象。 #### theme\_set 函数 +* 函数原型： + +``` +ret_t theme_set (theme_t* theme); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | theme | theme\_t* | 主题对象。 | -

设置缺省的主题对象。 +* 函数功能： + +>

设置缺省的主题对象。 diff --git a/docs/manual/thread_t.md b/docs/manual/thread_t.md index e35d2c9d92..9fb442f0d6 100644 --- a/docs/manual/thread_t.md +++ b/docs/manual/thread_t.md @@ -22,48 +22,88 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### thread\_create 函数 +* 函数原型： + +``` +thread_t* thread_create (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | thread\_t* | thread对象。 | -

创建thread对象。 +* 函数功能： + +>

创建thread对象。 #### thread\_destroy 函数 +* 函数原型： + +``` +ret_t thread_destroy (thread_t* thread); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | thread | thread\_t* | thread对象。 | -

销毁thread对象。 +* 函数功能： + +>

销毁thread对象。 #### thread\_join 函数 +* 函数原型： + +``` +ret_t thread_join (thread_t* thread); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | thread | thread\_t* | thread对象。 | -

等待线程退出。 +* 函数功能： + +>

等待线程退出。 #### thread\_start 函数 +* 函数原型： + +``` +ret_t thread_start (thread_t* thread); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | thread | thread\_t* | thread对象。 | -

启动线程。 +* 函数功能： + +>

启动线程。 diff --git a/docs/manual/time_clock_t.md b/docs/manual/time_clock_t.md index a0634aaed0..e45a472e84 100644 --- a/docs/manual/time_clock_t.md +++ b/docs/manual/time_clock_t.md @@ -1,8 +1,8 @@ ## time\_clock\_t ### 概述 - 时钟控件。 ![image](images/time_clock_t_0.png) + 时钟控件。 ### 函数

@@ -37,17 +37,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### time\_clock\_cast 函数 +* 函数原型： + +``` +widget_t* time_clock_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | time\_clock对象。 | | widget | widget\_t* | time\_clock对象。 | -

转换为time_clock对象(供脚本语言使用)。 +* 函数功能： + +>

转换为time_clock对象(供脚本语言使用)。 #### time\_clock\_create 函数 +* 函数原型： + +``` +widget_t* time_clock_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -58,11 +76,21 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建time_clock对象 +* 函数功能： + +>

创建time_clock对象 #### time\_clock\_set\_bg\_image 函数 +* 函数原型： + +``` +ret_t time_clock_set_bg_image (widget_t* widget, const char* bg_image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -70,11 +98,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | bg\_image | const char* | 背景图片。 | -

设置背景图片。 +* 函数功能： + +>

设置背景图片。 #### time\_clock\_set\_hour 函数 +* 函数原型： + +``` +ret_t time_clock_set_hour (widget_t* widget, int32_t hour); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -82,11 +120,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | hour | int32\_t | 小时的值。 | -

设置小时的值。 +* 函数功能： + +>

设置小时的值。 #### time\_clock\_set\_hour\_image 函数 +* 函数原型： + +``` +ret_t time_clock_set_hour_image (widget_t* widget, const char* hour); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -94,11 +142,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | hour | const char* | 小时的图片。 | -

设置小时的图片。 +* 函数功能： + +>

设置小时的图片。 #### time\_clock\_set\_image 函数 +* 函数原型： + +``` +ret_t time_clock_set_image (widget_t* widget, const char* image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -106,11 +164,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | image | const char* | 图片。 | -

设置图片。 +* 函数功能： + +>

设置图片。 #### time\_clock\_set\_minute 函数 +* 函数原型： + +``` +ret_t time_clock_set_minute (widget_t* widget, int32_t minute); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -118,11 +186,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | minute | int32\_t | 分钟的值。 | -

设置分钟的值。 +* 函数功能： + +>

设置分钟的值。 #### time\_clock\_set\_minute\_image 函数 +* 函数原型： + +``` +ret_t time_clock_set_minute_image (widget_t* widget, const char* minute_image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -130,11 +208,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | minute\_image | const char* | 分钟的图片。 | -

设置分钟的图片。 +* 函数功能： + +>

设置分钟的图片。 #### time\_clock\_set\_second 函数 +* 函数原型： + +``` +ret_t time_clock_set_second (widget_t* widget, int32_t second); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -142,11 +230,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | second | int32\_t | 秒的值。 | -

设置秒的值。 +* 函数功能： + +>

设置秒的值。 #### time\_clock\_set\_second\_image 函数 +* 函数原型： + +``` +ret_t time_clock_set_second_image (widget_t* widget, const char* second_image); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -154,13 +252,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | second\_image | const char* | 秒的图片。 | -

设置秒的图片。 +* 函数功能： + +>

设置秒的图片。 #### bg\_image 属性 ----------------------- -

背景图片。 +>

背景图片。 * 类型：char* @@ -177,7 +277,7 @@ | 支通过widget_set_prop修改 | 是 | #### hour 属性 ----------------------- -

小时。 +>

小时。 * 类型：int32\_t @@ -194,7 +294,7 @@ | 支通过widget_set_prop修改 | 是 | #### hour\_image 属性 ----------------------- -

时针图片。 +>

时针图片。 * 类型：char* @@ -211,7 +311,7 @@ | 支通过widget_set_prop修改 | 是 | #### image 属性 ----------------------- -

中心图片。 +>

中心图片。 * 类型：char* @@ -228,7 +328,7 @@ | 支通过widget_set_prop修改 | 是 | #### minute 属性 ----------------------- -

分钟。 +>

分钟。 * 类型：int32\_t @@ -245,7 +345,7 @@ | 支通过widget_set_prop修改 | 是 | #### minute\_image 属性 ----------------------- -

分针图片。 +>

分针图片。 * 类型：char* @@ -262,7 +362,7 @@ | 支通过widget_set_prop修改 | 是 | #### second 属性 ----------------------- -

秒。 +>

秒。 * 类型：int32\_t @@ -279,7 +379,7 @@ | 支通过widget_set_prop修改 | 是 | #### second\_image 属性 ----------------------- -

秒针图片。 +>

秒针图片。 * 类型：char* diff --git a/docs/manual/time_now_t.md b/docs/manual/time_now_t.md index 6fc237edc1..c82f51badc 100644 --- a/docs/manual/time_now_t.md +++ b/docs/manual/time_now_t.md @@ -22,23 +22,43 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### time\_now\_ms 函数 +* 函数原型： + +``` +uint32_t time_now_ms (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint32\_t | 返回当前时间(毫秒)。 | -

获取当前时间(毫秒)。 +* 函数功能： + +>

获取当前时间(毫秒)。 #### time\_now\_s 函数 +* 函数原型： + +``` +uint32_t time_now_s (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint32\_t | 返回当前时间(秒)。 | -

获取当前时间(秒)。 +* 函数功能： + +>

获取当前时间(秒)。 diff --git a/docs/manual/timer_t.md b/docs/manual/timer_t.md index 7147417d6a..cd19084c22 100644 --- a/docs/manual/timer_t.md +++ b/docs/manual/timer_t.md @@ -25,6 +25,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### timer\_add 函数 +* 函数原型： + +``` +uint32_t timer_add (timer_func_t on_timer, void* ctx, uint32_t duration_ms); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -33,45 +41,85 @@ | on\_timer | timer\_func\_t | timer回调函数。 | | ctx | void* | timer回调函数的上下文。 | | duration\_ms | uint32\_t | 时间。 | -

增加一个timer。 +* 函数功能： + +>

增加一个timer。 #### timer\_count 函数 +* 函数原型： + +``` +uint32_t timer_count (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint32\_t | 返回timer的个数。 | -

返回timer的个数。 +* 函数功能： + +>

返回timer的个数。 #### timer\_next\_time 函数 +* 函数原型： + +``` +uint32_t timer_next_time (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint32\_t | 返回最近的timer到期时间。 | -

返回最近的timer到期时间。 +* 函数功能： + +>

返回最近的timer到期时间。 #### timer\_now 函数 +* 函数原型： + +``` +uint32_t timer_now (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint32\_t | 返回获取当前时间(ms)。 | -

获取当前时间(ms)。 +* 函数功能： + +>

获取当前时间(ms)。 #### timer\_queue 函数 +* 函数原型： + +``` +ret_t timer_queue (timer_func_t , void* ctx, uint32_t duration_ms); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -80,25 +128,45 @@ | | timer\_func\_t | r | | ctx | void* | timer回调函数的上下文。 | | duration\_ms | uint32\_t | 时间。 | -

用于非GUI线程增加一个timer，本函数向主循环的事件队列中发送一个增加timer的请求。 +* 函数功能： + +>

用于非GUI线程增加一个timer，本函数向主循环的事件队列中发送一个增加timer的请求。 timer回调函数，回调函数返回RET_REPEAT，则下次继续执行，否则自动移出。 #### timer\_remove 函数 +* 函数原型： + +``` +ret_t timer_remove (uint32_t timer_id); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | timer\_id | uint32\_t | timerID。 | -

删除指定的timer。 +* 函数功能： + +>

删除指定的timer。 #### timer\_set\_on\_destroy 函数 +* 函数原型： + +``` +ret_t timer_set_on_destroy (uint32_t timer_id, tk_destroy_t on_destroy, void* on_destroy_ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -107,7 +175,9 @@ | timer\_id | uint32\_t | timerID。 | | on\_destroy | tk\_destroy\_t | 回调函数。 | | on\_destroy\_ctx | void* | 回调函数上下文。 | -

设置一个回调函数，在timer被销毁时调用(方便脚本语言去释放回调函数)。 +* 函数功能： + +>

设置一个回调函数，在timer被销毁时调用(方便脚本语言去释放回调函数)。 diff --git a/docs/manual/tk_mutex_t.md b/docs/manual/tk_mutex_t.md index f9ee49745d..3f8e042b06 100644 --- a/docs/manual/tk_mutex_t.md +++ b/docs/manual/tk_mutex_t.md @@ -22,48 +22,88 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### tk\_mutex\_create 函数 +* 函数原型： + +``` +tk_mutex_t* tk_mutex_create (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | tk\_mutex\_t* | mutex对象。 | -

创建mutex。 +* 函数功能： + +>

创建mutex。 #### tk\_mutex\_destroy 函数 +* 函数原型： + +``` +ret_t tk_mutex_destroy (tk_mutex_t* mutex); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | mutex | tk\_mutex\_t* | mutex对象。 | -

销毁mutex对象。 +* 函数功能： + +>

销毁mutex对象。 #### tk\_mutex\_lock 函数 +* 函数原型： + +``` +ret_t tk_mutex_lock (tk_mutex_t* mutex); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | mutex | tk\_mutex\_t* | mutex对象。 | -

加锁。 +* 函数功能： + +>

加锁。 #### tk\_mutex\_unlock 函数 +* 函数原型： + +``` +ret_t tk_mutex_unlock (tk_mutex_t* mutex); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | mutex | tk\_mutex\_t* | mutex对象。 | -

解锁。 +* 函数功能： + +>

解锁。 diff --git a/docs/manual/tk_t.md b/docs/manual/tk_t.md index d166de91a8..8e265c8066 100644 --- a/docs/manual/tk_t.md +++ b/docs/manual/tk_t.md @@ -22,6 +22,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### tk\_init 函数 +* 函数原型： + +``` +ret_t tk_init (wh_t w, wh_t h, app_type_t app_type, const char* app_name, const char* app_root); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -32,41 +40,73 @@ | app\_type | app\_type\_t | 应用程序的类型。 | | app\_name | const char* | 应用程序的名称(必须为常量字符串)。 | | app\_root | const char* | 应用程序的根目录，用于定位资源文件(必须为常量字符串)。 | -

初始化TK。 +* 函数功能： + +>

初始化TK。 #### tk\_quit 函数 +* 函数原型： + +``` +ret_t tk_quit (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | -

退出TK事件主循环。 +* 函数功能： + +>

退出TK事件主循环。 #### tk\_run 函数 +* 函数原型： + +``` +ret_t tk_run (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | -

进入TK事件主循环。 +* 函数功能： + +>

进入TK事件主循环。 #### tk\_set\_lcd\_orientation 函数 +* 函数原型： + +``` +ret_t tk_set_lcd_orientation (int orientation); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | orientation | int | 旋转方向。 | -

设置屏幕的旋转方向(XXX:目前仅支持0度和90度)。 +* 函数功能： + +>

设置屏幕的旋转方向(XXX:目前仅支持0度和90度)。 diff --git a/docs/manual/tokenizer_t.md b/docs/manual/tokenizer_t.md index 04abff0df3..13c94b4875 100644 --- a/docs/manual/tokenizer_t.md +++ b/docs/manual/tokenizer_t.md @@ -28,30 +28,58 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### tokenizer\_deinit 函数 +* 函数原型： + +``` +ret_t tokenizer_deinit (tokenizer_t* tokenizer); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | tokenizer | tokenizer\_t* | tokenizer对象。 | -

重置tokenizer。 +* 函数功能： + +>

重置tokenizer。 #### tokenizer\_has\_more 函数 +* 函数原型： + +``` +bool_t tokenizer_has_more (tokenizer_t* tokenizer); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bool\_t | 还有下一个token返回TRUE，否则返回FALSE。 | | tokenizer | tokenizer\_t* | tokenizer对象。 | -

是否还有下一个token。 +* 函数功能： + +>

是否还有下一个token。 #### tokenizer\_init 函数 +* 函数原型： + +``` +tokenizer_t* tokenizer_init (tokenizer_t* tokenizer, char* str, uint32_t size, char* separtor); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -61,24 +89,44 @@ | str | char* | 要解析的字符串。 | | size | uint32\_t | 字符串长度。 | | separtor | char* | 分隔字符。 | -

初始化tokenizer对象。 +* 函数功能： + +>

初始化tokenizer对象。 #### tokenizer\_next 函数 +* 函数原型： + +``` +char* tokenizer_next (tokenizer_t* tokenizer); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | char* | 成功返回token，失败返回NULL。 | | tokenizer | tokenizer\_t* | tokenizer对象。 | -

获取下一个token。 +* 函数功能： + +>

获取下一个token。 #### tokenizer\_next\_float 函数 +* 函数原型： + +``` +char* tokenizer_next_float (tokenizer_t* tokenizer, float defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -86,12 +134,22 @@ | 返回值 | char* | 成功返回token的float值，失败返回缺省值。 | | tokenizer | tokenizer\_t* | tokenizer对象。 | | defval | float | 缺省值。 | -

获取下一个token，并转换成float。 +* 函数功能： + +>

获取下一个token，并转换成float。 #### tokenizer\_next\_int 函数 +* 函数原型： + +``` +char* tokenizer_next_int (tokenizer_t* tokenizer, int defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -99,14 +157,16 @@ | 返回值 | char* | 成功返回token的int值，失败返回缺省值。 | | tokenizer | tokenizer\_t* | tokenizer对象。 | | defval | int | 缺省值。 | -

获取下一个token，并转换成int。 +* 函数功能： + +>

获取下一个token，并转换成int。 #### cursor 属性 ----------------------- -

当前位置。 +>

当前位置。 @@ -124,7 +184,7 @@ | 支通过widget_set_prop修改 | 否 | #### separtor 属性 ----------------------- -

字符串。 +>

字符串。 @@ -142,7 +202,7 @@ | 支通过widget_set_prop修改 | 否 | #### size 属性 ----------------------- -

字符串的长度。 +>

字符串的长度。 @@ -160,7 +220,7 @@ | 支通过widget_set_prop修改 | 否 | #### str 属性 ----------------------- -

字符串。 +>

字符串。 diff --git a/docs/manual/value_t.md b/docs/manual/value_t.md index e5f3189fc8..db89f7151f 100644 --- a/docs/manual/value_t.md +++ b/docs/manual/value_t.md @@ -54,18 +54,36 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### value\_bool 函数 +* 函数原型： + +``` +bool_t value_bool (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bool\_t | 值。 | | v | value\_t* | value对象。 | -

获取类型为bool的值。 +* 函数功能： + +>

获取类型为bool的值。 #### value\_copy 函数 +* 函数原型： + +``` +void value_copy (value_t* dst, value_t* src); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -73,48 +91,88 @@ | 返回值 | void | 值。 | | dst | value\_t* | 目的value对象。 | | src | value\_t* | 源value对象。 | -

拷贝value的值。 +* 函数功能： + +>

拷贝value的值。 #### value\_create 函数 +* 函数原型： + +``` +value_t* value_create (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | value\_t* | 对象。 | -

创建value对象 +* 函数功能： + +>

创建value对象 #### value\_destroy 函数 +* 函数原型： + +``` +void value_destroy (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | void | | | v | value\_t* | value对象。 | -

@deconstructor +* 函数功能： + +>

@deconstructor 销毁value对象 #### value\_double 函数 +* 函数原型： + +``` +double value_double (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | double | 值。 | | v | value\_t* | value对象。 | -

获取类型为double的值。 +* 函数功能： + +>

获取类型为double的值。 #### value\_equal 函数 +* 函数原型： + +``` +bool_t value_equal (value_t* value, value_t* other); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -122,120 +180,220 @@ | 返回值 | bool\_t | 为空值返回TRUE，否则返回FALSE。 | | value | value\_t* | value对象。 | | other | value\_t* | value对象。 | -

判断两个value是否相同。 +* 函数功能： + +>

判断两个value是否相同。 #### value\_float 函数 +* 函数原型： + +``` +float value_float (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | float | 值。 | | v | value\_t* | value对象。 | -

获取类型为float的值。 +* 函数功能： + +>

获取类型为float的值。 #### value\_float32 函数 +* 函数原型： + +``` +float value_float32 (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | float | 值。 | | v | value\_t* | value对象。 | -

获取类型为float的值。 +* 函数功能： + +>

获取类型为float的值。 #### value\_int 函数 +* 函数原型： + +``` +int value_int (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int | 值。 | | v | value\_t* | value对象。 | -

转换为int的值。 +* 函数功能： + +>

转换为int的值。 #### value\_int16 函数 +* 函数原型： + +``` +int16_t value_int16 (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int16\_t | 值。 | | v | value\_t* | value对象。 | -

获取类型为int16的值。 +* 函数功能： + +>

获取类型为int16的值。 #### value\_int32 函数 +* 函数原型： + +``` +int32_t value_int32 (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int32\_t | 值。 | | v | value\_t* | value对象。 | -

获取类型为int32的值。 +* 函数功能： + +>

获取类型为int32的值。 #### value\_int64 函数 +* 函数原型： + +``` +int64_t value_int64 (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int64\_t | 值。 | | v | value\_t* | value对象。 | -

获取类型为int64的值。 +* 函数功能： + +>

获取类型为int64的值。 #### value\_int8 函数 +* 函数原型： + +``` +int8_t value_int8 (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int8\_t | 值。 | | v | value\_t* | value对象。 | -

获取类型为int8的值。 +* 函数功能： + +>

获取类型为int8的值。 #### value\_is\_null 函数 +* 函数原型： + +``` +bool_t value_is_null (value_t* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bool\_t | 为空值返回TRUE，否则返回FALSE。 | | value | value\_t* | value对象。 | -

判断value是否为空值。 +* 函数功能： + +>

判断value是否为空值。 #### value\_pointer 函数 +* 函数原型： + +``` +void* value_pointer (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | void* | 值。 | | v | value\_t* | value对象。 | -

获取类型为pointer的值。 +* 函数功能： + +>

获取类型为pointer的值。 #### value\_set\_bool 函数 +* 函数原型： + +``` +value_t* value_set_bool (value_t* v, bool_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -243,12 +401,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | bool\_t | 待设置的值。 | -

设置类型为bool的值。 +* 函数功能： + +>

设置类型为bool的值。 #### value\_set\_double 函数 +* 函数原型： + +``` +value_t* value_set_double (value_t* v, double value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -256,12 +424,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | double | 待设置的值。 | -

设置类型为double的值。 +* 函数功能： + +>

设置类型为double的值。 #### value\_set\_float 函数 +* 函数原型： + +``` +value_t* value_set_float (value_t* v, float_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -269,12 +447,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | float\_t | 待设置的值。 | -

设置类型为float的值。 +* 函数功能： + +>

设置类型为float的值。 #### value\_set\_float32 函数 +* 函数原型： + +``` +value_t* value_set_float32 (value_t* v, float value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -282,12 +470,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | float | 待设置的值。 | -

设置类型为float的值。 +* 函数功能： + +>

设置类型为float的值。 #### value\_set\_int 函数 +* 函数原型： + +``` +value_t* value_set_int (value_t* v, int32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -295,12 +493,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | int32\_t | 待设置的值。 | -

设置类型为int的值。 +* 函数功能： + +>

设置类型为int的值。 #### value\_set\_int16 函数 +* 函数原型： + +``` +value_t* value_set_int16 (value_t* v, int16_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -308,12 +516,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | int16\_t | 待设置的值。 | -

设置类型为int16的值。 +* 函数功能： + +>

设置类型为int16的值。 #### value\_set\_int32 函数 +* 函数原型： + +``` +value_t* value_set_int32 (value_t* v, int32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -321,12 +539,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | int32\_t | 待设置的值。 | -

设置类型为int32的值。 +* 函数功能： + +>

设置类型为int32的值。 #### value\_set\_int64 函数 +* 函数原型： + +``` +value_t* value_set_int64 (value_t* v, int64_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -334,12 +562,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | int64\_t | 待设置的值。 | -

设置类型为int64的值。 +* 函数功能： + +>

设置类型为int64的值。 #### value\_set\_int8 函数 +* 函数原型： + +``` +value_t* value_set_int8 (value_t* v, int8_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -347,12 +585,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | int8\_t | 待设置的值。 | -

设置类型为int8的值。 +* 函数功能： + +>

设置类型为int8的值。 #### value\_set\_pointer 函数 +* 函数原型： + +``` +value_t* value_set_pointer (value_t* v, pointer_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -360,12 +608,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | pointer\_t | 待设置的值。 | -

设置类型为pointer的值。 +* 函数功能： + +>

设置类型为pointer的值。 #### value\_set\_str 函数 +* 函数原型： + +``` +value_t* value_set_str (value_t* v, char* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -373,12 +631,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | char* | 待设置的值。 | -

设置类型为char*的值。 +* 函数功能： + +>

设置类型为char*的值。 #### value\_set\_uint16 函数 +* 函数原型： + +``` +value_t* value_set_uint16 (value_t* v, uint16_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -386,12 +654,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | uint16\_t | 待设置的值。 | -

设置类型为uint16的值。 +* 函数功能： + +>

设置类型为uint16的值。 #### value\_set\_uint32 函数 +* 函数原型： + +``` +value_t* value_set_uint32 (value_t* v, uint32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -399,12 +677,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | uint32\_t | 待设置的值。 | -

设置类型为uint32的值。 +* 函数功能： + +>

设置类型为uint32的值。 #### value\_set\_uint64 函数 +* 函数原型： + +``` +value_t* value_set_uint64 (value_t* v, uint64_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -412,12 +700,22 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | uint64\_t | 待设置的值。 | -

设置类型为uint64的值。 +* 函数功能： + +>

设置类型为uint64的值。 #### value\_set\_uint8 函数 +* 函数原型： + +``` +value_t* value_set_uint8 (value_t* v, uint8_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -425,74 +723,126 @@ | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | uint8\_t | 待设置的值。 | -

设置类型为uint8的值。 +* 函数功能： + +>

设置类型为uint8的值。 #### value\_str 函数 +* 函数原型： + +``` +const char* value_str (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | const char* | 值。 | | v | value\_t* | value对象。 | -

获取类型为str_t的值。 +* 函数功能： + +>

获取类型为str_t的值。 #### value\_uint16 函数 +* 函数原型： + +``` +uint16_t value_uint16 (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint16\_t | 值。 | | v | value\_t* | value对象。 | -

获取类型为uint16的值。 +* 函数功能： + +>

获取类型为uint16的值。 #### value\_uint32 函数 +* 函数原型： + +``` +uint32_t value_uint32 (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint32\_t | 值。 | | v | value\_t* | value对象。 | -

获取类型为uint32的值。 +* 函数功能： + +>

获取类型为uint32的值。 #### value\_uint64 函数 +* 函数原型： + +``` +uint64_t value_uint64 (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | uint64\_t | 值。 | | v | value\_t* | value对象。 | -

获取类型为uint64的值。 +* 函数功能： + +>

获取类型为uint64的值。 #### value\_uint8 函数 +* 函数原型： + +``` +int8_t value_uint8 (value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int8\_t | 值。 | | v | value\_t* | value对象。 | -

获取类型为uint8的值。 +* 函数功能： + +>

获取类型为uint8的值。 #### type 属性 ----------------------- -

类型。 +>

类型。 diff --git a/docs/manual/vgcanvas_t.md b/docs/manual/vgcanvas_t.md index b9913e92b9..dba24d407f 100644 --- a/docs/manual/vgcanvas_t.md +++ b/docs/manual/vgcanvas_t.md @@ -84,6 +84,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### vgcanvas\_arc 函数 +* 函数原型： + +``` +ret_t vgcanvas_arc (vgcanvas_t* vg, float_t x, float_t y, float_t r, float_t start_angle, float_t end_angle, bool_t ccw); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -96,12 +104,22 @@ | start\_angle | float\_t | 起始角度。 | | end\_angle | float\_t | 结束角度。 | | ccw | bool\_t | 是否逆时针。 | -

arc +* 函数功能： + +>

arc #### vgcanvas\_arc\_to 函数 +* 函数原型： + +``` +ret_t vgcanvas_arc_to (vgcanvas_t* vg, float_t x1, float_t y1, float_t x2, float_t y2, float_t r); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -113,12 +131,22 @@ | x2 | float\_t | 结束点x坐标。 | | y2 | float\_t | 结束点y坐标。 | | r | float\_t | 半径。 | -

arc to +* 函数功能： + +>

arc to #### vgcanvas\_begin\_frame 函数 +* 函数原型： + +``` +ret_t vgcanvas_begin_frame (vgcanvas_t* vg, rect_t* dirty_rect); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -126,24 +154,44 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | dirty\_rect | rect\_t* | 需要绘制的区域。 | -

开始绘制，系统内部调用。 +* 函数功能： + +>

开始绘制，系统内部调用。 #### vgcanvas\_begin\_path 函数 +* 函数原型： + +``` +ret_t vgcanvas_begin_path (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

begin path +* 函数功能： + +>

begin path #### vgcanvas\_bezier\_to 函数 +* 函数原型： + +``` +ret_t vgcanvas_bezier_to (vgcanvas_t* vg, float_t cp1x, float_t cp1y, float_t cp2x, float_t cp2y, float_t x, float_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -156,12 +204,22 @@ | cp2y | float\_t | 控制点3y坐标。 | | x | float\_t | x坐标。 | | y | float\_t | y坐标。 | -

bezier curve to +* 函数功能： + +>

bezier curve to #### vgcanvas\_clear\_rect 函数 +* 函数原型： + +``` +ret_t vgcanvas_clear_rect (vgcanvas_t* vg, float_t x, float_t y, float_t w, float_t h, color_t c); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -173,12 +231,22 @@ | w | float\_t | 宽度。 | | h | float\_t | 高度。 | | c | color\_t | 颜色。 | -

clear rect +* 函数功能： + +>

clear rect #### vgcanvas\_clip\_rect 函数 +* 函数原型： + +``` +ret_t vgcanvas_clip_rect (vgcanvas_t* vg, float_t x, float_t y, float_t w, float_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -189,24 +257,44 @@ | y | float\_t | y坐标。 | | w | float\_t | 宽度。 | | h | float\_t | 高度。 | -

clip_rect +* 函数功能： + +>

clip_rect #### vgcanvas\_close\_path 函数 +* 函数原型： + +``` +ret_t vgcanvas_close_path (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

close_path +* 函数功能： + +>

close_path #### vgcanvas\_create 函数 +* 函数原型： + +``` +vgcanvas_t vgcanvas_create (uint32_t w, uint32_t h, uint32_t stride, bitmap_format_t format, void* data); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -217,24 +305,44 @@ | stride | uint32\_t | 一行占用的字节数。 | | format | bitmap\_format\_t | 如果data是framebuffer，format指定data的格式。 | | data | void* | framebuffer或其它ctx。 | -

创建vgcanvas。 +* 函数功能： + +>

创建vgcanvas。 #### vgcanvas\_destroy 函数 +* 函数原型： + +``` +ret_t vgcanvas_destroy (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

destroy +* 函数功能： + +>

destroy #### vgcanvas\_draw\_icon 函数 +* 函数原型： + +``` +ret_t vgcanvas_draw_icon (vgcanvas_t* vg, bitmap_t* img, float_t sx, float_t sy, float_t sw, float_t sh, float_t dx, float_t dy, float_t dw, float_t dh); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -250,12 +358,22 @@ | dy | float\_t | dy | | dw | float\_t | dw | | dh | float\_t | dh | -

draw icon +* 函数功能： + +>

draw icon #### vgcanvas\_draw\_image 函数 +* 函数原型： + +``` +ret_t vgcanvas_draw_image (vgcanvas_t* vg, bitmap_t* img, float_t sx, float_t sy, float_t sw, float_t sh, float_t dx, float_t dy, float_t dw, float_t dh); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -271,12 +389,22 @@ | dy | float\_t | dy | | dw | float\_t | dw | | dh | float\_t | dh | -

draw image +* 函数功能： + +>

draw image #### vgcanvas\_ellipse 函数 +* 函数原型： + +``` +ret_t vgcanvas_ellipse (vgcanvas_t* vg, float_t x, float_t y, float_t rx, float_t ry); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -287,36 +415,66 @@ | y | float\_t | y坐标。 | | rx | float\_t | 圆角半径。 | | ry | float\_t | 圆角半径。 | -

ellipse +* 函数功能： + +>

ellipse #### vgcanvas\_end\_frame 函数 +* 函数原型： + +``` +ret_t vgcanvas_end_frame (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

结束绘制。系统内部调用。 +* 函数功能： + +>

结束绘制。系统内部调用。 #### vgcanvas\_fill 函数 +* 函数原型： + +``` +ret_t vgcanvas_fill (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

填充多边形。 +* 函数功能： + +>

填充多边形。 #### vgcanvas\_fill\_text 函数 +* 函数原型： + +``` +ret_t vgcanvas_fill_text (vgcanvas_t* vg, char* text, float_t x, float_t y, float_t max_width); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -327,24 +485,44 @@ | x | float\_t | x坐标。 | | y | float\_t | y坐标。 | | max\_width | float\_t | 最大宽度。 | -

fill text +* 函数功能： + +>

fill text #### vgcanvas\_flush 函数 +* 函数原型： + +``` +ret_t vgcanvas_flush (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

flush +* 函数功能： + +>

flush #### vgcanvas\_is\_point\_in\_path 函数 +* 函数原型： + +``` +bool_t vgcanvas_is_point_in_path (vgcanvas_t* vg, float_t x, float_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -353,12 +531,22 @@ | vg | vgcanvas\_t* | vgcanvas对象。 | | x | float\_t | x坐标。 | | y | float\_t | y坐标。 | -

检查点是否在当前路径中。 +* 函数功能： + +>

检查点是否在当前路径中。 #### vgcanvas\_line\_to 函数 +* 函数原型： + +``` +ret_t vgcanvas_line_to (vgcanvas_t* vg, float_t x, float_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -367,12 +555,22 @@ | vg | vgcanvas\_t* | vgcanvas对象。 | | x | float\_t | x坐标。 | | y | float\_t | y坐标。 | -

line to。 +* 函数功能： + +>

line to。 #### vgcanvas\_measure\_text 函数 +* 函数原型： + +``` +float_t vgcanvas_measure_text (vgcanvas_t* vg, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -380,12 +578,22 @@ | 返回值 | float\_t | 返回text的宽度。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | text | char* | text | -

measure text +* 函数功能： + +>

measure text #### vgcanvas\_move\_to 函数 +* 函数原型： + +``` +ret_t vgcanvas_move_to (vgcanvas_t* vg, float_t x, float_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -394,12 +602,22 @@ | vg | vgcanvas\_t* | vgcanvas对象。 | | x | float\_t | x坐标。 | | y | float\_t | y坐标。 | -

move to +* 函数功能： + +>

move to #### vgcanvas\_paint 函数 +* 函数原型： + +``` +ret_t vgcanvas_paint (vgcanvas_t* vg, bool_t stroke, bitmap_t* img); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -408,13 +626,23 @@ | vg | vgcanvas\_t* | vgcanvas对象。 | | stroke | bool\_t | TRUE表示画线FALSE表示填充。 | | img | bitmap\_t* | 图片。 | -

用图片填充/画多边形(可能存在可移植性问题，除非必要请勿使用)。 +* 函数功能： + +>

用图片填充/画多边形(可能存在可移植性问题，除非必要请勿使用)。 多边形的顶点必须在图片范围内，可以通过矩阵变化画到不同的位置。 #### vgcanvas\_quad\_to 函数 +* 函数原型： + +``` +ret_t vgcanvas_quad_to (vgcanvas_t* vg, float_t cpx, float_t cpy, float_t x, float_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -425,12 +653,22 @@ | cpy | float\_t | 控制点y坐标。 | | x | float\_t | x坐标。 | | y | float\_t | y坐标。 | -

quadratic curve to +* 函数功能： + +>

quadratic curve to #### vgcanvas\_rect 函数 +* 函数原型： + +``` +ret_t vgcanvas_rect (vgcanvas_t* vg, float_t x, float_t y, float_t w, float_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -441,12 +679,22 @@ | y | float\_t | y坐标。 | | w | float\_t | 宽度。 | | h | float\_t | 高度。 | -

rect +* 函数功能： + +>

rect #### vgcanvas\_reinit 函数 +* 函数原型： + +``` +ret_t vgcanvas_reinit (vgcanvas_t* vg, uint32_t w, uint32_t h, uint32_t stride, bitmap_format_t format, void* data); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -458,36 +706,66 @@ | stride | uint32\_t | 一行占用的字节数。 | | format | bitmap\_format\_t | 如果data是framebuffer，format指定data的格式。 | | data | void* | framebuffer或其它ctx。 | -

重新初始化，系统内部调用。 +* 函数功能： + +>

重新初始化，系统内部调用。 #### vgcanvas\_reset 函数 +* 函数原型： + +``` +ret_t vgcanvas_reset (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

reset +* 函数功能： + +>

reset #### vgcanvas\_restore 函数 +* 函数原型： + +``` +ret_t vgcanvas_restore (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

restore +* 函数功能： + +>

restore #### vgcanvas\_rotate 函数 +* 函数原型： + +``` +ret_t vgcanvas_rotate (vgcanvas_t* vg, float_t rad); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -495,12 +773,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | rad | float\_t | 角度 | -

rotate +* 函数功能： + +>

rotate #### vgcanvas\_rounded\_rect 函数 +* 函数原型： + +``` +ret_t vgcanvas_rounded_rect (vgcanvas_t* vg, float_t x, float_t y, float_t w, float_t h, float_t r); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -512,24 +800,44 @@ | w | float\_t | 宽度。 | | h | float\_t | 高度。 | | r | float\_t | 圆角半径。 | -

round rect +* 函数功能： + +>

round rect #### vgcanvas\_save 函数 +* 函数原型： + +``` +ret_t vgcanvas_save (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

save +* 函数功能： + +>

save #### vgcanvas\_scale 函数 +* 函数原型： + +``` +ret_t vgcanvas_scale (vgcanvas_t* vg, float_t x, float_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -538,12 +846,22 @@ | vg | vgcanvas\_t* | vgcanvas对象。 | | x | float\_t | x方向缩放比例。 | | y | float\_t | y方向缩放比例。 | -

scale +* 函数功能： + +>

scale #### vgcanvas\_set\_antialias 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_antialias (vgcanvas_t* vg, bool_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -551,12 +869,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | value | bool\_t | 是否启用反走样。 | -

set antialias +* 函数功能： + +>

set antialias #### vgcanvas\_set\_fill\_color 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_fill_color (vgcanvas_t* vg, color_t color); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -564,12 +892,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | color | color\_t | 颜色。 | -

set fill color +* 函数功能： + +>

set fill color #### vgcanvas\_set\_font 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_font (vgcanvas_t* vg, char* font); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -577,12 +915,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | font | char* | 字体名称。 | -

set font +* 函数功能： + +>

set font #### vgcanvas\_set\_font\_size 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_font_size (vgcanvas_t* vg, float_t font); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -590,12 +938,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | font | float\_t | 字体大小。 | -

set font size +* 函数功能： + +>

set font size #### vgcanvas\_set\_global\_alpha 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_global_alpha (vgcanvas_t* vg, float_t alpha); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -603,12 +961,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | alpha | float\_t | global alpha。 | -

set global alpha +* 函数功能： + +>

set global alpha #### vgcanvas\_set\_line\_cap 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_line_cap (vgcanvas_t* vg, char* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -616,12 +984,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | value | char* | 取值：butt|round|square，必须为常量字符串。 | -

set line cap +* 函数功能： + +>

set line cap #### vgcanvas\_set\_line\_join 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_line_join (vgcanvas_t* vg, char* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -629,12 +1007,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | value | char* | 取值：bevel|round|miter，必须为常量字符串。 | -

set line join +* 函数功能： + +>

set line join #### vgcanvas\_set\_line\_width 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_line_width (vgcanvas_t* vg, float_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -642,12 +1030,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | value | float\_t | 线宽。 | -

set line width +* 函数功能： + +>

set line width #### vgcanvas\_set\_linear\_gradient 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_linear_gradient (vgcanvas_t* vg, float_t sx, float_t sy, float_t ex, float_t ey, color_t icolor, color_t ocolor); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -660,12 +1058,22 @@ | ey | float\_t | end y | | icolor | color\_t | 开始颜色。 | | ocolor | color\_t | 结束颜色。 | -

set fill linear gradient +* 函数功能： + +>

set fill linear gradient #### vgcanvas\_set\_linear\_gradient 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_linear_gradient (vgcanvas_t* vg, float_t sx, float_t sy, float_t ex, float_t ey, color_t icolor, color_t ocolor); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -678,12 +1086,22 @@ | ey | float\_t | end y | | icolor | color\_t | 开始颜色。 | | ocolor | color\_t | 结束颜色。 | -

set stroke linear gradient +* 函数功能： + +>

set stroke linear gradient #### vgcanvas\_set\_miter\_limit 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_miter_limit (vgcanvas_t* vg, float_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -691,12 +1109,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | value | float\_t | miter limit | -

set miter limit +* 函数功能： + +>

set miter limit #### vgcanvas\_set\_radial\_gradient 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_radial_gradient (vgcanvas_t* vg, float_t cx, float_t cy, float_t inr, float_t outr, color_t icolor, color_t ocolor); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -709,12 +1137,22 @@ | outr | float\_t | 外环半径。 | | icolor | color\_t | 开始颜色。 | | ocolor | color\_t | 结束颜色。 | -

set stroke radial gradient +* 函数功能： + +>

set stroke radial gradient #### vgcanvas\_set\_radial\_gradient 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_radial_gradient (vgcanvas_t* vg, float_t cx, float_t cy, float_t inr, float_t outr, color_t icolor, color_t ocolor); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -727,12 +1165,22 @@ | outr | float\_t | 外环半径。 | | icolor | color\_t | 开始颜色。 | | ocolor | color\_t | 结束颜色。 | -

set fill radial gradient +* 函数功能： + +>

set fill radial gradient #### vgcanvas\_set\_stroke\_color 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_stroke_color (vgcanvas_t* vg, color_t color); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -740,12 +1188,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | color | color\_t | 颜色。 | -

set stroke color +* 函数功能： + +>

set stroke color #### vgcanvas\_set\_text\_align 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_text_align (vgcanvas_t* vg, char* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -753,12 +1211,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | value | char* | 取值：left|center|right，必须为常量字符串。 | -

set text align +* 函数功能： + +>

set text align #### vgcanvas\_set\_text\_baseline 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_text_baseline (vgcanvas_t* vg, char* value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -766,12 +1234,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | | value | char* | 取值：top|middle|bottom，必须为常量字符串。 | -

set text baseline +* 函数功能： + +>

set text baseline #### vgcanvas\_set\_transform 函数 +* 函数原型： + +``` +ret_t vgcanvas_set_transform (vgcanvas_t* vg, float_t a, float_t b, float_t c, float_t d, float_t e, float_t f); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -784,24 +1262,44 @@ | d | float\_t | d | | e | float\_t | e | | f | float\_t | f | -

set transform +* 函数功能： + +>

set transform #### vgcanvas\_stroke 函数 +* 函数原型： + +``` +ret_t vgcanvas_stroke (vgcanvas_t* vg); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | vg | vgcanvas\_t* | vgcanvas对象。 | -

画线。 +* 函数功能： + +>

画线。 #### vgcanvas\_transform 函数 +* 函数原型： + +``` +ret_t vgcanvas_transform (vgcanvas_t* vg, float_t a, float_t b, float_t c, float_t d, float_t e, float_t f); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -814,12 +1312,22 @@ | d | float\_t | d | | e | float\_t | e | | f | float\_t | f | -

transform +* 函数功能： + +>

transform #### vgcanvas\_translate 函数 +* 函数原型： + +``` +ret_t vgcanvas_translate (vgcanvas_t* vg, float_t x, float_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -828,14 +1336,16 @@ | vg | vgcanvas\_t* | vgcanvas对象。 | | x | float\_t | x方向偏移。 | | y | float\_t | y方向偏移。 | -

scale +* 函数功能： + +>

scale #### anti\_alias 属性 ----------------------- -

是否启用反走样功能。 +>

是否启用反走样功能。 @@ -853,7 +1363,7 @@ | 支通过widget_set_prop修改 | 否 | #### fill\_color 属性 ----------------------- -

填充颜色 +>

填充颜色 @@ -871,7 +1381,7 @@ | 支通过widget_set_prop修改 | 否 | #### font 属性 ----------------------- -

字体。 +>

字体。 @@ -889,7 +1399,7 @@ | 支通过widget_set_prop修改 | 否 | #### font\_size 属性 ----------------------- -

字体大小。 +>

字体大小。 @@ -907,7 +1417,7 @@ | 支通过widget_set_prop修改 | 否 | #### global\_alpha 属性 ----------------------- -

全局alpha。 +>

全局alpha。 @@ -925,7 +1435,7 @@ | 支通过widget_set_prop修改 | 否 | #### height 属性 ----------------------- -

canvas的高度 +>

canvas的高度 @@ -943,7 +1453,7 @@ | 支通过widget_set_prop修改 | 否 | #### line\_cap 属性 ----------------------- -

line_cap。 +>

line_cap。 @see http://www.w3school.com.cn/tags/canvas_linecap.asp @@ -962,7 +1472,7 @@ | 支通过widget_set_prop修改 | 否 | #### line\_join 属性 ----------------------- -

line_join。 +>

line_join。 @see http://www.w3school.com.cn/tags/canvas_linejoin.asp @@ -981,7 +1491,7 @@ | 支通过widget_set_prop修改 | 否 | #### line\_width 属性 ----------------------- -

线宽。 +>

线宽。 @@ -999,7 +1509,7 @@ | 支通过widget_set_prop修改 | 否 | #### miter\_limit 属性 ----------------------- -

miter_limit。 +>

miter_limit。 @see http://www.w3school.com.cn/tags/canvas_miterlimit.asp @@ -1018,7 +1528,7 @@ | 支通过widget_set_prop修改 | 否 | #### ratio 属性 ----------------------- -

显示比例。 +>

显示比例。 @@ -1036,7 +1546,7 @@ | 支通过widget_set_prop修改 | 否 | #### stroke\_color 属性 ----------------------- -

线条颜色 +>

线条颜色 @@ -1054,7 +1564,7 @@ | 支通过widget_set_prop修改 | 否 | #### text\_align 属性 ----------------------- -

text_align。 +>

text_align。 @see http://www.w3school.com.cn/tags/canvas_textalign.asp @@ -1073,7 +1583,7 @@ | 支通过widget_set_prop修改 | 否 | #### text\_baseline 属性 ----------------------- -

text_baseline。 +>

text_baseline。 @see http://www.w3school.com.cn/tags/canvas_textbaseline.asp @@ -1092,7 +1602,7 @@ | 支通过widget_set_prop修改 | 否 | #### w 属性 ----------------------- -

canvas的宽度 +>

canvas的宽度 diff --git a/docs/manual/view_t.md b/docs/manual/view_t.md index 39feeb58e3..14e46267ae 100644 --- a/docs/manual/view_t.md +++ b/docs/manual/view_t.md @@ -1,8 +1,8 @@ ## view\_t ### 概述 - 一个通用的容器控件，也可以用作自绘。 ![image](images/view_t_0.png) + 一个通用的容器控件，也可以用作自绘。 ### 函数

@@ -21,17 +21,35 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### view\_cast 函数 +* 函数原型： + +``` +widget_t* view_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | view对象。 | | widget | widget\_t* | view对象。 | -

转换为view对象(供脚本语言使用)。 +* 函数功能： + +>

转换为view对象(供脚本语言使用)。 #### view\_create 函数 +* 函数原型： + +``` +widget_t* view_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -42,7 +60,9 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建view对象 +* 函数功能： + +>

创建view对象 diff --git a/docs/manual/wbuffer_t.md b/docs/manual/wbuffer_t.md index 3640b2dbce..5b840b9674 100644 --- a/docs/manual/wbuffer_t.md +++ b/docs/manual/wbuffer_t.md @@ -29,6 +29,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### wbuffer\_init 函数 +* 函数原型： + +``` +wbuffer_t* wbuffer_init (wbuffer_t* wbuffer, uint8_t* data, uint16_t capacity); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -37,12 +45,22 @@ | wbuffer | wbuffer\_t* | wbuffer对象。 | | data | uint8\_t* | 缓冲区。 | | capacity | uint16\_t | 缓冲区的容量。 | -

初始wbuffer对象。 +* 函数功能： + +>

初始wbuffer对象。 #### wbuffer\_skip 函数 +* 函数原型： + +``` +ret_t wbuffer_skip (wbuffer_t* wbuffer, int32_t offset); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -50,12 +68,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | wbuffer | wbuffer\_t* | wbuffer对象。 | | offset | int32\_t | 跳过的偏移量，正数往前负数往回跳。 | -

跳过指定的长度。 +* 函数功能： + +>

跳过指定的长度。 #### wbuffer\_write\_binary 函数 +* 函数原型： + +``` +ret_t wbuffer_write_binary (wbuffer_t* wbuffer, void* data, uint32_t size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -64,12 +92,22 @@ | wbuffer | wbuffer\_t* | wbuffer对象。 | | data | void* | 写入的数据。 | | size | uint32\_t | 写入的数据长度。 | -

写入指定长度的二进制数据。 +* 函数功能： + +>

写入指定长度的二进制数据。 #### wbuffer\_write\_float 函数 +* 函数原型： + +``` +ret_t wbuffer_write_float (wbuffer_t* wbuffer, float_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -77,12 +115,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | wbuffer | wbuffer\_t* | wbuffer对象。 | | value | float\_t | 写入的数据。 | -

写入float数据。 +* 函数功能： + +>

写入float数据。 #### wbuffer\_write\_string 函数 +* 函数原型： + +``` +ret_t wbuffer_write_string (wbuffer_t* wbuffer, char* data); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -90,12 +138,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | wbuffer | wbuffer\_t* | wbuffer对象。 | | data | char* | 写入的字符串。 | -

写入字符串。 +* 函数功能： + +>

写入字符串。 #### wbuffer\_write\_uint16 函数 +* 函数原型： + +``` +ret_t wbuffer_write_uint16 (wbuffer_t* wbuffer, uint16_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -103,12 +161,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | wbuffer | wbuffer\_t* | wbuffer对象。 | | value | uint16\_t | 写入的数据。 | -

写入uint16数据。 +* 函数功能： + +>

写入uint16数据。 #### wbuffer\_write\_uint32 函数 +* 函数原型： + +``` +ret_t wbuffer_write_uint32 (wbuffer_t* wbuffer, uint32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -116,12 +184,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | wbuffer | wbuffer\_t* | wbuffer对象。 | | value | uint32\_t | 写入的数据。 | -

写入uint32数据。 +* 函数功能： + +>

写入uint32数据。 #### wbuffer\_write\_uint8 函数 +* 函数原型： + +``` +ret_t wbuffer_write_uint8 (wbuffer_t* wbuffer, uint8_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -129,14 +207,16 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | wbuffer | wbuffer\_t* | wbuffer对象。 | | value | uint8\_t | 写入的数据。 | -

写入uint8数据。 +* 函数功能： + +>

写入uint8数据。 #### capacity 属性 ----------------------- -

缓存区最大容量。 +>

缓存区最大容量。 @@ -154,7 +234,7 @@ | 支通过widget_set_prop修改 | 否 | #### cursor 属性 ----------------------- -

当前写入位置。 +>

当前写入位置。 @@ -172,7 +252,7 @@ | 支通过widget_set_prop修改 | 否 | #### data 属性 ----------------------- -

缓存区。 +>

缓存区。 diff --git a/docs/manual/wheel_event_t.md b/docs/manual/wheel_event_t.md index e2b990d6a7..990417ecce 100644 --- a/docs/manual/wheel_event_t.md +++ b/docs/manual/wheel_event_t.md @@ -1,9 +1,9 @@ ## wheel\_event\_t ### 概述 - 滚轮事件。 - ![image](images/wheel_event_t_0.png) + 滚轮事件。 + ### 函数

@@ -26,20 +26,30 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### wheel\_event\_cast 函数 +* 函数原型： + +``` +wheel_event_t* wheel_event_cast (event_t* event); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | wheel\_event\_t* | 对象。 | | event | event\_t* | event对象。 | -

把event对象转wheel_event_t对象，主要给脚本语言使用。 +* 函数功能： + +>

把event对象转wheel_event_t对象，主要给脚本语言使用。 #### alt 属性 ----------------------- -

alt键是否按下。 +>

alt键是否按下。 @@ -57,7 +67,7 @@ | 支通过widget_set_prop修改 | 否 | #### ctrl 属性 ----------------------- -

ctrl键是否按下。 +>

ctrl键是否按下。 @@ -75,7 +85,7 @@ | 支通过widget_set_prop修改 | 否 | #### dx 属性 ----------------------- -

滚轮的x值。 +>

滚轮的x值。 @@ -93,7 +103,7 @@ | 支通过widget_set_prop修改 | 否 | #### dy 属性 ----------------------- -

滚轮的x值。 +>

滚轮的x值。 @@ -111,7 +121,7 @@ | 支通过widget_set_prop修改 | 否 | #### shift 属性 ----------------------- -

shift键是否按下。 +>

shift键是否按下。 diff --git a/docs/manual/widget_animator_prop2_t.md b/docs/manual/widget_animator_prop2_t.md index f39d712169..ece7752c85 100644 --- a/docs/manual/widget_animator_prop2_t.md +++ b/docs/manual/widget_animator_prop2_t.md @@ -20,6 +20,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### widget\_animator\_prop2\_create 函数 +* 函数原型： + +``` +widget_animator_t* widget_animator_prop2_create (widget_t* widget, uint32_t duration, uint32_t delay, easing_type_t easing, const char* prop1_name, const char* prop2_name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -31,12 +39,22 @@ | easing | easing\_type\_t | 插值函数类型。 | | prop1\_name | const char* | 属性1的名称。 | | prop2\_name | const char* | 属性2的名称。 | -

创建双属性动画对象。 +* 函数功能： + +>

创建双属性动画对象。 #### widget\_animator\_prop2\_set\_params 函数 +* 函数原型： + +``` +ret_t widget_animator_prop2_set_params (widget_animator_t* animator, float_t from1, float_t from2, float_t to1, float_t to2); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -47,7 +65,9 @@ | from2 | float\_t | y的初值。 | | to1 | float\_t | x的终值。 | | to2 | float\_t | y的终值。 | -

设置动画对象的参数。 +* 函数功能： + +>

设置动画对象的参数。 diff --git a/docs/manual/widget_animator_prop_t.md b/docs/manual/widget_animator_prop_t.md index 7a0635be2c..7827095201 100644 --- a/docs/manual/widget_animator_prop_t.md +++ b/docs/manual/widget_animator_prop_t.md @@ -20,6 +20,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### widget\_animator\_prop\_create 函数 +* 函数原型： + +``` +widget_animator_t* widget_animator_prop_create (widget_t* widget, uint32_t duration, uint32_t delay, easing_type_t easing, const char* prop_name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -30,12 +38,22 @@ | delay | uint32\_t | 动画执行时间。 | | easing | easing\_type\_t | 插值函数类型。 | | prop\_name | const char* | 属性的名称。 | -

创建单属性动画对象。 +* 函数功能： + +>

创建单属性动画对象。 #### widget\_animator\_prop\_set\_params 函数 +* 函数原型： + +``` +ret_t widget_animator_prop_set_params (widget_animator_t* animator, float_t from, float_t to); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -44,7 +62,9 @@ | animator | widget\_animator\_t* | 动画对象本身。 | | from | float\_t | prop起始值。 | | to | float\_t | prop结束值。 | -

设置动画对象的参数。 +* 函数功能： + +>

设置动画对象的参数。 diff --git a/docs/manual/widget_animator_scroll_t.md b/docs/manual/widget_animator_scroll_t.md index 8a9cecb8cb..31bdddf8ae 100644 --- a/docs/manual/widget_animator_scroll_t.md +++ b/docs/manual/widget_animator_scroll_t.md @@ -21,6 +21,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### widget\_animator\_scroll\_create 函数 +* 函数原型： + +``` +widget_animator_t* widget_animator_scroll_create (widget_t* widget, uint32_t duration, uint32_t delay, easing_type_t easing); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -30,12 +38,22 @@ | duration | uint32\_t | 动画持续时间。 | | delay | uint32\_t | 动画执行时间。 | | easing | easing\_type\_t | 插值函数类型。 | -

创建动画对象。 +* 函数功能： + +>

创建动画对象。 #### widget\_animator\_scroll\_set\_params 函数 +* 函数原型： + +``` +ret_t widget_animator_scroll_set_params (widget_animator_t* animator, xy_t x_from, xy_t y_from, xy_t x_to, xy_t y_to); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -46,7 +64,9 @@ | y\_from | xy\_t | y起点值。 | | x\_to | xy\_t | x终点值。 | | y\_to | xy\_t | y终点值。 | -

设置动画对象的参数。 +* 函数功能： + +>

设置动画对象的参数。 diff --git a/docs/manual/widget_animator_t.md b/docs/manual/widget_animator_t.md index dea55ed602..56370febca 100644 --- a/docs/manual/widget_animator_t.md +++ b/docs/manual/widget_animator_t.md @@ -32,18 +32,36 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### widget\_animator\_destroy 函数 +* 函数原型： + +``` +ret_t widget_animator_destroy (widget_animator_t* animator); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | -

销毁animator对象。 +* 函数功能： + +>

销毁animator对象。 #### widget\_animator\_init 函数 +* 函数原型： + +``` +ret_t widget_animator_init (widget_animator_t* animator, widget_t* widget, uint32_t duration, uint32_t delay, easing_func_t ); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -54,12 +72,22 @@ | duration | uint32\_t | 动画持续时间。 | | delay | uint32\_t | 动画执行时间。 | | | easing\_func\_t | 。 | -

初始化。仅供子类内部使用。 +* 函数功能： + +>

初始化。仅供子类内部使用。 #### widget\_animator\_off 函数 +* 函数原型： + +``` +ret_t widget_animator_off (widget_animator_t* animator, uint32_t id); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -67,12 +95,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | | id | uint32\_t | widget\_animator\_on返回的ID。 | -

注销指定事件的处理函数。 +* 函数功能： + +>

注销指定事件的处理函数。 #### widget\_animator\_on 函数 +* 函数原型： + +``` +uint32_t widget_animator_on (widget_animator_t* animator, event_type_t , event_func_t on_event, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -82,25 +120,45 @@ | | event\_type\_t | e | | on\_event | event\_func\_t | 事件处理函数。 | | ctx | void* | 事件处理函数上下文。 | -

注册指定事件的处理函数。 +* 函数功能： + +>

注册指定事件的处理函数。 事件类型。目前支持：EVT_ANIM_START,EVT_ANIM_STOP,EVT_ANIM_PAUSE,EVT_ANIM_ONCE和EVT_ANIM_END。 #### widget\_animator\_pause 函数 +* 函数原型： + +``` +ret_t widget_animator_pause (widget_animator_t* animator); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | -

暂停动画。 +* 函数功能： + +>

暂停动画。 #### widget\_animator\_set\_destroy\_when\_done 函数 +* 函数原型： + +``` +ret_t widget_animator_set_destroy_when_done (widget_animator_t* animator, bool_t destroy_when_done); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -108,12 +166,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | | destroy\_when\_done | bool\_t | 完成时是否自动销毁动画对象。 | -

设置完成时是否自动销毁动画对象(缺省销毁)。 +* 函数功能： + +>

设置完成时是否自动销毁动画对象(缺省销毁)。 #### widget\_animator\_set\_name 函数 +* 函数原型： + +``` +ret_t widget_animator_set_name (widget_animator_t* animator, const char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -121,12 +189,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | | name | const char* | 名称。 | -

设置名称。 +* 函数功能： + +>

设置名称。 #### widget\_animator\_set\_repeat 函数 +* 函数原型： + +``` +ret_t widget_animator_set_repeat (widget_animator_t* animator, uint32_t repeat_times); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -134,12 +212,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | | repeat\_times | uint32\_t | 重复的次数。 | -

设置为重复模式。 +* 函数功能： + +>

设置为重复模式。 #### widget\_animator\_set\_reversed 函数 +* 函数原型： + +``` +ret_t widget_animator_set_reversed (widget_animator_t* animator, bool_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -147,12 +235,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | | value | bool\_t | 是否为逆向模式。 | -

设置为逆向模式。 +* 函数功能： + +>

设置为逆向模式。 #### widget\_animator\_set\_time\_scale 函数 +* 函数原型： + +``` +ret_t widget_animator_set_time_scale (widget_animator_t* animator, float_t time_scale); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -160,12 +258,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | | time\_scale | float\_t | 时间倍率。 | -

设置时间倍率，用于实现时间加速减速和停滞的功能。 +* 函数功能： + +>

设置时间倍率，用于实现时间加速减速和停滞的功能。 #### widget\_animator\_set\_yoyo 函数 +* 函数原型： + +``` +ret_t widget_animator_set_yoyo (widget_animator_t* animator, uint32_t yoyo_times); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -173,38 +281,60 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | | yoyo\_times | uint32\_t | yoyo的次数，往返视为两次。 | -

设置为yoyo模式。 +* 函数功能： + +>

设置为yoyo模式。 #### widget\_animator\_start 函数 +* 函数原型： + +``` +ret_t widget_animator_start (widget_animator_t* animator); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | -

启动动画。 +* 函数功能： + +>

启动动画。 #### widget\_animator\_stop 函数 +* 函数原型： + +``` +ret_t widget_animator_stop (widget_animator_t* animator); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | animator | widget\_animator\_t* | 动画对象。 | -

停止动画。 +* 函数功能： + +>

停止动画。 #### name 属性 ----------------------- -

名称。 +>

名称。 diff --git a/docs/manual/widget_prop_t.md b/docs/manual/widget_prop_t.md index 534a350214..08d412cfe4 100644 --- a/docs/manual/widget_prop_t.md +++ b/docs/manual/widget_prop_t.md @@ -39,6 +39,7 @@ | WIDGET\_PROP\_BOTTOM\_MARGIN | 底边距。 | | WIDGET\_PROP\_STEP | 步长。 | | WIDGET\_PROP\_VISIBLE | 是否可见。 | +| WIDGET\_PROP\_SENSITIVE | 是否接受用户事件。 | | WIDGET\_PROP\_ANIMATION | 控件动画。 | | WIDGET\_PROP\_ANIM\_HINT | 窗口动画。 | | WIDGET\_PROP\_OPEN\_ANIM\_HINT | 打开窗口动画。 | diff --git a/docs/manual/widget_t.md b/docs/manual/widget_t.md index f0e4ba9834..19639dcc99 100644 --- a/docs/manual/widget_t.md +++ b/docs/manual/widget_t.md @@ -93,6 +93,7 @@ | widget\_set\_prop\_str | 设置字符串格式的属性。 | | widget\_set\_self\_layout | 设置控件自己的布局参数。 | | widget\_set\_self\_layout\_params | 设置控件自己的布局(缺省布局器)参数(过时，请用widget\_set\_self\_layout)。 | +| widget\_set\_sensitive | 设置控件是否接受用户事件。 | | widget\_set\_state | 设置控件的状态。 | | widget\_set\_text | 设置控件的文本。 | | widget\_set\_text\_utf8 | 设置控件的文本。 | @@ -133,6 +134,7 @@ | opacity | uint8_t | 不透明度(0-255)，0完全透明，255完全不透明。 | | parent | widget_t* | 父控件 | | self\_layout | self_layouter_t* | 控件布局器。请参考[控件布局参数](https://github.com/zlgopen/awtk/blob/master/docs/layout.md) | +| sensitive | bool_t | 是否接受用户事件。 | | state | uint8_t | 控件的状态(取值参考widget_state_t)。 | | style | char* | style的名称。 | | target | widget_t* | 接收事件的子控件。 | @@ -171,6 +173,14 @@ | EVT\_POINTER\_UP | pointer\_event\_t | 指针设备释放事件。 | | EVT\_DESTROY | event\_t | 控件销毁时触发。 | #### widget\_add\_child 函数 +* 函数原型： + +``` +ret_t widget_add_child (widget_t* widget, widget_t* child); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -178,12 +188,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | child | widget\_t* | 子控件对象。 | -

加入一个子控件。 +* 函数功能： + +>

加入一个子控件。 #### widget\_add\_timer 函数 +* 函数原型： + +``` +uint32_t widget_add_timer (widget_t* widget, timer_func_t on_timer, uint32_t duration_ms); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -192,7 +212,9 @@ | widget | widget\_t* | 控件对象。 | | on\_timer | timer\_func\_t | timer回调函数。 | | duration\_ms | uint32\_t | 时间。 | -

创建定时器。 +* 函数功能： + +>

创建定时器。 该定时器在控件销毁时自动销毁，**timer\_info\_t**的ctx为widget。 如果定时器的生命周期与控件无关，请直接调用**timer_add**，以避免不必要的内存开销。 @@ -213,6 +235,14 @@ #### widget\_add\_value 函数 +* 函数原型： + +``` +ret_t widget_add_value (widget_t* widget, int32_t delta); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -220,25 +250,45 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | delta | int32\_t | 增量。 | -

增加控件的值。 +* 函数功能： + +>

增加控件的值。 只是对widget\_set\_prop的包装，值的意义由子类控件决定。 #### widget\_cast 函数 +* 函数原型： + +``` +widget_t* widget_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | widget对象。 | | widget | widget\_t* | widget对象。 | -

转换为widget对象(供脚本语言使用)。 +* 函数功能： + +>

转换为widget对象(供脚本语言使用)。 #### widget\_child 函数 +* 函数原型： + +``` +widget_t* widget_child (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -246,12 +296,22 @@ | 返回值 | widget\_t* | 子控件或NULL。 | | widget | widget\_t* | 控件对象。 | | name | char* | 子控件的名称。 | -

查找指定名称的子控件(同widget_lookup(widget, name, FALSE))。 +* 函数功能： + +>

查找指定名称的子控件(同widget_lookup(widget, name, FALSE))。 #### widget\_child\_on 函数 +* 函数原型： + +``` +int32_t widget_child_on (widget_t* widget, char* name, event_type_t type, event_func_t on_event, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -262,13 +322,23 @@ | type | event\_type\_t | 事件类型。 | | on\_event | event\_func\_t | 事件处理函数。 | | ctx | void* | 事件处理函数上下文。 | -

为指定名称的子控件注册指定事件的处理函数。 +* 函数功能： + +>

为指定名称的子控件注册指定事件的处理函数。 递归查找指定名称的子控件，然后为其注册指定事件的处理函数。 #### widget\_clone 函数 +* 函数原型： + +``` +widget_t* widget_clone (widget_t* widget, widget_t* parent); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -276,24 +346,44 @@ | 返回值 | widget\_t* | 返回clone的对象。 | | widget | widget\_t* | 控件对象。 | | parent | widget\_t* | clone新控件的parent对象。 | -

clone。 +* 函数功能： + +>

clone。 #### widget\_count\_children 函数 +* 函数原型： + +``` +int32_t widget_count_children (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int32\_t | 子控件的个数。 | | widget | widget\_t* | 控件对象。 | -

获取子控件的个数。 +* 函数功能： + +>

获取子控件的个数。 #### widget\_create\_animator 函数 +* 函数原型： + +``` +ret_t widget_create_animator (widget_t* widget, const char* animation); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -301,7 +391,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | animation | const char* | 动画参数。 | -

创建动画。 +* 函数功能： + +>

创建动画。 请参考[控件动画](https://github.com/zlgopen/awtk/blob/master/docs/widget_animator.md) * 除非指定auto_start=false，动画创建后自动启动。 @@ -312,19 +404,37 @@ #### widget\_destroy 函数 +* 函数原型： + +``` +ret_t widget_destroy (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | -

销毁控件。 +* 函数功能： + +>

销毁控件。 一般无需直接调用，关闭窗口时，自动销毁相关控件。 #### widget\_destroy\_animator 函数 +* 函数原型： + +``` +ret_t widget_destroy_animator (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -332,7 +442,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | name | char* | 动画名称。 | -

销毁动画。 +* 函数功能： + +>

销毁动画。 请参考[控件动画](https://github.com/zlgopen/awtk/blob/master/docs/widget_animator.md) * 1.widget为NULL时，销毁所有名称为name的动画。 @@ -344,18 +456,36 @@ #### widget\_destroy\_children 函数 +* 函数原型： + +``` +ret_t widget_destroy_children (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | -

销毁全部子控件。 +* 函数功能： + +>

销毁全部子控件。 #### widget\_dispatch 函数 +* 函数原型： + +``` +ret_t widget_dispatch (widget_t* widget, event_t* e); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -363,12 +493,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | e | event\_t* | 事件。 | -

分发一个事件。 +* 函数功能： + +>

分发一个事件。 #### widget\_equal 函数 +* 函数原型： + +``` +bool_t widget_equal (widget_t* widget, widget_t* other); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -376,12 +516,22 @@ | 返回值 | bool\_t | 返回TRUE表示相同，否则表示不同。 | | widget | widget\_t* | 控件对象。 | | other | widget\_t* | 要比较的控件对象。 | -

判断两个widget是否相同。 +* 函数功能： + +>

判断两个widget是否相同。 #### widget\_foreach 函数 +* 函数原型： + +``` +ret_t widget_foreach (widget_t* widget, tk_visit_t visit, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -390,12 +540,22 @@ | widget | widget\_t* | 控件对象。 | | visit | tk\_visit\_t | 遍历的回调函数。 | | ctx | void* | 回调函数的上下文。 | -

遍历当前控件及子控件。 +* 函数功能： + +>

遍历当前控件及子控件。 #### widget\_get\_child 函数 +* 函数原型： + +``` +widget_t* widget_get_child (widget_t* widget, int32_t index); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -403,12 +563,22 @@ | 返回值 | widget\_t* | 子控件。 | | widget | widget\_t* | 控件对象。 | | index | int32\_t | 索引。 | -

获取指定索引的子控件。 +* 函数功能： + +>

获取指定索引的子控件。 #### widget\_get\_prop 函数 +* 函数原型： + +``` +ret_t widget_get_prop (widget_t* widget, const char* name, value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -417,12 +587,22 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 属性的名称。 | | v | value\_t* | 属性的值。 | -

通用的获取控件属性的函数。 +* 函数功能： + +>

通用的获取控件属性的函数。 #### widget\_get\_prop\_bool 函数 +* 函数原型： + +``` +bool_t widget_get_prop_bool (widget_t* widget, const char* name, bool_t defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -431,12 +611,22 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 属性的名称。 | | defval | bool\_t | 缺省值。 | -

获取布尔格式的属性。 +* 函数功能： + +>

获取布尔格式的属性。 #### widget\_get\_prop\_int 函数 +* 函数原型： + +``` +int32_t widget_get_prop_int (widget_t* widget, const char* name, int32_t defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -445,12 +635,22 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 属性的名称。 | | defval | int32\_t | 缺省值。 | -

获取整数格式的属性。 +* 函数功能： + +>

获取整数格式的属性。 #### widget\_get\_prop\_str 函数 +* 函数原型： + +``` +const char* widget_get_prop_str (widget_t* widget, const char* name, const char* defval); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -459,73 +659,133 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 属性的名称。 | | defval | const char* | 缺省值。 | -

获取字符串格式的属性。 +* 函数功能： + +>

获取字符串格式的属性。 #### widget\_get\_text 函数 +* 函数原型： + +``` +wchar_t* widget_get_text (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | wchar\_t* | 返回文本。 | | widget | widget\_t* | 控件对象。 | -

获取控件的文本。 +* 函数功能： + +>

获取控件的文本。 只是对widget\_get\_prop的包装，文本的意义由子类控件决定。 #### widget\_get\_type 函数 +* 函数原型： + +``` +char* widget_get_type (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | char* | 返回类型名。 | | widget | widget\_t* | 控件对象。 | -

获取当前控件的类型名称。 +* 函数功能： + +>

获取当前控件的类型名称。 #### widget\_get\_value 函数 +* 函数原型： + +``` +int32_t widget_get_value (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int32\_t | 返回值。 | | widget | widget\_t* | 控件对象。 | -

获取控件的值。只是对widget\_get\_prop的包装，值的意义由子类控件决定。 +* 函数功能： + +>

获取控件的值。只是对widget\_get\_prop的包装，值的意义由子类控件决定。 #### widget\_get\_window 函数 +* 函数原型： + +``` +widget_t* widget_get_window (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | 窗口对象。 | | widget | widget\_t* | 控件对象。 | -

获取当前控件所在的窗口。 +* 函数功能： + +>

获取当前控件所在的窗口。 #### widget\_get\_window\_manager 函数 +* 函数原型： + +``` +widget_t* widget_get_window_manager (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | 窗口管理器对象。 | | widget | widget\_t* | 控件对象。 | -

获取当前的窗口管理器。 +* 函数功能： + +>

获取当前的窗口管理器。 #### widget\_grab 函数 +* 函数原型： + +``` +ret_t widget_grab (widget_t* widget, widget_t* child); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -533,25 +793,45 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | child | widget\_t* | 子控件对象。 | -

让指定子控件抓住事件。 +* 函数功能： + +>

让指定子控件抓住事件。 控件抓住之后，事件直接分发给该控件。 #### widget\_index\_of 函数 +* 函数原型： + +``` +int32_t widget_index_of (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | int32\_t | 在父控件中的索引编号。 | | widget | widget\_t* | 控件对象。 | -

获取控件在父控件中的索引编号。 +* 函数功能： + +>

获取控件在父控件中的索引编号。 #### widget\_insert\_child 函数 +* 函数原型： + +``` +ret_t widget_insert_child (widget_t* widget, uint32_t index, widget_t* child); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -560,12 +840,22 @@ | widget | widget\_t* | 控件对象。 | | index | uint32\_t | 位置序数(大于等于总个数，则放到最后)。 | | child | widget\_t* | 子控件对象。 | -

插入子控件到指定的位置。 +* 函数功能： + +>

插入子控件到指定的位置。 #### widget\_invalidate 函数 +* 函数原型： + +``` +ret_t widget_invalidate (widget_t* widget, rect_t* r); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -573,12 +863,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | r | rect\_t* | 矩形对象(widget本地坐标)。 | -

请求重绘指定的区域，如果widget->dirty已经为TRUE，直接返回。 +* 函数功能： + +>

请求重绘指定的区域，如果widget->dirty已经为TRUE，直接返回。 #### widget\_invalidate\_force 函数 +* 函数原型： + +``` +ret_t widget_invalidate_force (widget_t* widget, rect_t* r); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -586,48 +886,88 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | r | rect\_t* | 矩形对象(widget本地坐标)。 | -

请求强制重绘控件。 +* 函数功能： + +>

请求强制重绘控件。 #### widget\_is\_window\_opened 函数 +* 函数原型： + +``` +bool_t widget_is_window_opened (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | bool\_t | 返回当前控件所在的窗口是否已经打开。 | | widget | widget\_t* | 控件对象。 | -

判断当前控件所在的窗口是否已经打开。 +* 函数功能： + +>

判断当前控件所在的窗口是否已经打开。 #### widget\_layout 函数 +* 函数原型： + +``` +ret_t widget_layout (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | widget对象。 | -

布局当前控件及子控件。 +* 函数功能： + +>

布局当前控件及子控件。 #### widget\_layout\_children 函数 +* 函数原型： + +``` +ret_t widget_layout_children (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | -

layout子控件。 +* 函数功能： + +>

layout子控件。 #### widget\_load\_asset 函数 +* 函数原型： + +``` +const asset_info_t* widget_load_asset (widget_t* widget, asset_type_t type, const char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -636,7 +976,9 @@ | widget | widget\_t* | 控件对象。 | | type | asset\_type\_t | 资源类型。 | | name | const char* | 资源名。 | -

加载资源。 +* 函数功能： + +>

加载资源。 使用示例： @@ -650,6 +992,14 @@ #### widget\_load\_image 函数 +* 函数原型： + +``` +ret_t widget_load_image (widget_t* widget, const char* name, bitmap_t* bitmap); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -658,7 +1008,9 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 图片名(不带扩展名)。 | | bitmap | bitmap\_t* | 返回图片对象。 | -

加载图片。 +* 函数功能： + +>

加载图片。 返回的bitmap对象只在当前调用有效，请不保存对bitmap对象的引用。 @@ -674,6 +1026,14 @@ #### widget\_lookup 函数 +* 函数原型： + +``` +widget_t* widget_lookup (widget_t* widget, char* name, bool_t recursive); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -682,12 +1042,22 @@ | widget | widget\_t* | 控件对象。 | | name | char* | 子控件的名称。 | | recursive | bool\_t | 是否递归查找全部子控件。 | -

查找指定名称的子控件(返回第一个)。 +* 函数功能： + +>

查找指定名称的子控件(返回第一个)。 #### widget\_lookup\_by\_type 函数 +* 函数原型： + +``` +widget_t* widget_lookup_by_type (widget_t* widget, char* type, bool_t recursive); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -696,12 +1066,22 @@ | widget | widget\_t* | 控件对象。 | | type | char* | 子控件的名称。 | | recursive | bool\_t | 是否递归查找全部子控件。 | -

查找指定类型的子控件(返回第一个)。 +* 函数功能： + +>

查找指定类型的子控件(返回第一个)。 #### widget\_move 函数 +* 函数原型： + +``` +ret_t widget_move (widget_t* widget, xy_t x, xy_t y); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -710,12 +1090,22 @@ | widget | widget\_t* | 控件对象。 | | x | xy\_t | x坐标 | | y | xy\_t | y坐标 | -

移动控件。 +* 函数功能： + +>

移动控件。 #### widget\_move\_resize 函数 +* 函数原型： + +``` +ret_t widget_move_resize (widget_t* widget, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -726,12 +1116,22 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

移动控件并调整控件的大小。 +* 函数功能： + +>

移动控件并调整控件的大小。 #### widget\_off 函数 +* 函数原型： + +``` +ret_t widget_off (widget_t* widget, int32_t id); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -739,12 +1139,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | id | int32\_t | widget\_on返回的ID。 | -

注销指定事件的处理函数。 +* 函数功能： + +>

注销指定事件的处理函数。 #### widget\_off\_by\_func 函数 +* 函数原型： + +``` +ret_t widget_off_by_func (widget_t* widget, event_type_t type, event_func_t on_event, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -754,13 +1164,23 @@ | type | event\_type\_t | 事件类型。 | | on\_event | event\_func\_t | 事件处理函数。 | | ctx | void* | 事件处理函数上下文。 | -

注销指定事件的处理函数。 +* 函数功能： + +>

注销指定事件的处理函数。 仅用于辅助实现脚本绑定。 #### widget\_on 函数 +* 函数原型： + +``` +int32_t widget_on (widget_t* widget, event_type_t type, event_func_t on_event, void* ctx); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -770,7 +1190,9 @@ | type | event\_type\_t | 事件类型。 | | on\_event | event\_func\_t | 事件处理函数。 | | ctx | void* | 事件处理函数上下文。 | -

注册指定事件的处理函数。 +* 函数功能： + +>

注册指定事件的处理函数。 使用示例： ```c @@ -783,6 +1205,14 @@ #### widget\_pause\_animator 函数 +* 函数原型： + +``` +ret_t widget_pause_animator (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -790,7 +1220,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | name | char* | 动画名称。 | -

暂停动画。 +* 函数功能： + +>

暂停动画。 请参考[控件动画](https://github.com/zlgopen/awtk/blob/master/docs/widget_animator.md) * 1.widget为NULL时，暂停所有名称为name的动画。 @@ -802,6 +1234,14 @@ #### widget\_remove\_child 函数 +* 函数原型： + +``` +ret_t widget_remove_child (widget_t* widget, widget_t* child); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -809,12 +1249,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | child | widget\_t* | 子控件对象。 | -

移出指定的子控件(并不销毁)。 +* 函数功能： + +>

移出指定的子控件(并不销毁)。 #### widget\_resize 函数 +* 函数原型： + +``` +ret_t widget_resize (widget_t* widget, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -823,12 +1273,22 @@ | widget | widget\_t* | 控件对象。 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

调整控件的大小。 +* 函数功能： + +>

调整控件的大小。 #### widget\_restack 函数 +* 函数原型： + +``` +ret_t widget_restack (widget_t* widget, uint32_t index); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -836,12 +1296,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | index | uint32\_t | 位置序数(大于等于总个数，则放到最后)。 | -

调整控件在父控件中的位置序数。 +* 函数功能： + +>

调整控件在父控件中的位置序数。 #### widget\_set\_animation 函数 +* 函数原型： + +``` +ret_t widget_set_animation (widget_t* widget, const char* animation); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -849,7 +1319,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | animation | const char* | 动画参数。 | -

设置控件的动画参数(仅用于在UI文件使用)。 +* 函数功能： + +>

设置控件的动画参数(仅用于在UI文件使用)。 请参考[控件动画](https://github.com/zlgopen/awtk/blob/master/docs/widget_animator.md) @@ -857,6 +1329,14 @@ #### widget\_set\_animator\_time\_scale 函数 +* 函数原型： + +``` +ret_t widget_set_animator_time_scale (widget_t* widget, const char* name, float_t time_scale); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -865,7 +1345,9 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 动画名称。 | | time\_scale | float\_t | 时间倍率。 | -

设置动画的时间倍率，<0: 时间倒退，<1: 时间变慢，>1 时间变快。 +* 函数功能： + +>

设置动画的时间倍率，<0: 时间倒退，<1: 时间变慢，>1 时间变快。 请参考[控件动画](https://github.com/zlgopen/awtk/blob/master/docs/widget_animator.md) * 1.widget为NULL时，设置所有名称为name的动画的时间倍率。 @@ -877,6 +1359,14 @@ #### widget\_set\_children\_layout 函数 +* 函数原型： + +``` +ret_t widget_set_children_layout (widget_t* widget, const char* params); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -884,12 +1374,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | params | const char* | 布局参数。 | -

设置子控件的布局参数。 +* 函数功能： + +>

设置子控件的布局参数。 #### widget\_set\_cursor 函数 +* 函数原型： + +``` +ret_t widget_set_cursor (widget_t* widget, char* cursor); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -897,12 +1397,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | cursor | char* | 图片名称(无扩展名)。 | -

设置鼠标指针的图片名。 +* 函数功能： + +>

设置鼠标指针的图片名。 #### widget\_set\_enable 函数 +* 函数原型： + +``` +ret_t widget_set_enable (widget_t* widget, bool_t enable); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -910,12 +1420,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | enable | bool\_t | 是否可用性。 | -

设置控件的可用性。 +* 函数功能： + +>

设置控件的可用性。 #### widget\_set\_floating 函数 +* 函数原型： + +``` +ret_t widget_set_floating (widget_t* widget, bool_t floating); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -923,12 +1443,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | floating | bool\_t | 是否启用floating布局。 | -

设置控件的floating标志。 +* 函数功能： + +>

设置控件的floating标志。 #### widget\_set\_focused 函数 +* 函数原型： + +``` +ret_t widget_set_focused (widget_t* widget, bool_t focused); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -936,12 +1466,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | focused | bool\_t | 是否聚焦。 | -

设置控件的是否聚焦。 +* 函数功能： + +>

设置控件的是否聚焦。 #### widget\_set\_name 函数 +* 函数原型： + +``` +ret_t widget_set_name (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -949,12 +1489,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | name | char* | 名称。 | -

设置控件的名称。 +* 函数功能： + +>

设置控件的名称。 #### widget\_set\_opacity 函数 +* 函数原型： + +``` +ret_t widget_set_opacity (widget_t* widget, uint8_t opacity); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -962,12 +1512,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | opacity | uint8\_t | 不透明度。 | -

设置控件的不透明度。 +* 函数功能： + +>

设置控件的不透明度。 #### widget\_set\_prop 函数 +* 函数原型： + +``` +ret_t widget_set_prop (widget_t* widget, const char* name, value_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -976,12 +1536,22 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 属性的名称。 | | v | value\_t* | 属性的值。 | -

通用的设置控件属性的函数。 +* 函数功能： + +>

通用的设置控件属性的函数。 #### widget\_set\_prop\_bool 函数 +* 函数原型： + +``` +ret_t widget_set_prop_bool (widget_t* widget, const char* name, bool_t v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -990,12 +1560,22 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 属性的名称。 | | v | bool\_t | 属性的值。 | -

设置布尔格式的属性。 +* 函数功能： + +>

设置布尔格式的属性。 #### widget\_set\_prop\_int 函数 +* 函数原型： + +``` +ret_t widget_set_prop_int (widget_t* widget, const char* name, int32_t v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1004,12 +1584,22 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 属性的名称。 | | v | int32\_t | 属性的值。 | -

设置整数格式的属性。 +* 函数功能： + +>

设置整数格式的属性。 #### widget\_set\_prop\_str 函数 +* 函数原型： + +``` +ret_t widget_set_prop_str (widget_t* widget, const char* name, const char* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1018,12 +1608,22 @@ | widget | widget\_t* | 控件对象。 | | name | const char* | 属性的名称。 | | v | const char* | 属性的值。 | -

设置字符串格式的属性。 +* 函数功能： + +>

设置字符串格式的属性。 #### widget\_set\_self\_layout 函数 +* 函数原型： + +``` +ret_t widget_set_self_layout (widget_t* widget, const char* params); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1031,12 +1631,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | params | const char* | 布局参数。 | -

设置控件自己的布局参数。 +* 函数功能： + +>

设置控件自己的布局参数。 #### widget\_set\_self\_layout\_params 函数 +* 函数原型： + +``` +ret_t widget_set_self_layout_params (widget_t* widget, const char* x, const char* y, const char* w, const char* h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1047,12 +1657,45 @@ | y | const char* | y参数。 | | w | const char* | w参数。 | | h | const char* | h参数。 | -

设置控件自己的布局(缺省布局器)参数(过时，请用widget\_set\_self\_layout)。 +* 函数功能： + +>

设置控件自己的布局(缺省布局器)参数(过时，请用widget\_set\_self\_layout)。 + + + + +#### widget\_set\_sensitive 函数 +* 函数原型： + +``` +ret_t widget_set_sensitive (widget_t* widget, bool_t sensitive); +``` + +* 参数说明： + +----------------------- + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| widget | widget\_t* | 控件对象。 | +| sensitive | bool\_t | 是否接受用户事件。 | +* 函数功能： + +>

设置控件是否接受用户事件。 #### widget\_set\_state 函数 +* 函数原型： + +``` +ret_t widget_set_state (widget_t* widget, widget_state_t state); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1060,12 +1703,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | state | widget\_state\_t | 状态。 | -

设置控件的状态。 +* 函数功能： + +>

设置控件的状态。 #### widget\_set\_text 函数 +* 函数原型： + +``` +ret_t widget_set_text (widget_t* widget, wchar_t* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1073,13 +1726,23 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | text | wchar\_t* | 文本。 | -

设置控件的文本。 +* 函数功能： + +>

设置控件的文本。 只是对widget\_set\_prop的包装，文本的意义由子类控件决定。 #### widget\_set\_text\_utf8 函数 +* 函数原型： + +``` +ret_t widget_set_text_utf8 (widget_t* widget, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1087,13 +1750,23 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | text | char* | 文本。 | -

设置控件的文本。 +* 函数功能： + +>

设置控件的文本。 只是对widget\_set\_prop的包装，文本的意义由子类控件决定。 #### widget\_set\_tr\_text 函数 +* 函数原型： + +``` +ret_t widget_set_tr_text (widget_t* widget, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1101,12 +1774,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | text | char* | 文本。 | -

获取翻译之后的文本，然后调用widget_set_text。 +* 函数功能： + +>

获取翻译之后的文本，然后调用widget_set_text。 #### widget\_set\_value 函数 +* 函数原型： + +``` +ret_t widget_set_value (widget_t* widget, int32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1114,13 +1797,23 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | value | int32\_t | 值。 | -

设置控件的值。 +* 函数功能： + +>

设置控件的值。 只是对widget\_set\_prop的包装，值的意义由子类控件决定。 #### widget\_set\_visible 函数 +* 函数原型： + +``` +ret_t widget_set_visible (widget_t* widget, bool_t visible, bool_t recursive); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1129,12 +1822,22 @@ | widget | widget\_t* | 控件对象。 | | visible | bool\_t | 是否可见。 | | recursive | bool\_t | 是否递归设置全部子控件。 | -

设置控件的可见性。 +* 函数功能： + +>

设置控件的可见性。 #### widget\_start\_animator 函数 +* 函数原型： + +``` +ret_t widget_start_animator (widget_t* widget, const char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1142,7 +1845,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | name | const char* | 动画名称。 | -

播放动画。 +* 函数功能： + +>

播放动画。 请参考[控件动画](https://github.com/zlgopen/awtk/blob/master/docs/widget_animator.md) * 1.widget为NULL时，播放所有名称为name的动画。 @@ -1154,6 +1859,14 @@ #### widget\_stop\_animator 函数 +* 函数原型： + +``` +ret_t widget_stop_animator (widget_t* widget, char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1161,7 +1874,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | name | char* | 动画名称。 | -

停止动画(控件的相应属性回归原位)。 +* 函数功能： + +>

停止动画(控件的相应属性回归原位)。 请参考[控件动画](https://github.com/zlgopen/awtk/blob/master/docs/widget_animator.md) * 1.widget为NULL时，停止所有名称为name的动画。 @@ -1173,6 +1888,14 @@ #### widget\_to\_global 函数 +* 函数原型： + +``` +ret_t widget_to_global (widget_t* widget, point_t* p); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1180,12 +1903,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | p | point\_t* | 坐标点。 | -

将控件内的本地坐标转换成全局坐标。 +* 函数功能： + +>

将控件内的本地坐标转换成全局坐标。 #### widget\_to\_local 函数 +* 函数原型： + +``` +ret_t widget_to_local (widget_t* widget, point_t* p); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1193,12 +1926,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | p | point\_t* | 坐标点。 | -

将屏幕坐标转换成控件内的本地坐标，即相对于控件左上角的坐标。 +* 函数功能： + +>

将屏幕坐标转换成控件内的本地坐标，即相对于控件左上角的坐标。 #### widget\_to\_screen 函数 +* 函数原型： + +``` +ret_t widget_to_screen (widget_t* widget, point_t* p); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1206,12 +1949,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | p | point\_t* | 坐标点。 | -

将控件内的本地坐标转换成屏幕上的坐标。 +* 函数功能： + +>

将控件内的本地坐标转换成屏幕上的坐标。 #### widget\_ungrab 函数 +* 函数原型： + +``` +ret_t widget_ungrab (widget_t* widget, widget_t* child); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1219,12 +1972,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | child | widget\_t* | 子控件对象。 | -

让指定子控件放弃抓住事件。 +* 函数功能： + +>

让指定子控件放弃抓住事件。 #### widget\_unload\_asset 函数 +* 函数原型： + +``` +ret_t widget_unload_asset (widget_t* widget, const asset_info_t* asset); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1232,7 +1995,9 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | asset | const asset\_info\_t* | 资源句柄。 | -

卸载资源。 +* 函数功能： + +>

卸载资源。 使用示例： @@ -1246,6 +2011,14 @@ #### widget\_use\_style 函数 +* 函数原型： + +``` +ret_t widget_use_style (widget_t* widget, char* style); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -1253,14 +2026,16 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | style | char* | style的名称。 | -

启用指定的主题。 +* 函数功能： + +>

启用指定的主题。 #### animation 属性 ----------------------- -

动画参数。请参考[控件动画](https://github.com/zlgopen/awtk/blob/master/docs/widget_animator.md) +>

动画参数。请参考[控件动画](https://github.com/zlgopen/awtk/blob/master/docs/widget_animator.md) @@ -1278,7 +2053,7 @@ | 支通过widget_set_prop修改 | 是 | #### astyle 属性 ----------------------- -

Style对象。 +>

Style对象。 @@ -1296,7 +2071,7 @@ | 支通过widget_set_prop修改 | 否 | #### auto\_created 属性 ----------------------- -

是否由父控件自动创建。 +>

是否由父控件自动创建。 @@ -1314,7 +2089,7 @@ | 支通过widget_set_prop修改 | 否 | #### can\_not\_destroy 属性 ----------------------- -

标识控件目前不能被销毁(比如正在分发事件)，如果此时调用widget\_destroy，自动异步处理。 +>

标识控件目前不能被销毁(比如正在分发事件)，如果此时调用widget\_destroy，自动异步处理。 @@ -1332,7 +2107,7 @@ | 支通过widget_set_prop修改 | 否 | #### children 属性 ----------------------- -

全部子控件。 +>

全部子控件。 @@ -1350,7 +2125,7 @@ | 支通过widget_set_prop修改 | 否 | #### children\_layout 属性 ----------------------- -

子控件布局器。请参考[控件布局参数](https://github.com/zlgopen/awtk/blob/master/docs/layout.md) +>

子控件布局器。请参考[控件布局参数](https://github.com/zlgopen/awtk/blob/master/docs/layout.md) @@ -1368,7 +2143,7 @@ | 支通过widget_set_prop修改 | 是 | #### custom\_props 属性 ----------------------- -

自定义属性。 +>

自定义属性。 @@ -1386,7 +2161,7 @@ | 支通过widget_set_prop修改 | 否 | #### destroying 属性 ----------------------- -

标识控件正在被销毁。 +>

标识控件正在被销毁。 @@ -1404,7 +2179,7 @@ | 支通过widget_set_prop修改 | 否 | #### dirty 属性 ----------------------- -

标识控件是否需要重绘。 +>

标识控件是否需要重绘。 @@ -1422,7 +2197,7 @@ | 支通过widget_set_prop修改 | 否 | #### emitter 属性 ----------------------- -

事件发射器。 +>

事件发射器。 @@ -1440,7 +2215,7 @@ | 支通过widget_set_prop修改 | 否 | #### enable 属性 ----------------------- -

启用/禁用状态。 +>

启用/禁用状态。 @@ -1458,7 +2233,7 @@ | 支通过widget_set_prop修改 | 是 | #### floating 属性 ----------------------- -

标识控件是否启用浮动布局，不受父控件的children_layout的控制。 +>

标识控件是否启用浮动布局，不受父控件的children_layout的控制。 @@ -1476,7 +2251,7 @@ | 支通过widget_set_prop修改 | 是 | #### focused 属性 ----------------------- -

是否得到焦点。 +>

是否得到焦点。 @@ -1494,7 +2269,7 @@ | 支通过widget_set_prop修改 | 否 | #### grab\_widget 属性 ----------------------- -

grab事件的子控件。 +>

grab事件的子控件。 @@ -1512,7 +2287,7 @@ | 支通过widget_set_prop修改 | 否 | #### h 属性 ----------------------- -

高度。 +>

高度。 @@ -1530,7 +2305,7 @@ | 支通过widget_set_prop修改 | 是 | #### key\_target 属性 ----------------------- -

接收按键事件的子控件。 +>

接收按键事件的子控件。 @@ -1548,7 +2323,7 @@ | 支通过widget_set_prop修改 | 否 | #### name 属性 ----------------------- -

控件名字。 +>

控件名字。 @@ -1566,7 +2341,7 @@ | 支通过widget_set_prop修改 | 是 | #### need\_relayout\_children 属性 ----------------------- -

标识控件是否需要重新layout子控件。 +>

标识控件是否需要重新layout子控件。 @@ -1584,7 +2359,7 @@ | 支通过widget_set_prop修改 | 否 | #### opacity 属性 ----------------------- -

不透明度(0-255)，0完全透明，255完全不透明。 +>

不透明度(0-255)，0完全透明，255完全不透明。 @@ -1602,7 +2377,7 @@ | 支通过widget_set_prop修改 | 否 | #### parent 属性 ----------------------- -

父控件 +>

父控件 @@ -1620,7 +2395,7 @@ | 支通过widget_set_prop修改 | 否 | #### self\_layout 属性 ----------------------- -

控件布局器。请参考[控件布局参数](https://github.com/zlgopen/awtk/blob/master/docs/layout.md) +>

控件布局器。请参考[控件布局参数](https://github.com/zlgopen/awtk/blob/master/docs/layout.md) @@ -1636,9 +2411,27 @@ | 可在XML中设置 | 是 | | 支通过widget_get_prop读取 | 是 | | 支通过widget_set_prop修改 | 是 | +#### sensitive 属性 +----------------------- +>

是否接受用户事件。 + + + +* 类型：bool\_t + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 是 | +| 可持久化 | 是 | +| 可脚本化 | 是 | +| 可在IDE中设置 | 是 | +| 可在XML中设置 | 是 | +| 支通过widget_get_prop读取 | 是 | +| 支通过widget_set_prop修改 | 是 | #### state 属性 ----------------------- -

控件的状态(取值参考widget_state_t)。 +>

控件的状态(取值参考widget_state_t)。 @@ -1656,7 +2449,7 @@ | 支通过widget_set_prop修改 | 否 | #### style 属性 ----------------------- -

style的名称。 +>

style的名称。 @@ -1674,7 +2467,7 @@ | 支通过widget_set_prop修改 | 是 | #### target 属性 ----------------------- -

接收事件的子控件。 +>

接收事件的子控件。 @@ -1692,7 +2485,7 @@ | 支通过widget_set_prop修改 | 否 | #### text 属性 ----------------------- -

文本。用途视具体情况而定。 +>

文本。用途视具体情况而定。 @@ -1710,7 +2503,7 @@ | 支通过widget_set_prop修改 | 否 | #### tr\_text 属性 ----------------------- -

保存用于翻译的字符串。 +>

保存用于翻译的字符串。 @@ -1728,7 +2521,7 @@ | 支通过widget_set_prop修改 | 是 | #### visible 属性 ----------------------- -

是否可见。 +>

是否可见。 @@ -1746,7 +2539,7 @@ | 支通过widget_set_prop修改 | 是 | #### vt 属性 ----------------------- -

虚函数表。 +>

虚函数表。 @@ -1764,7 +2557,7 @@ | 支通过widget_set_prop修改 | 否 | #### w 属性 ----------------------- -

宽度。 +>

宽度。 @@ -1782,7 +2575,7 @@ | 支通过widget_set_prop修改 | 是 | #### x 属性 ----------------------- -

x坐标(相对于父控件的x坐标)。 +>

x坐标(相对于父控件的x坐标)。 @@ -1800,7 +2593,7 @@ | 支通过widget_set_prop修改 | 是 | #### y 属性 ----------------------- -

y坐标(相对于父控件的y坐标)。 +>

y坐标(相对于父控件的y坐标)。 diff --git a/docs/manual/window_animator_t.md b/docs/manual/window_animator_t.md index 18a30282de..07ff21a235 100644 --- a/docs/manual/window_animator_t.md +++ b/docs/manual/window_animator_t.md @@ -22,6 +22,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### window\_animator\_create\_for\_close 函数 +* 函数原型： + +``` +window_animator_t* window_animator_create_for_close (char* type, canvas_t* c, widget_t* prev_win, widget_t* curr_win); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -31,12 +39,22 @@ | c | canvas\_t* | canvas。 | | prev\_win | widget\_t* | 前一窗口。 | | curr\_win | widget\_t* | 当前窗口。 | -

为关闭窗口创建动画。 +* 函数功能： + +>

为关闭窗口创建动画。 #### window\_animator\_create\_for\_open 函数 +* 函数原型： + +``` +window_animator_t* window_animator_create_for_open (char* type, canvas_t* c, widget_t* prev_win, widget_t* curr_win); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -46,24 +64,44 @@ | c | canvas\_t* | canvas。 | | prev\_win | widget\_t* | 前一窗口。 | | curr\_win | widget\_t* | 当前窗口。 | -

为打开窗口创建动画。 +* 函数功能： + +>

为打开窗口创建动画。 #### window\_animator\_destroy 函数 +* 函数原型： + +``` +ret_t window_animator_destroy (window_animator_t* wa); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | wa | window\_animator\_t* | 窗口动画对象。 | -

销毁窗口动画对象。 +* 函数功能： + +>

销毁窗口动画对象。 #### window\_animator\_update 函数 +* 函数原型： + +``` +ret_t window_animator_update (window_animator_t* wa, canvas_t* canvas, uint32_t time_ms); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -72,7 +110,9 @@ | wa | window\_animator\_t* | 窗口动画对象。 | | canvas | canvas\_t* | 画布对象。 | | time\_ms | uint32\_t | 当前时间(毫秒)。 | -

更新动画。 +* 函数功能： + +>

更新动画。 diff --git a/docs/manual/window_base_t.md b/docs/manual/window_base_t.md index 0a7648d8eb..f94e4aeb8f 100644 --- a/docs/manual/window_base_t.md +++ b/docs/manual/window_base_t.md @@ -1,8 +1,8 @@ ## window\_base\_t ### 概述 - 窗口。 ![image](images/window_base_t_0.png) + 窗口。 ### 函数

@@ -26,7 +26,7 @@ | -------- | ----- | ------- | #### closable 属性 ----------------------- -

收到EVT_REQUEST_CLOSE_WINDOW是否自动关闭窗口。 +>

收到EVT_REQUEST_CLOSE_WINDOW是否自动关闭窗口。 如果关闭窗口时，需要用户确认: * 1.将closable设置为WINDOW_CLOSABLE_CONFIRM * 2.处理窗口的EVT_REQUEST_CLOSE_WINDOW事件 @@ -46,7 +46,7 @@ | 支通过widget_set_prop修改 | 是 | #### close\_anim\_hint 属性 ----------------------- -

关闭时的动画名称。 +>

关闭时的动画名称。 * 类型：char* @@ -63,7 +63,7 @@ | 支通过widget_set_prop修改 | 是 | #### open\_anim\_hint 属性 ----------------------- -

打开时的动画名称。 +>

打开时的动画名称。 * 类型：char* @@ -80,7 +80,7 @@ | 支通过widget_set_prop修改 | 是 | #### script 属性 ----------------------- -

脚本文件名称(暂时没用)。 +>

脚本文件名称(暂时没用)。 * 类型：char* @@ -97,7 +97,7 @@ | 支通过widget_set_prop修改 | 是 | #### stage 属性 ----------------------- -

窗口当前处于的状态。 +>

窗口当前处于的状态。 * 类型：char* @@ -114,7 +114,7 @@ | 支通过widget_set_prop修改 | 否 | #### theme 属性 ----------------------- -

主题资源的名称。 +>

主题资源的名称。 * 类型：char* diff --git a/docs/manual/window_event_t.md b/docs/manual/window_event_t.md index 49f198c47b..19a38345a0 100644 --- a/docs/manual/window_event_t.md +++ b/docs/manual/window_event_t.md @@ -1,9 +1,9 @@ ## window\_event\_t ### 概述 - 窗口事件，由窗口管理器触发。 - ![image](images/window_event_t_0.png) + 窗口事件，由窗口管理器触发。 + ### 函数

@@ -24,6 +24,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### event\_init 函数 +* 函数原型： + +``` +event_t event_init (uint32_t type, void* target); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -31,12 +39,22 @@ | 返回值 | event\_t | 事件对象。 | | type | uint32\_t | 事件类型。 | | target | void* | 目标对象。 | -

初始化事件。 +* 函数功能： + +>

初始化事件。 #### pointer\_event\_rotate 函数 +* 函数原型： + +``` +ret_t pointer_event_rotate (pointer_event_t* evt, system_info_t* info); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -44,26 +62,38 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | evt | pointer\_event\_t* | 指针事件对象。 | | info | system\_info\_t* | 系统信息。 | -

根据屏幕旋转方向修正pointer_event中的坐标。 +* 函数功能： + +>

根据屏幕旋转方向修正pointer_event中的坐标。 #### window\_event\_cast 函数 +* 函数原型： + +``` +window_event_t* window_event_cast (event_t* event); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | window\_event\_t* | 对象。 | | event | event\_t* | event对象。 | -

把event对象转window_event_t对象。主要给脚本语言使用。 +* 函数功能： + +>

把event对象转window_event_t对象。主要给脚本语言使用。 #### window 属性 ----------------------- -

canvas。 +>

canvas。 diff --git a/docs/manual/window_manager_t.md b/docs/manual/window_manager_t.md index a59f82a0c4..e681bc977b 100644 --- a/docs/manual/window_manager_t.md +++ b/docs/manual/window_manager_t.md @@ -1,8 +1,8 @@ ## window\_manager\_t ### 概述 - 窗口管理器。 ![image](images/window_manager_t_0.png) + 窗口管理器。 ### 函数

@@ -34,27 +34,55 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### window\_manager 函数 +* 函数原型： + +``` +widget_t* window_manager (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | 对象。 | -

获取全局window_manager对象 +* 函数功能： + +>

获取全局window_manager对象 #### window\_manager\_cast 函数 +* 函数原型： + +``` +widget_t* window_manager_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | window\_manager对象。 | | widget | widget\_t* | window\_manager对象。 | -

转换为window_manager对象(供脚本语言使用)。 +* 函数功能： + +>

转换为window_manager对象(供脚本语言使用)。 #### window\_manager\_close\_window 函数 +* 函数原型： + +``` +ret_t window_manager_close_window (widget_t* widget, widget_t* window); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -62,11 +90,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 窗口管理器对象。 | | window | widget\_t* | 窗口对象。 | -

关闭窗口。 +* 函数功能： + +>

关闭窗口。 #### window\_manager\_close\_window\_force 函数 +* 函数原型： + +``` +ret_t window_manager_close_window_force (widget_t* widget, widget_t* window); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -74,21 +112,41 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 窗口管理器对象。 | | window | widget\_t* | 窗口对象。 | -

强制立即关闭窗口。 +* 函数功能： + +>

强制立即关闭窗口。 #### window\_manager\_create 函数 +* 函数原型： + +``` +window_manager_t* window_manager_create (); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | window\_manager\_t* | 返回窗口管理器对象。 | -

创建窗口管理器。 +* 函数功能： + +>

创建窗口管理器。 #### window\_manager\_dispatch\_input\_event 函数 +* 函数原型： + +``` +ret_t window_manager_dispatch_input_event (widget_t* widget, event_t* e); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -96,33 +154,63 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 窗口管理器对象。 | | e | event\_t* | 事件对象。 | -

分发输入事件。 +* 函数功能： + +>

分发输入事件。 #### window\_manager\_get\_top\_main\_window 函数 +* 函数原型： + +``` +widget_t* window_manager_get_top_main_window (window_manager_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | 返回窗口对象。 | | widget | window\_manager\_t* | 窗口管理器对象。 | -

获取最上面的主窗口。 +* 函数功能： + +>

获取最上面的主窗口。 #### window\_manager\_init 函数 +* 函数原型： + +``` +widget_t* window_manager_init (window_manager_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | 返回窗口管理器对象。 | | widget | window\_manager\_t* | 窗口管理器对象。 | -

初始化窗口管理器。 +* 函数功能： + +>

初始化窗口管理器。 #### window\_manager\_open\_window 函数 +* 函数原型： + +``` +ret_t window_manager_open_window (widget_t* widget, widget_t* window); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -130,11 +218,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 窗口管理器对象。 | | window | widget\_t* | 窗口对象。 | -

打开窗口。 +* 函数功能： + +>

打开窗口。 #### window\_manager\_paint 函数 +* 函数原型： + +``` +ret_t window_manager_paint (widget_t* widget, canvas_t* c); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -142,11 +240,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 窗口管理器对象。 | | c | canvas\_t* | 画布。 | -

绘制。 +* 函数功能： + +>

绘制。 #### window\_manager\_resize 函数 +* 函数原型： + +``` +ret_t window_manager_resize (widget_t* widget, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -155,22 +263,42 @@ | widget | widget\_t* | 窗口管理器对象。 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

调整窗口管理器的大小。 +* 函数功能： + +>

调整窗口管理器的大小。 #### window\_manager\_set 函数 +* 函数原型： + +``` +ret_t window_manager_set (window_manager_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | window\_manager\_t* | 窗口管理器对象。 | -

设置缺省的窗口管理器。 +* 函数功能： + +>

设置缺省的窗口管理器。 #### window\_manager\_set\_cursor 函数 +* 函数原型： + +``` +ret_t window_manager_set_cursor (widget_t* widget, const char* cursor); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -178,11 +306,21 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 窗口管理器对象。 | | cursor | const char* | 图片名称(从图片管理器中加载)。 | -

设置鼠标指针。 +* 函数功能： + +>

设置鼠标指针。 #### window\_manager\_set\_show\_fps 函数 +* 函数原型： + +``` +ret_t window_manager_set_show_fps (widget_t* widget, bool_t show_fps); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -190,13 +328,15 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 窗口管理器对象。 | | show\_fps | bool\_t | 是否显示FPS。 | -

设置是否显示FPS。 +* 函数功能： + +>

设置是否显示FPS。 #### show\_fps 属性 ----------------------- -

是否显示fps。 +>

是否显示fps。 * 类型：bool\_t diff --git a/docs/manual/window_t.md b/docs/manual/window_t.md index a31718eac0..e6114d07a3 100644 --- a/docs/manual/window_t.md +++ b/docs/manual/window_t.md @@ -1,8 +1,8 @@ ## window\_t ### 概述 - 窗口。 ![image](images/window_t_0.png) + 窗口。 ### 函数

@@ -24,28 +24,56 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### window\_cast 函数 +* 函数原型： + +``` +widget_t* window_cast (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | window对象。 | | widget | widget\_t* | window对象。 | -

转换为window对象(供脚本语言使用)。 +* 函数功能： + +>

转换为window对象(供脚本语言使用)。 #### window\_close 函数 +* 函数原型： + +``` +ret_t window_close (widget_t* widget); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | window\_base对象。 | -

关闭窗口。 +* 函数功能： + +>

关闭窗口。 #### window\_create 函数 +* 函数原型： + +``` +widget_t* window_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -56,22 +84,42 @@ | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | -

创建window对象 +* 函数功能： + +>

创建window对象 #### window\_open 函数 +* 函数原型： + +``` +widget_t* window_open (char* name); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | 对象。 | | name | char* | window\_base的名称。 | -

从资源文件中加载并创建window_base对象。本函数在ui_loader/ui_builder_default里实现。 +* 函数功能： + +>

从资源文件中加载并创建window_base对象。本函数在ui_loader/ui_builder_default里实现。 #### window\_open\_and\_close 函数 +* 函数原型： + +``` +widget_t* window_open_and_close (char* name, widget_t* to_close); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -79,7 +127,9 @@ | 返回值 | widget\_t* | 对象。 | | name | char* | window\_base的名称。 | | to\_close | widget\_t* | 关闭该窗口。 | -

从资源文件中加载并创建window_base对象。本函数在ui_loader/ui_builder_default里实现。 +* 函数功能： + +>

从资源文件中加载并创建window_base对象。本函数在ui_loader/ui_builder_default里实现。 diff --git a/docs/manual/wstr_t.md b/docs/manual/wstr_t.md index d512a18c2c..ecdee779a8 100644 --- a/docs/manual/wstr_t.md +++ b/docs/manual/wstr_t.md @@ -40,6 +40,14 @@ | 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | #### wstr\_add\_float 函数 +* 函数原型： + +``` +ret_t wstr_add_float (wstr_t* str, double delta); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -47,12 +55,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | | delta | double | 要加上的值。 | -

将字符串转成浮点数，加上delta，再转换回来。 +* 函数功能： + +>

将字符串转成浮点数，加上delta，再转换回来。 #### wstr\_equal 函数 +* 函数原型： + +``` +bool_t wstr_equal (wstr_t* str, wstr_t* other); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -60,12 +78,22 @@ | 返回值 | bool\_t | 返回TRUE表示相同，否则表示不同。 | | str | wstr\_t* | str对象。 | | other | wstr\_t* | str对象。 | -

判断两个字符是否相同。 +* 函数功能： + +>

判断两个字符是否相同。 #### wstr\_from\_float 函数 +* 函数原型： + +``` +ret_t wstr_from_float (wstr_t* str, double v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -73,12 +101,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | | v | double | 浮点数。 | -

用浮点数初始化字符串。 +* 函数功能： + +>

用浮点数初始化字符串。 #### wstr\_from\_int 函数 +* 函数原型： + +``` +ret_t wstr_from_int (wstr_t* str, int32_t v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -86,12 +124,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | | v | int32\_t | 整数。 | -

用整数初始化字符串。 +* 函数功能： + +>

用整数初始化字符串。 #### wstr\_from\_value 函数 +* 函数原型： + +``` +ret_t wstr_from_value (wstr_t* str, value_t v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -99,12 +147,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | | v | value\_t | value。 | -

用value初始化字符串。 +* 函数功能： + +>

用value初始化字符串。 #### wstr\_get\_utf8 函数 +* 函数原型： + +``` +ret_t wstr_get_utf8 (wstr_t* str, char* text, uint32_t size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -113,12 +171,22 @@ | str | wstr\_t* | str对象。 | | text | char* | 返回的字符串。 | | size | uint32\_t | text最大长度。 | -

获取UTF8字符串。 +* 函数功能： + +>

获取UTF8字符串。 #### wstr\_init 函数 +* 函数原型： + +``` +wstr_t* wstr_init (wstr_t* str, uint32_t capacity); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -126,12 +194,22 @@ | 返回值 | wstr\_t* | str对象本身。 | | str | wstr\_t* | str对象。 | | capacity | uint32\_t | 初始容量。 | -

初始化字符串对象。 +* 函数功能： + +>

初始化字符串对象。 #### wstr\_insert 函数 +* 函数原型： + +``` +ret_t wstr_insert (wstr_t* str, uint32_t offset, wchar_t* text, uint32_t nr); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -141,24 +219,44 @@ | offset | uint32\_t | 指定的位置。 | | text | wchar\_t* | 待插入的文本。 | | nr | uint32\_t | 要插入的字符数。 | -

在指定位置插入字符串。 +* 函数功能： + +>

在指定位置插入字符串。 #### wstr\_pop 函数 +* 函数原型： + +``` +ret_t wstr_pop (wstr_t* str); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | -

删除尾部字符。 +* 函数功能： + +>

删除尾部字符。 #### wstr\_push 函数 +* 函数原型： + +``` +ret_t wstr_push (wstr_t* str, wchar_t c); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -166,12 +264,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | | c | wchar\_t | 字符。 | -

追加一个字符。 +* 函数功能： + +>

追加一个字符。 #### wstr\_push\_int 函数 +* 函数原型： + +``` +ret_t wstr_push_int (wstr_t* str, const char* format, int32_t value); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -180,12 +288,22 @@ | str | wstr\_t* | str对象。 | | format | const char* | 格式(用于snprintf格式化数值) | | value | int32\_t | 数值。 | -

追加一个整数。 +* 函数功能： + +>

追加一个整数。 #### wstr\_push\_str 函数 +* 函数原型： + +``` +ret_t wstr_push_str (wstr_t* str, wchar_t* s, uint32_t size); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -194,12 +312,22 @@ | str | wstr\_t* | str对象。 | | s | wchar\_t* | 字符串。 | | size | uint32\_t | 字符串长度。 | -

追加一个字符。 +* 函数功能： + +>

追加一个字符。 #### wstr\_remove 函数 +* 函数原型： + +``` +ret_t wstr_remove (wstr_t* str, uint32_t offset, uint32_t nr); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -208,24 +336,44 @@ | str | wstr\_t* | str对象。 | | offset | uint32\_t | 指定的位置。 | | nr | uint32\_t | 要删除的字符数。 | -

删除指定范围的字符。 +* 函数功能： + +>

删除指定范围的字符。 #### wstr\_reset 函数 +* 函数原型： + +``` +ret_t wstr_reset (wstr_t* str); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | -

重置字符串为空。 +* 函数功能： + +>

重置字符串为空。 #### wstr\_set 函数 +* 函数原型： + +``` +ret_t wstr_set (wstr_t* str, wchar_t* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -233,12 +381,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | | text | wchar\_t* | 要设置的字符串。 | -

设置字符串。 +* 函数功能： + +>

设置字符串。 #### wstr\_set\_utf8 函数 +* 函数原型： + +``` +ret_t wstr_set_utf8 (wstr_t* str, char* text); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -246,12 +404,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | | text | char* | 要设置的字符串。 | -

设置UTF8字符串。 +* 函数功能： + +>

设置UTF8字符串。 #### wstr\_to\_float 函数 +* 函数原型： + +``` +ret_t wstr_to_float (wstr_t* str, double* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -259,12 +427,22 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | | v | double* | 用于返回浮点数。 | -

将字符串转成浮点数。 +* 函数功能： + +>

将字符串转成浮点数。 #### wstr\_to\_int 函数 +* 函数原型： + +``` +ret_t wstr_to_int (wstr_t* str, int32_t* v); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | @@ -272,26 +450,38 @@ | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | | v | int32\_t* | 用于返回整数。 | -

将字符串转成整数。 +* 函数功能： + +>

将字符串转成整数。 #### wstr\_trim\_float\_zero 函数 +* 函数原型： + +``` +ret_t wstr_trim_float_zero (wstr_t* str); +``` + +* 参数说明： + ----------------------- | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | str | wstr\_t* | str对象。 | -

去掉浮点数小数点尾部的零。 +* 函数功能： + +>

去掉浮点数小数点尾部的零。 #### capacity 属性 ----------------------- -

容量。 +>

容量。 @@ -309,7 +499,7 @@ | 支通过widget_set_prop修改 | 否 | #### size 属性 ----------------------- -

长度。 +>

长度。 @@ -327,7 +517,7 @@ | 支通过widget_set_prop修改 | 否 | #### str 属性 ----------------------- -

字符串。 +>

字符串。 diff --git a/src/widgets/label.h b/src/widgets/label.h index 05b80ed21a..221d1b9e3a 100644 --- a/src/widgets/label.h +++ b/src/widgets/label.h @@ -30,7 +30,42 @@ BEGIN_C_DECLS * @class label_t * @parent widget_t * @annotation ["scriptable"] - * 文本控件。 + * + * 文本控件，用于显示一行或多行文本。 + * 文本控件不会根据文本的长度自动换行，只有文本内容包含换行符时才会换行。 + * 如需自动换行请使用[rich\_text\_t](rich_text_t.md)控件。 + * + * label\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于label\_t控件。 + * + * 在xml中使用"label"标签创建文本控件。如： + * + * ```xml + *