From f556b4cc5b753854b472d5f4e9f2a29f1d79037c Mon Sep 17 00:00:00 2001 From: lixianjing Date: Wed, 13 Oct 2021 09:51:38 +0800 Subject: [PATCH] update docs --- docs/manual/async_t.md | 10 +- docs/manual/bitmap_t.md | 42 +++ docs/manual/canvas_t.md | 84 +++++- docs/manual/check_button_t.md | 14 + docs/manual/combo_box_t.md | 21 ++ docs/manual/conf_doc_t.md | 46 +++ docs/manual/darray_t.md | 133 +++++++++ docs/manual/edit_t.md | 4 +- docs/manual/ext_widgets_t.md | 28 ++ docs/manual/fscript_t.md | 20 ++ docs/manual/gradient_stop_t.md | 31 ++ docs/manual/gradient_t.md | 343 +++++++++++++++++++++++ docs/manual/gradient_type_t.md | 11 + docs/manual/hscroll_label_t.md | 9 +- docs/manual/image_manager_t.md | 21 ++ docs/manual/images/object_widget_t_0.png | Bin 0 -> 4167 bytes docs/manual/lcd_fb_dirty_rects_t.md | 158 +++++++++++ docs/manual/lcd_t.md | 6 +- docs/manual/main_loop_t.md | 20 ++ docs/manual/mledit_t.md | 60 ++++ docs/manual/named_value_t.md | 63 +++++ docs/manual/native_window_t.md | 43 +++ docs/manual/object_default_t.md | 59 ++-- docs/manual/object_t.md | 50 +++- docs/manual/object_widget_t.md | 48 ++++ docs/manual/orientation_event_t.md | 19 +- docs/manual/rect_t.md | 61 ++++ docs/manual/socket.md | 19 ++ docs/manual/style_t.md | 22 ++ docs/manual/tab_button_group_t.md | 16 ++ docs/manual/text_edit_t.md | 43 +++ docs/manual/text_selector_t.md | 38 +++ docs/manual/value_t.md | 42 +++ docs/manual/value_type_t.md | 1 + docs/manual/velocity_t.md | 4 +- docs/manual/vg_gradient_t.md | 127 ++------- docs/manual/widget_factory_t.md | 21 ++ docs/manual/widget_prop_t.md | 1 + docs/manual/widget_t.md | 20 ++ docs/manual/window_animator_t.md | 4 +- docs/manual/window_t.md | 6 +- docs/manual/wstr_t.md | 22 ++ 42 files changed, 1615 insertions(+), 175 deletions(-) create mode 100644 docs/manual/ext_widgets_t.md create mode 100644 docs/manual/gradient_stop_t.md create mode 100644 docs/manual/gradient_t.md create mode 100644 docs/manual/gradient_type_t.md create mode 100644 docs/manual/images/object_widget_t_0.png create mode 100644 docs/manual/lcd_fb_dirty_rects_t.md create mode 100644 docs/manual/object_widget_t.md diff --git a/docs/manual/async_t.md b/docs/manual/async_t.md index 81569f2fc..3e6cc5052 100644 --- a/docs/manual/async_t.md +++ b/docs/manual/async_t.md @@ -9,7 +9,7 @@ | -------- | ------------ | | async\_call | 异步执行exec函数，执行完成后，在后台线程调用on_result函数。 | | async\_call\_deinit | 全局~初始化。 | -| async\_call\_init | 全局初始化。 | +| async\_call\_init\_ex | 全局初始化。 | #### async\_call 函数 ----------------------- @@ -49,17 +49,17 @@ ret_t async_call_deinit (); | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | -#### async\_call\_init 函数 +#### async\_call\_init\_ex 函数 ----------------------- * 函数功能： ->

全局初始化。 +>

全局初始化。 * 函数原型： ``` -ret_t async_call_init (); +ret_t async_call_init_ex (uint32_t max_threads, uint32_t min_threads); ``` * 参数说明： @@ -67,3 +67,5 @@ ret_t async_call_init (); | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| max\_threads | uint32\_t | 最大线程数。 | +| min\_threads | uint32\_t | 最小线程数。 | diff --git a/docs/manual/bitmap_t.md b/docs/manual/bitmap_t.md index b2c61f72f..8be4f81f0 100644 --- a/docs/manual/bitmap_t.md +++ b/docs/manual/bitmap_t.md @@ -7,6 +7,7 @@ | 函数名称 | 说明 | | -------- | ------------ | +| bitmap\_clone | Clone图片。 | | bitmap\_create | 创建图片对象(一般供脚本语言中使用)。 | | bitmap\_create\_ex | 创建图片对象。 | | bitmap\_destroy | 销毁图片。 | @@ -23,6 +24,7 @@ | bitmap\_mono\_dump | dump mono bitmap。 | | bitmap\_save\_png | 把bitmap保存为png。 | | bitmap\_set\_line\_length | 设置line_length。 | +| bitmap\_transform | 对图片每个像素进行变换。 | | bitmap\_unlock\_buffer | 解锁图像缓冲区。 | ### 属性

@@ -36,6 +38,25 @@ | line\_length | uint32\_t | 每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。 | | name | const char* | 名称。 | | w | wh\_t | 宽度。 | +#### bitmap\_clone 函数 +----------------------- + +* 函数功能： + +>

Clone图片。 + +* 函数原型： + +``` +bitmap_t* bitmap_clone (bitmap_t* bitmap); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | bitmap\_t* | 返回新的bitmap对象。 | +| bitmap | bitmap\_t* | bitmap对象。 | #### bitmap\_create 函数 ----------------------- @@ -365,6 +386,27 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length); | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | bitmap | bitmap\_t* | bitmap对象。 | | line\_length | uint32\_t | line\_length。 | +#### bitmap\_transform 函数 +----------------------- + +* 函数功能： + +>

对图片每个像素进行变换。 + +* 函数原型： + +``` +ret_t bitmap_transform (bitmap_t* bitmap, bitmap_transform_t transform, void* ctx); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| bitmap | bitmap\_t* | bitmap对象。 | +| transform | bitmap\_transform\_t | 回调函数。 | +| ctx | void* | 回调函数的上下文。 | #### bitmap\_unlock\_buffer 函数 ----------------------- diff --git a/docs/manual/canvas_t.md b/docs/manual/canvas_t.md index a12f91d8a..5d8fcfac2 100644 --- a/docs/manual/canvas_t.md +++ b/docs/manual/canvas_t.md @@ -26,8 +26,11 @@ | canvas\_draw\_vline | 画垂直线。 | | canvas\_end\_frame | 绘制结束。 | | canvas\_fill\_rect | 绘制矩形。 | +| canvas\_fill\_rect\_gradient | 绘制矩形。 | | canvas\_fill\_rounded\_rect | 填充区域。 | -| canvas\_fill\_rounded\_rect\_ex | 填充区域。 | +| canvas\_fill\_rounded\_rect\_ex | 填充圆角矩形区域。 | +| canvas\_fill\_rounded\_rect\_gradient | 填充圆角矩形区域。 | +| canvas\_fill\_rounded\_rect\_gradient\_ex | 填充圆角矩形区域。 | | canvas\_get\_clip\_rect | 获取裁剪区。 | | canvas\_get\_font\_height | 获取字体的高度。 | | canvas\_get\_height | 获取画布的高度。 | @@ -501,6 +504,30 @@ ret_t canvas_fill_rect (canvas_t* c, xy_t x, xy_t y, wh_t w, wh_t h); | y | xy\_t | y坐标。 | | w | wh\_t | 宽度。 | | h | wh\_t | 高度。 | +#### canvas\_fill\_rect\_gradient 函数 +----------------------- + +* 函数功能： + +>

绘制矩形。 + +* 函数原型： + +``` +ret_t canvas_fill_rect_gradient (canvas_t* c, xy_t x, xy_t y, wh_t w, wh_t h, gradient_t* gradient); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| c | canvas\_t* | canvas对象。 | +| x | xy\_t | x坐标。 | +| y | xy\_t | y坐标。 | +| w | wh\_t | 宽度。 | +| h | wh\_t | 高度。 | +| gradient | gradient\_t* | 渐变颜色。 | #### canvas\_fill\_rounded\_rect 函数 ----------------------- @@ -528,14 +555,14 @@ ret_t canvas_fill_rounded_rect (canvas_t* c, const rect_t* r, const color_t* col * 函数功能： ->

填充区域。 +>

填充圆角矩形区域。 半径半径小于等于2，则表示该角为直角，如果全部角都为直角则返回RET_FAIL。（如果全是直角，该函数效率没有canvas_fill_rect函数快） 如果各个半径都不一样的话，就是会使用vg，如果不支持vg就会返回RET_FAIL（直角的情况除外）。 * 函数原型： ``` -ret_t canvas_fill_rounded_rect_ex (canvas_t* c, const rect_t* r, const color_t* color, uint32_t radius_tl, uint32_t radius_tr, uint32_t radius_bl, uint32_t radius_br); +ret_t canvas_fill_rounded_rect_ex (canvas_t* c, const rect_t* r, const rect_t* bg_r, const color_t* color, uint32_t radius_tl, uint32_t radius_tr, uint32_t radius_bl, uint32_t radius_br); ``` * 参数说明： @@ -545,11 +572,62 @@ ret_t canvas_fill_rounded_rect_ex (canvas_t* c, const rect_t* r, const color_t* | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | c | canvas\_t* | canvas对象。 | | r | const rect\_t* | 矩形。 | +| bg\_r | const rect\_t* | 矩形。（默认为 NULL，当圆角直径大于 r 矩形的宽高后，会根据 bg\_r 矩形来决定是否需要缩小圆角半径） | | color | const color\_t* | 颜色。 | | radius\_tl | uint32\_t | 左上角圆角半径。 | | radius\_tr | uint32\_t | 右上角圆角半径。 | | radius\_bl | uint32\_t | 左下角圆角半径。 | | radius\_br | uint32\_t | 右下角圆角半径。 | +#### canvas\_fill\_rounded\_rect\_gradient 函数 +----------------------- + +* 函数功能： + +>

填充圆角矩形区域。 + +* 函数原型： + +``` +ret_t canvas_fill_rounded_rect_gradient (canvas_t* c, const rect_t* r, const gradient_t* gradient, uint32_t radius); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| c | canvas\_t* | canvas对象。 | +| r | const rect\_t* | 矩形。 | +| gradient | const gradient\_t* | 渐变颜色。 | +| radius | uint32\_t | 圆角半径。 | +#### canvas\_fill\_rounded\_rect\_gradient\_ex 函数 +----------------------- + +* 函数功能： + +>

填充圆角矩形区域。 +半径半径小于等于2，则表示该角为直角，如果全部角都为直角则返回RET_FAIL。（如果全是直角，该函数效率没有canvas_fill_rect函数快） +如果各个半径都不一样的话，就是会使用vg，如果不支持vg就会返回RET_FAIL（直角的情况除外）。 + +* 函数原型： + +``` +ret_t canvas_fill_rounded_rect_gradient_ex (canvas_t* c, const rect_t* r, const rect_t* bg_r, const gradient_t* gradient, uint32_t radius_tl, uint32_t radius_tr, uint32_t radius_bl, uint32_t radius_br); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| c | canvas\_t* | canvas对象。 | +| r | const rect\_t* | 矩形。 | +| bg\_r | const rect\_t* | 矩形。（默认为 NULL，当圆角直径大于 r 矩形的宽高后，会根据 bg\_r 矩形来决定是否需要缩小圆角半径） | +| gradient | const gradient\_t* | 渐变颜色。 | +| radius\_tl | uint32\_t | 左上角圆角半径。 | +| radius\_tr | uint32\_t | 右上角圆角半径。 | +| radius\_bl | uint32\_t | 左下角圆角半径。 | +| radius\_br | uint32\_t | 右下角圆角半径。 | #### canvas\_get\_clip\_rect 函数 ----------------------- diff --git a/docs/manual/check_button_t.md b/docs/manual/check_button_t.md index 349491721..4129a8532 100644 --- a/docs/manual/check_button_t.md +++ b/docs/manual/check_button_t.md @@ -72,6 +72,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau | 属性名称 | 类型 | 说明 | | -------- | ----- | ------------ | +| radio | bool\_t | 是否是单选按钮。 | | value | bool\_t | 值(勾选为TRUE，非勾选为FALSE)。 | ### 事件

@@ -185,6 +186,19 @@ ret_t check_button_set_value (widget_t* widget, bool_t value); | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | check\_button对象。 | | value | bool\_t | 值(勾选为TRUE，非勾选为FALSE)。 | +#### radio 属性 +----------------------- +>

是否是单选按钮。 + +* 类型：bool\_t + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 否 | +| 可直接修改 | 否 | +| 可在XML中设置 | 是 | +| 可通过widget\_get\_prop读取 | 是 | +| 可通过widget\_set\_prop修改 | 是 | #### value 属性 ----------------------- >

值(勾选为TRUE，非勾选为FALSE)。 diff --git a/docs/manual/combo_box_t.md b/docs/manual/combo_box_t.md index 86173f4c2..c761c9004 100644 --- a/docs/manual/combo_box_t.md +++ b/docs/manual/combo_box_t.md @@ -125,6 +125,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau | combo\_box\_get\_option | 获取第index个选项。 | | combo\_box\_get\_text | 获取combo_box的文本。 | | combo\_box\_get\_value | 获取combo_box的值。 | +| combo\_box\_remove\_option | 删除选项。 | | combo\_box\_reset\_options | 重置所有选项。 | | combo\_box\_set\_custom\_open\_popup | 设置自定义的打开弹出窗口的函数。 | | combo\_box\_set\_item\_height | 设置item高度。 | @@ -291,6 +292,26 @@ int32_t combo_box_get_value (widget_t* widget); | -------- | ----- | --------- | | 返回值 | int32\_t | 返回值。 | | widget | widget\_t* | combo\_box对象。 | +#### combo\_box\_remove\_option 函数 +----------------------- + +* 函数功能： + +>

删除选项。 + +* 函数原型： + +``` +ret_t combo_box_remove_option (widget_t* widget, int32_t value); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| widget | widget\_t* | combo\_box对象。 | +| value | int32\_t | 值。 | #### combo\_box\_reset\_options 函数 ----------------------- diff --git a/docs/manual/conf_doc_t.md b/docs/manual/conf_doc_t.md index 570135516..0c2efbd5c 100644 --- a/docs/manual/conf_doc_t.md +++ b/docs/manual/conf_doc_t.md @@ -16,8 +16,10 @@ | conf\_doc\_destroy | 析构函数。 | | conf\_doc\_destroy\_node | 销毁节点对象。 | | conf\_doc\_exists | 判断指定路径的节点是否存在。 | +| conf\_doc\_find\_node | 根据path查找节点。 | | conf\_doc\_get | 获取指定路径节点的值。 | | conf\_doc\_get\_bool | 获取指定路径节点的值。 | +| conf\_doc\_get\_ex | 获取指定路径节点的值。 | | conf\_doc\_get\_float | 获取指定路径节点的值。 | | conf\_doc\_get\_int | 获取指定路径节点的值。 | | conf\_doc\_get\_str | 获取指定路径节点的值。 | @@ -221,6 +223,28 @@ bool_t conf_doc_exists (conf_doc_t* doc, const char* path); | 返回值 | bool\_t | 返回TRUE表示成功，FALSE表示失败。 | | doc | conf\_doc\_t* | 文档对象。 | | path | const char* | 节点的路径。 | +#### conf\_doc\_find\_node 函数 +----------------------- + +* 函数功能： + +>

根据path查找节点。 + +* 函数原型： + +``` +ret_t conf_doc_find_node (conf_doc_t* doc, conf_node_t* node, const char* path, bool_t create_if_not_exist); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| doc | conf\_doc\_t* | 文档对象。 | +| node | conf\_node\_t* | 从该节点查找。 | +| path | const char* | 路径。 | +| create\_if\_not\_exist | bool\_t | 不存在是否创建。 | #### conf\_doc\_get 函数 ----------------------- @@ -263,6 +287,28 @@ bool_t conf_doc_get_bool (conf_doc_t* doc, const char* path, bool_t defval); | doc | conf\_doc\_t* | 文档对象。 | | path | const char* | 节点的路径。 | | defval | bool\_t | 缺省值。 | +#### conf\_doc\_get\_ex 函数 +----------------------- + +* 函数功能： + +>

获取指定路径节点的值。 + +* 函数原型： + +``` +ret_t conf_doc_get_ex (conf_doc_t* doc, conf_node_t* node, const char* path, value_t* v); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| doc | conf\_doc\_t* | 文档对象。 | +| node | conf\_node\_t* | 从该节点查找。 | +| path | const char* | 节点的路径。 | +| v | value\_t* | 用于返回值。 | #### conf\_doc\_get\_float 函数 ----------------------- diff --git a/docs/manual/darray_t.md b/docs/manual/darray_t.md index ccd98d401..c0b14df29 100644 --- a/docs/manual/darray_t.md +++ b/docs/manual/darray_t.md @@ -33,7 +33,9 @@ darray_destroy(darray); | darray\_destroy | 销毁darray对象。 | | darray\_find | 查找第一个满足条件的元素。 | | darray\_find\_all | 查找全部满足条件的元素。 | +| darray\_find\_ex | 查找第一个满足条件的元素。 | | darray\_find\_index | 查找第一个满足条件的元素，并返回位置。 | +| darray\_find\_index\_ex | 查找第一个满足条件的元素，并返回位置。 | | darray\_foreach | 遍历元素。 | | darray\_get | 获取指定序数的元素。 | | darray\_head | 返回第一个元素。 | @@ -43,8 +45,12 @@ darray_destroy(darray); | darray\_push | 在尾巴追加一个元素。 | | darray\_remove | 删除第一个满足条件的元素。 | | darray\_remove\_all | 删除全部满足条件的元素。 | +| darray\_remove\_ex | 删除第一个满足条件的元素。 | | darray\_remove\_index | 删除指定位置的元素。 | +| darray\_replace | 设置指定序数的元素(销毁旧的数据)。 | +| darray\_set | 设置指定序数的元素(不销毁旧的数据)。 | | darray\_sort | 排序。 | +| darray\_sorted\_insert | 插入一个元素到有序数组。 | | darray\_tail | 返回最后一个元素。 | ### 属性

@@ -247,6 +253,27 @@ ret_t darray_find_all (darray_t* darray, tk_compare_t cmp, void* ctx, darray_t* | cmp | tk\_compare\_t | 比较函数，为NULL则使用内置的比较函数。 | | ctx | void* | 比较函数的上下文。 | | matched | darray\_t* | 返回满足条件的元素。 | +#### darray\_find\_ex 函数 +----------------------- + +* 函数功能： + +>

查找第一个满足条件的元素。 + +* 函数原型： + +``` +void* darray_find_ex (darray_t* darray, tk_compare_t cmp, void* ctx); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | void* | 如果找到，返回满足条件的对象，否则返回NULL。 | +| darray | darray\_t* | 数组对象。 | +| cmp | tk\_compare\_t | 比较函数，为NULL则使用内置的比较函数。 | +| ctx | void* | 比较函数的上下文。 | #### darray\_find\_index 函数 ----------------------- @@ -267,6 +294,27 @@ int32_t darray_find_index (darray_t* darray, void* ctx); | 返回值 | int32\_t | 如果找到，返回满足条件的对象的位置，否则返回-1。 | | darray | darray\_t* | 数组对象。 | | ctx | void* | 比较函数的上下文。 | +#### darray\_find\_index\_ex 函数 +----------------------- + +* 函数功能： + +>

查找第一个满足条件的元素，并返回位置。 + +* 函数原型： + +``` +int32_t darray_find_index_ex (darray_t* darray, tk_compare_t cmp, void* ctx); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | int32\_t | 如果找到，返回满足条件的对象的位置，否则返回-1。 | +| darray | darray\_t* | 数组对象。 | +| cmp | tk\_compare\_t | 比较函数，为NULL则使用内置的比较函数。 | +| ctx | void* | 比较函数的上下文。 | #### darray\_foreach 函数 ----------------------- @@ -444,6 +492,27 @@ ret_t darray_remove_all (darray_t* darray, tk_compare_t cmp, void* ctx); * 参数说明： +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| darray | darray\_t* | 数组对象。 | +| cmp | tk\_compare\_t | 比较函数，为NULL则使用内置的比较函数。 | +| ctx | void* | 比较函数的上下文。 | +#### darray\_remove\_ex 函数 +----------------------- + +* 函数功能： + +>

删除第一个满足条件的元素。 + +* 函数原型： + +``` +ret_t darray_remove_ex (darray_t* darray, tk_compare_t cmp, void* ctx); +``` + +* 参数说明： + | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | @@ -470,6 +539,48 @@ ret_t darray_remove_index (darray_t* darray, uint32_t index); | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | darray | darray\_t* | 数组对象。 | | index | uint32\_t | 位置序数。 | +#### darray\_replace 函数 +----------------------- + +* 函数功能： + +>

设置指定序数的元素(销毁旧的数据)。 + +* 函数原型： + +``` +ret_t darray_replace (darray_t* darray, uint32_t index, void* data); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| darray | darray\_t* | 数组对象。 | +| index | uint32\_t | 序数。 | +| data | void* | 数据。 | +#### darray\_set 函数 +----------------------- + +* 函数功能： + +>

设置指定序数的元素(不销毁旧的数据)。 + +* 函数原型： + +``` +ret_t darray_set (darray_t* darray, uint32_t index, void* data); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| darray | darray\_t* | 数组对象。 | +| index | uint32\_t | 序数。 | +| data | void* | 数据。 | #### darray\_sort 函数 ----------------------- @@ -490,6 +601,28 @@ ret_t darray_sort (darray_t* darray, tk_compare_t cmp); | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | darray | darray\_t* | 数组对象。 | | cmp | tk\_compare\_t | 比较函数，为NULL则使用内置的比较函数。 | +#### darray\_sorted\_insert 函数 +----------------------- + +* 函数功能： + +>

插入一个元素到有序数组。 + +* 函数原型： + +``` +ret_t darray_sorted_insert (darray_t* darray, void* data, tk_compare_t compare, bool_t replace_if_exist); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| darray | darray\_t* | 数组对象。 | +| data | void* | 待插入的元素。 | +| compare | tk\_compare\_t | 元素比较函数。 | +| replace\_if\_exist | bool\_t | 如果存在是否替换。 | #### darray\_tail 函数 ----------------------- diff --git a/docs/manual/edit_t.md b/docs/manual/edit_t.md index cca0594e8..61147c031 100644 --- a/docs/manual/edit_t.md +++ b/docs/manual/edit_t.md @@ -104,7 +104,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau | cancelable | bool\_t | 是否支持撤销编辑。如果为TRUE，在失去焦点之前可以撤销所有修改(恢复获得焦点之前的内容)。 | | close\_im\_when\_blured | bool\_t | 是否在失去焦点时关闭输入法(默认是)。 | | input\_type | input\_type\_t | 输入类型。 | -| keyboard | char* | 自定义软键盘名称。AWTK优先查找keyboard属性设置的键盘文件名（该键盘的XML文件需要在default\raw\ui目录下存在），如果keyboard为空就找input_type设置的键盘类型 | +| keyboard | char* | 自定义软键盘名称。AWTK优先查找keyboard属性设置的键盘文件名（该键盘的XML文件需要在default\raw\ui目录下存在），如果没有指定keyboard，就找input_type设置的键盘类型。如果指定为空字符串，则表示不需要软键盘。 | | max | double | 最大值或最大长度。 | | min | double | 最小值或最小长度。 | | open\_im\_when\_focused | bool\_t | 获得焦点时打开输入法。 | @@ -865,7 +865,7 @@ ret_t edit_set_tr_tips (widget_t* widget, const char* tr_tips); | 可通过widget\_set\_prop修改 | 是 | #### keyboard 属性 ----------------------- ->

自定义软键盘名称。AWTK优先查找keyboard属性设置的键盘文件名（该键盘的XML文件需要在default\raw\ui目录下存在），如果keyboard为空就找input_type设置的键盘类型 +>

自定义软键盘名称。AWTK优先查找keyboard属性设置的键盘文件名（该键盘的XML文件需要在default\raw\ui目录下存在），如果没有指定keyboard，就找input_type设置的键盘类型。如果指定为空字符串，则表示不需要软键盘。 * 类型：char* diff --git a/docs/manual/ext_widgets_t.md b/docs/manual/ext_widgets_t.md new file mode 100644 index 000000000..f56d6c59a --- /dev/null +++ b/docs/manual/ext_widgets_t.md @@ -0,0 +1,28 @@ +## ext\_widgets\_t +### 概述 +扩展控件。 +---------------------------------- +### 函数 +

+ +| 函数名称 | 说明 | +| -------- | ------------ | +| tk\_ext\_widgets\_init | 初始化AWTK扩展控件。 | +#### tk\_ext\_widgets\_init 函数 +----------------------- + +* 函数功能： + +>

初始化AWTK扩展控件。 + +* 函数原型： + +``` +ret_t tk_ext_widgets_init (); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | diff --git a/docs/manual/fscript_t.md b/docs/manual/fscript_t.md index 8517585a8..dd590df0f 100644 --- a/docs/manual/fscript_t.md +++ b/docs/manual/fscript_t.md @@ -15,6 +15,7 @@ | fscript\_global\_deinit | 全局释放。 | | fscript\_global\_init | 全局初始化。 | | fscript\_register\_func | 注册全局自定义函数。 | +| fscript\_register\_funcs | 注册全局自定义函数。 | | fscript\_set\_error | 用于扩展函数设置遇到的错误。 | | fscript\_syntax\_check | 解析代码，分析是否有语法错误。 | | tk\_expr\_eval | 对fscript的简单包装。 | @@ -162,6 +163,25 @@ ret_t fscript_register_func (const char* name, fscript_func_t* func); | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | name | const char* | 函数名(无需加函数前缀)。 | | func | fscript\_func\_t* | 函数指针。 | +#### fscript\_register\_funcs 函数 +----------------------- + +* 函数功能： + +>

注册全局自定义函数。 + +* 函数原型： + +``` +ret_t fscript_register_funcs (const general_factory_table_t* table); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| table | const general\_factory\_table\_t* | 函数表。 | #### fscript\_set\_error 函数 ----------------------- diff --git a/docs/manual/gradient_stop_t.md b/docs/manual/gradient_stop_t.md new file mode 100644 index 000000000..c67766276 --- /dev/null +++ b/docs/manual/gradient_stop_t.md @@ -0,0 +1,31 @@ +## gradient\_stop\_t +### 概述 +渐变关键点。 +---------------------------------- +### 属性 +

+ +| 属性名称 | 类型 | 说明 | +| -------- | ----- | ------------ | +| color | color\_t | 颜色。 | +| offset | float | 偏移量(0-1)。 | +#### color 属性 +----------------------- +>

颜色。 + +* 类型：color\_t + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | +#### offset 属性 +----------------------- +>

偏移量(0-1)。 + +* 类型：float + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | diff --git a/docs/manual/gradient_t.md b/docs/manual/gradient_t.md new file mode 100644 index 000000000..74ff615fd --- /dev/null +++ b/docs/manual/gradient_t.md @@ -0,0 +1,343 @@ +## gradient\_t +### 概述 +渐变。 +---------------------------------- +### 函数 +

+ +| 函数名称 | 说明 | +| -------- | ------------ | +| gradient\_add\_stop | 增加关键点。 | +| gradient\_deinit | 释放gradient对象。 | +| gradient\_get\_color | 获取颜色。 | +| gradient\_get\_first\_color | 获取开始的颜色。 | +| gradient\_get\_last\_color | 获取结束的颜色。 | +| gradient\_get\_stop | 获取关键点。 | +| gradient\_init | 初始化gradient对象。 | +| gradient\_init\_from\_binary | 从二进制数据初始化gradient对象。 | +| gradient\_init\_from\_str | 从字符串初始化gradient对象。 | +| gradient\_init\_simple | 初始化gradient对象。 | +| gradient\_set\_linear\_degree | 设置线性渐变的角度。 | +| gradient\_set\_type | 设置类型。 | +| gradient\_to\_binary | 转成二进制格式。 | +| gradient\_to\_str | 转换成字符串格式。 | +### 属性 +

+ +| 属性名称 | 类型 | 说明 | +| -------- | ----- | ------------ | +| degree | uint32\_t | 线性渐变的角度。 | +| nr | uint32\_t | stop个数。 | +| type | gradient\_type\_t | 类型。 | +#### gradient\_add\_stop 函数 +----------------------- + +* 函数功能： + +>

增加关键点。 + +* 函数原型： + +``` +ret_t gradient_add_stop (gradient_t* gradient, color_t color, float stop); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| gradient | gradient\_t* | gradient对象。 | +| color | color\_t | 颜色。 | +| stop | float | 位置。 | +#### gradient\_deinit 函数 +----------------------- + +* 函数功能： + +>

释放gradient对象。 + +* 函数原型： + +``` +ret_t gradient_deinit (gradient_t* gradient); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| gradient | gradient\_t* | gradient对象。 | +#### gradient\_get\_color 函数 +----------------------- + +* 函数功能： + +>

获取颜色。 + +* 函数原型： + +``` +color_t gradient_get_color (gradient_t* gradient, float offset); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | color\_t | 返回颜色。 | +| gradient | gradient\_t* | gradient对象。 | +| offset | float | 偏移(0-1)。 | +#### gradient\_get\_first\_color 函数 +----------------------- + +* 函数功能： + +>

获取开始的颜色。 + +* 函数原型： + +``` +color_t gradient_get_first_color (gradient_t* gradient); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | color\_t | 返回颜色。 | +| gradient | gradient\_t* | gradient对象。 | +#### gradient\_get\_last\_color 函数 +----------------------- + +* 函数功能： + +>

获取结束的颜色。 + +* 函数原型： + +``` +color_t gradient_get_last_color (gradient_t* gradient); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | color\_t | 返回颜色。 | +| gradient | gradient\_t* | gradient对象。 | +#### gradient\_get\_stop 函数 +----------------------- + +* 函数功能： + +>

获取关键点。 + +* 函数原型： + +``` +ret_t gradient_get_stop (gradient_t* gradient, uint32_t index); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| gradient | gradient\_t* | gradient对象。 | +| index | uint32\_t | 序数。 | +#### gradient\_init 函数 +----------------------- + +* 函数功能： + +>

初始化gradient对象。 + +* 函数原型： + +``` +gradient_t* gradient_init (gradient_t* gradient); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | gradient\_t* | 返回gradient对象。 | +| gradient | gradient\_t* | gradient对象。 | +#### gradient\_init\_from\_binary 函数 +----------------------- + +* 函数功能： + +>

从二进制数据初始化gradient对象。 + +> 二进制数据必须由gradient_to_binary生成。 + +* 函数原型： + +``` +gradient_t* gradient_init_from_binary (gradient_t* gradient, const uint8_t* data, uint32_t size); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | gradient\_t* | 返回gradient对象。 | +| gradient | gradient\_t* | gradient对象。 | +| data | const uint8\_t* | 数据。 | +| size | uint32\_t | 数据长度。 | +#### gradient\_init\_from\_str 函数 +----------------------- + +* 函数功能： + +>

从字符串初始化gradient对象。 + +> 字符串的格式兼容CSS，请参考相关文档。 + +* 函数原型： + +``` +gradient_t* gradient_init_from_str (gradient_t* gradient, const char* str); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | gradient\_t* | 返回gradient对象。 | +| gradient | gradient\_t* | gradient对象。 | +| str | const char* | 字符串。 | +#### gradient\_init\_simple 函数 +----------------------- + +* 函数功能： + +>

初始化gradient对象。 + +* 函数原型： + +``` +gradient_t* gradient_init_simple (gradient_t* gradient, uint32_t color); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | gradient\_t* | 返回gradient对象。 | +| gradient | gradient\_t* | gradient对象。 | +| color | uint32\_t | 颜色。 | +#### gradient\_set\_linear\_degree 函数 +----------------------- + +* 函数功能： + +>

设置线性渐变的角度。 + +* 函数原型： + +``` +ret_t gradient_set_linear_degree (gradient_t* gradient, uint32_t degree); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| gradient | gradient\_t* | gradient对象。 | +| degree | uint32\_t | 角度。 | +#### gradient\_set\_type 函数 +----------------------- + +* 函数功能： + +>

设置类型。 + +* 函数原型： + +``` +ret_t gradient_set_type (gradient_t* gradient, gradient_type_t type); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| gradient | gradient\_t* | gradient对象。 | +| type | gradient\_type\_t | 类型。 | +#### gradient\_to\_binary 函数 +----------------------- + +* 函数功能： + +>

转成二进制格式。 + +* 函数原型： + +``` +ret_t gradient_to_binary (gradient_t* gradient, wbuffer_t* wb); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| gradient | gradient\_t* | gradient对象。 | +| wb | wbuffer\_t* | 二进制数据。 | +#### gradient\_to\_str 函数 +----------------------- + +* 函数功能： + +>

转换成字符串格式。 + +* 函数原型： + +``` +ret_t gradient_to_str (gradient_t* gradient, str_t* str); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| gradient | gradient\_t* | gradient对象。 | +| str | str\_t* | 字符串。 | +#### degree 属性 +----------------------- +>

线性渐变的角度。 + +* 类型：uint32\_t + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | +#### nr 属性 +----------------------- +>

stop个数。 + +* 类型：uint32\_t + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | +#### type 属性 +----------------------- +>

类型。 + +* 类型：gradient\_type\_t + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | diff --git a/docs/manual/gradient_type_t.md b/docs/manual/gradient_type_t.md new file mode 100644 index 000000000..2f7bd1495 --- /dev/null +++ b/docs/manual/gradient_type_t.md @@ -0,0 +1,11 @@ +## gradient\_type\_t +### 概述 +渐变色类型。 +### 常量 +

+ +| 名称 | 说明 | +| -------- | ------- | +| GRADIENT\_NONE | 无效类型。 | +| GRADIENT\_LINEAR | 线性渐变。 | +| GRADIENT\_RADIAL | 放射渐变。 | diff --git a/docs/manual/hscroll_label_t.md b/docs/manual/hscroll_label_t.md index 1c043aa1d..8f7e5087b 100644 --- a/docs/manual/hscroll_label_t.md +++ b/docs/manual/hscroll_label_t.md @@ -7,13 +7,8 @@ hscroll\_label\_t是[widget\_t](widget_t.md)的子类控件，widget\_t的函数均适用于hscroll\_label\_t控件。 -在xml中使用"hscroll\_label"标签创建行号控件，一般配合mledit使用。如： - -```xml -``` - -> 更多用法请参考：[mledit.xml]( -https://github.com/zlgopen/awtk/blob/master/design/default/ui/mledit.xml) +> 更多用法请参考：[hscroll_label.xml]( +https://github.com/zlgopen/awtk/blob/master/design/default/ui/hscroll_label.xml) 可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如： diff --git a/docs/manual/image_manager_t.md b/docs/manual/image_manager_t.md index 1ad8994c1..605e6d068 100644 --- a/docs/manual/image_manager_t.md +++ b/docs/manual/image_manager_t.md @@ -16,6 +16,7 @@ | image\_manager\_preload | 预加载指定的图片。 | | image\_manager\_set | 设置缺省的图片管理器。 | | image\_manager\_set\_assets\_manager | 设置资源管理器对象。 | +| image\_manager\_set\_max\_mem\_size\_of\_cached\_images | 设置图片缓存占用的最大内存。 | | image\_manager\_unload\_all | 从图片管理器中卸载全部图片。 | | image\_manager\_unload\_bitmap | 从图片管理器中卸载指定的图片。 | | image\_manager\_unload\_unused | 从图片管理器中卸载指定时间内没有使用的图片。 | @@ -207,6 +208,26 @@ ret_t image_manager_set_assets_manager (image_manager_t* imm, assets_manager_t* | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | imm | image\_manager\_t* | 图片管理器对象。 | | assets\_manager | assets\_manager\_t* | 资源管理器。 | +#### image\_manager\_set\_max\_mem\_size\_of\_cached\_images 函数 +----------------------- + +* 函数功能： + +>

设置图片缓存占用的最大内存。 + +* 函数原型： + +``` +ret_t image_manager_set_max_mem_size_of_cached_images (image_manager_t* imm, uint32_t max_mem_size); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| imm | image\_manager\_t* | 图片管理器对象。 | +| max\_mem\_size | uint32\_t | 最大缓存内存。 | #### image\_manager\_unload\_all 函数 ----------------------- diff --git a/docs/manual/images/object_widget_t_0.png b/docs/manual/images/object_widget_t_0.png new file mode 100644 index 0000000000000000000000000000000000000000..8713e20cb3ff78de0ef3dba677233f42b96efab2 GIT binary patch literal 4167 zcmbtY2QXZ1zh7@+wUr=54Ix@|qSqH8(FtOSzB+4l5b)g8 z(OE4UJ?@ix@67kj{pP*%-MO=~dv@kI&pGG$|9|Z{FZ6ZqQIa!}Lm&`Jjr(^WfMYHA zW|Km}?@!b90dRoYYTdgFx%mBg(_EMgfm}V)xT|aw@Opa&scksHMzV_V-f;Yzq&hCA#UJe)XvUky2p=eqXsa}FW!RrDbRCUIUr|Zw z!=PxVchpS9|sbU$*m`{ULP*ty?uMnhw(e5SZ41C7p$jbVES1T<$qr{2CGx2 zw!l4|=W)&5ppLATclz0*f4c3z4qpj4-sk%E?VG#>v|=O!=C7oLSkaZqL{_mtj81_t51 zz1l~|#|y^?tIuD&Xl)5Ty_w#lb`DnZGBGjy<3}NeICbqzF=EXE8Zt66?6j$=Y0-xd ze^ojTcx;XfE=8ChEju(OAAadJxg^yc47fV;T~++m7SnTlhU%23az zCXB56xcxdi{!mqA;0YTA_+7pGlcU%&M&omIx` zGA@A)SLHkcfq2!kbai#D;qmI;-j#zpKh{U!jedf(*w3S2Rva&FhC3WV#0HC~CF2Bid~fx4g5mvZ!fjI9yzvofBEgCN{awx2OR! zUcY9^x~TZY&&x{+(2}7T+|cGth4ZKt{Mz8lKRhy`h6Lr6&A!5ysyUjIo=(ziDJ)-O zR@&L!jZG7L#FFDb@zJ8Qv-8WBFJVRJ3vE$(a(A4?nE-k;K5tHxE$uJ&5_+~*km3(Dtda7f(K;DUC&MrcW%kaF<;}+y}Y}TF3qEt zb5~s*Iy^i~MMLvPXlSUBv9S#<{s!sQtNsDAM@In}+T7p-4sLEJ5fPD-o7-Qb?+r0y zE|DSLtNm)`<}Bl-kD}~*(rm1)A(WJqq!bj%ZYB=B8AM7-N^jr2#I2nX_WU`ic82xo*}m|X z@a}x;rDsu5OU;L~%%2nkr4jO(+UUGI4!3Vr>!q8Xi8P=tWydEcwnKSpegsMwjK!}E z)^tK00?@Gq=rE`VKm_2{7H^MIf&{E)`pm~L>;^Xp zlQl?Yj$5}BEUs5viVS4%^z?*(4pD$upB?S7epLTZT?fYyCk7tn7-EUhT095(x?~Y%P{Kzq7Nm?lo(sqJn+y9=@P!c>}Ky z_%op4a-ntXLc~=?2t>fVjtUTx;Gu@Nv|T?lUpp6~s-;C?i$E9{8FAJ-l6g{+*D}-6 z(%$6bBagar<7un)pZ4|zg<4G4c&CNN=jIZIhaVJ;xdi*WajQ3@Ep3GKC*yj+ozW!XLgvSRfn3|gLl>@*h^q7m9v-A3!!xL^4 zt^}p1WL8~Ui&*K+^gCA`8Bn@lkwVS-s2U@#e3r^ReEZ(8FfTt}b<}TfQSI&9xAQ=% z^ZYWkSNexLXvu3SI+wk=rpy2nVG#4C8Q-cm^eKPS@qg3G{y(!hrE;YhU`OYNa|#9& z6U8MZM3DCOcGi#2^s*$8Ns^zWXzA!gAwSft@;7?Wi^>;nq~|wy#h7U6=@EdglDYW` z|K;odHj4kTCQCMay0BGVX=&exeO(*?R%qzw!k+o3Q&UH( zl<#@PZy69GS$*zVJ34%+zR5z6Kt(L{ejekWhj5~?n*U(UQ zbSzZG5tEQ0+R&6j#hM%Vna0k(KHsSzl%}q3N6Kx(Eqv(Nk!SB~nUP4k=EW^vPn_)4 z6VW>;>VI-@i;(Lqnr3FNa4W3Ql@skZHn*xgq$DJiOUAG+)lWsyK$EuSKC`v7wB&`v zin7T0!GH~dr`+A!YYo3dBH}tOfEh^TH+h+x3nU&cFz6&cS?8H=Hw$uxor42*VBqRN zuF^eiZP?H4DUy0~p^b_0add1f%*WTa)k)m8JLR@MU+Vq)_o-I;ySr8F?YVLk0@06Z z-N|tH*=AdwYB7$NQXs3sJz7L0}+)h~2s4 zxihQa1gLbIYngHQ43fg)aDmp^&Q6pzx2mr0l^WDs zJXq)V@86}XLi)|=O=6{rS{2Xn&w+4MOiscb#F-*%Ks*tNQ@^!QII=!@c6?y!?EHT4 z-Na_5W`Qktvh(1ctBVWV&#&g~`NmiYkibM=A0LqphRw}Q#PRX502i0qXjx-pR;gw4 zD@GU;(`PLr5~D8z0)Gl13m$&!50QR#oq;EivP_HJU|H`_{4IBbm|NzBTM2@8W@knPcQ&!eMNjEz%^P(D85 zi%Uz9I1C1JUr=+|av;w|ZrGwF9aSy0H!p5^lL2M)?EEOc)QxV^^ehsiAwuE?>*M`p zl_}6Xu5%zjo-4hKQL9Mc2L0J`T-zXCZf|dACbva<5p*4AGjq20(? zLJC+mF#xct0Krd6N_v@|9t9@bMART7j3WRhNii(SD6X6oZ{s$E1)HqPoHR(I$m7VZ(AsRsoz|T z-gEQp&I}wYHV)YTPPVwX_{NCOMl93g;#aVpqa%e0896z*$NqN>J3G6Zf`XLn?Cifo zkg+kH-_~R}fN0ceTtY%rmz|289jC3WEfp12SVxDtcD5{?S?R+yDSy2AU+wKSGY!7* z8aGBL6goIK7*<{`(&cC05zDxHaG>hq!iQ~Z+dJAr{0>wgFT8jkx zHUP}`H8rt^bD_c;hL)D`z+uV0ln9Py%lXf*u9C2^vHeEdPRpqfTL$si~1ymCmTFLXNq(^>Sjjr)nca(WaFS?83r&UiR&?1n>3+ z=|K4`mH>jx2cRzxO-yir6;a!#6IP)WVADiib{6Gze&U;!l_j@!5F8x*0fPw#TMIH1 z9`uHZmDKTDKo!Qu$FDr5!x{EE+yOf?ghS<5JOT_(f-H(ublf=+T{-i8Jhg{z zFk2k;XnZ>6Vs8~ppgRSUC~whS^t0`%QaR8-z4QeiRS-HtRUa>4iGllf+KH_Zp14ib zP$niO<_NhOIXgR3TasjIbMvNZa`Ny5*6|(gcYEMK#m`R&kg&ZaTwonjMR9Sljn$94 zckc$AiJ8IS86FlhH(b}^HWyPDpiRP~WsESi&0OCKUMoJrbCv1IQbPc;uG!euHm^`? zS97*b$nwI5SVcYh|F&O+2AjMo)ziARhy)f*66`+cftqdl%GFM_C?wV~TSrOF9>k0J dA69(AMu^UTsiEAw3*HPsG}LtOepIo3`XA(@Ine+B literal 0 HcmV?d00001 diff --git a/docs/manual/lcd_fb_dirty_rects_t.md b/docs/manual/lcd_fb_dirty_rects_t.md new file mode 100644 index 000000000..909dcb1b0 --- /dev/null +++ b/docs/manual/lcd_fb_dirty_rects_t.md @@ -0,0 +1,158 @@ +## lcd\_fb\_dirty\_rects\_t +### 概述 +lcd fb脏矩形。 +---------------------------------- +### 函数 +

+ +| 函数名称 | 说明 | +| -------- | ------------ | +| lcd\_fb\_dirty\_rects\_add\_fb\_info | 添加新的 fb 信息 | +| lcd\_fb\_dirty\_rects\_deinit | 清除 lcd_fb_dirty_rects_t 对象数据 | +| lcd\_fb\_dirty\_rects\_get\_dirty\_rects\_by\_fb | 根据 fb 来获取脏矩形对象 | +| lcd\_fb\_dirty\_rects\_init | 初始化 lcd_fb_dirty_rects_t 对象 | +| lcd\_fb\_dirty\_rects\_reinit | 修改 lcd_fb_dirty_rects_t 对象的宽高 | +| lcd\_fb\_dirty\_rects\_reset\_dirty\_rects\_by\_fb | 清除对应 fb 的脏矩形列表。 | +| lcd\_fb\_dirty\_rects\_update\_all\_fb\_dirty\_rects | 把当前脏矩形列表合并到所有 fb 的脏矩形中。 | +#### lcd\_fb\_dirty\_rects\_add\_fb\_info 函数 +----------------------- + +* 函数功能： + +>

添加新的 fb 信息 +如果已经存在的话，就不会重新添加 + +* 函数原型： + +``` +ret_t lcd_fb_dirty_rects_add_fb_info (lcd_fb_dirty_rects_t* lcd_fb_dirty_rects, uint8_t* fb); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| lcd\_fb\_dirty\_rects | lcd\_fb\_dirty\_rects\_t* | lcd\_fb\_dirty\_rects\_t对象。 | +| fb | uint8\_t* | fb 地址。 | +#### lcd\_fb\_dirty\_rects\_deinit 函数 +----------------------- + +* 函数功能： + +>

清除 lcd_fb_dirty_rects_t 对象数据 + +* 函数原型： + +``` +ret_t lcd_fb_dirty_rects_deinit (lcd_fb_dirty_rects_t* lcd_fb_dirty_rects); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| lcd\_fb\_dirty\_rects | lcd\_fb\_dirty\_rects\_t* | lcd\_fb\_dirty\_rects\_t对象。 | +#### lcd\_fb\_dirty\_rects\_get\_dirty\_rects\_by\_fb 函数 +----------------------- + +* 函数功能： + +>

根据 fb 来获取脏矩形对象 + +* 函数原型： + +``` +const dirty_rects_t* lcd_fb_dirty_rects_get_dirty_rects_by_fb (lcd_fb_dirty_rects_t* lcd_fb_dirty_rects, uint8_t* fb); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | const dirty\_rects\_t* | 成功返回脏矩形对象，失败返回 NULL。 | +| lcd\_fb\_dirty\_rects | lcd\_fb\_dirty\_rects\_t* | lcd\_fb\_dirty\_rects\_t对象。 | +| fb | uint8\_t* | fb 地址。 | +#### lcd\_fb\_dirty\_rects\_init 函数 +----------------------- + +* 函数功能： + +>

初始化 lcd_fb_dirty_rects_t 对象 + +* 函数原型： + +``` +ret_t lcd_fb_dirty_rects_init (lcd_fb_dirty_rects_t* lcd_fb_dirty_rects, wh_t lcd_w, wh_t lcd_h); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| lcd\_fb\_dirty\_rects | lcd\_fb\_dirty\_rects\_t* | lcd\_fb\_dirty\_rects\_t对象。 | +| lcd\_w | wh\_t | lcd 的宽。 | +| lcd\_h | wh\_t | lcd 的高。 | +#### lcd\_fb\_dirty\_rects\_reinit 函数 +----------------------- + +* 函数功能： + +>

修改 lcd_fb_dirty_rects_t 对象的宽高 + +* 函数原型： + +``` +ret_t lcd_fb_dirty_rects_reinit (lcd_fb_dirty_rects_t* lcd_fb_dirty_rects, wh_t lcd_w, wh_t lcd_h); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| lcd\_fb\_dirty\_rects | lcd\_fb\_dirty\_rects\_t* | lcd\_fb\_dirty\_rects\_t对象。 | +| lcd\_w | wh\_t | lcd 的宽。 | +| lcd\_h | wh\_t | lcd 的高。 | +#### lcd\_fb\_dirty\_rects\_reset\_dirty\_rects\_by\_fb 函数 +----------------------- + +* 函数功能： + +>

清除对应 fb 的脏矩形列表。 + +* 函数原型： + +``` +ret_t lcd_fb_dirty_rects_reset_dirty_rects_by_fb (lcd_fb_dirty_rects_t* lcd_fb_dirty_rects, uint8_t* fb); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| lcd\_fb\_dirty\_rects | lcd\_fb\_dirty\_rects\_t* | lcd\_fb\_dirty\_rects\_t对象。 | +| fb | uint8\_t* | fb 地址。 | +#### lcd\_fb\_dirty\_rects\_update\_all\_fb\_dirty\_rects 函数 +----------------------- + +* 函数功能： + +>

把当前脏矩形列表合并到所有 fb 的脏矩形中。 + +* 函数原型： + +``` +ret_t lcd_fb_dirty_rects_update_all_fb_dirty_rects (lcd_fb_dirty_rects_t* lcd_fb_dirty_rects, const dirty_rects_t* dirty_rects); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| lcd\_fb\_dirty\_rects | lcd\_fb\_dirty\_rects\_t* | lcd\_fb\_dirty\_rects\_t对象。 | +| dirty\_rects | const dirty\_rects\_t* | 当前脏矩形列表。 | diff --git a/docs/manual/lcd_t.md b/docs/manual/lcd_t.md index 3ba49370d..dbd7d7d3d 100644 --- a/docs/manual/lcd_t.md +++ b/docs/manual/lcd_t.md @@ -179,7 +179,7 @@ ret_t lcd_draw_hline (lcd_t* lcd, xy_t x, xy_t y, xy_t w); * 函数原型： ``` -ret_t lcd_draw_image (lcd_t* lcd, bitmap_t* img, const rect_t* src, const rect_t* dst); +ret_t lcd_draw_image (lcd_t* lcd, bitmap_t* img, const rectf_t* src, const rectf_t* dst); ``` * 参数说明： @@ -189,8 +189,8 @@ ret_t lcd_draw_image (lcd_t* lcd, bitmap_t* img, const rect_t* src, const rect_t | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | lcd | lcd\_t* | lcd对象。 | | img | bitmap\_t* | 图片。 | -| src | const rect\_t* | 只绘制指定区域的部分。 | -| dst | const rect\_t* | 绘制到目标区域。 | +| src | const rectf\_t* | 只绘制指定区域的部分。 | +| dst | const rectf\_t* | 绘制到目标区域。 | #### lcd\_draw\_image\_matrix 函数 ----------------------- diff --git a/docs/manual/main_loop_t.md b/docs/manual/main_loop_t.md index 18a8c21a6..d9d708d42 100644 --- a/docs/manual/main_loop_t.md +++ b/docs/manual/main_loop_t.md @@ -11,6 +11,7 @@ | main\_loop\_add\_event\_source | 添加event_source。 | | main\_loop\_remove\_event\_source | 删除event_source。 | | main\_loop\_remove\_event\_source\_by\_tag | 删除event_source。 | +| main\_loop\_step | 执行一次迭代。 | #### main\_loop 函数 ----------------------- @@ -89,3 +90,22 @@ ret_t main_loop_remove_event_source_by_tag (main_loop_t* l, void* tag); | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | l | main\_loop\_t* | main\_loop对象。 | | tag | void* | tag。 | +#### main\_loop\_step 函数 +----------------------- + +* 函数功能： + +>

执行一次迭代。 + +* 函数原型： + +``` +ret_t main_loop_step (main_loop_t* l); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| l | main\_loop\_t* | main\_loop对象。 | diff --git a/docs/manual/mledit_t.md b/docs/manual/mledit_t.md index 29beeb237..c736ab740 100644 --- a/docs/manual/mledit_t.md +++ b/docs/manual/mledit_t.md @@ -35,6 +35,7 @@ time\_clock一般不需要设置style。 | mledit\_create | 创建mledit对象 | | mledit\_get\_cursor | 获取编辑器光标位置。 | | mledit\_get\_selected\_text | 获取选中的文本。 | +| mledit\_insert\_text | 插入一段文本。 | | mledit\_scroll\_to\_offset | 设置编辑器滚动到指定偏移位置。 | | mledit\_set\_cancelable | 设置编辑器是否为可撤销修改。 | | mledit\_set\_close\_im\_when\_blured | 设置编辑器是否在失去焦点时关闭输入法。 | @@ -44,6 +45,7 @@ time\_clock一般不需要设置style。 | mledit\_set\_max\_chars | 设置编辑器的最大字符数（0 为不限制字符数）。 | | mledit\_set\_max\_lines | 设置编辑器的最大行数。 | | mledit\_set\_open\_im\_when\_focused | 设置编辑器是否在获得焦点时打开输入法。 | +| mledit\_set\_overwrite | 设置编辑器是否启用覆盖行（在行数达到最大行数时，可继续新增行，但最早的行将会消失）。 | | mledit\_set\_readonly | 设置编辑器是否为只读。 | | mledit\_set\_scroll\_line | 设置编辑器滚动速度。 | | mledit\_set\_select | 选择编辑器中指定范围的文本。 | @@ -61,6 +63,7 @@ time\_clock一般不需要设置style。 | max\_chars | uint32\_t | 最大字符数。 | | max\_lines | uint32\_t | 最大行数。 | | open\_im\_when\_focused | bool\_t | 获得焦点时打开输入法。 | +| overwrite | bool\_t | 是否启用覆盖行。 | | readonly | bool\_t | 编辑器是否为只读。 | | scroll\_line | uint32\_t | 鼠标一次滚动行数。 | | tips | char* | 输入提示。 | @@ -154,6 +157,27 @@ char* mledit_get_selected_text (widget_t* widget); | -------- | ----- | --------- | | 返回值 | char* | 返回选中文本。 | | widget | widget\_t* | widget对象。 | +#### mledit\_insert\_text 函数 +----------------------- + +* 函数功能： + +>

插入一段文本。 + +* 函数原型： + +``` +ret_t mledit_insert_text (widget_t* widget, uint32_t offset, const char* text); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| widget | widget\_t* | widget对象。 | +| offset | uint32\_t | 插入的偏移位置。 | +| text | const char* | 待插入的文本。 | #### mledit\_scroll\_to\_offset 函数 ----------------------- @@ -337,6 +361,26 @@ ret_t mledit_set_open_im_when_focused (widget_t* widget, bool_t open_im_when_foc | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | widget对象。 | | open\_im\_when\_focused | bool\_t | 是否在获得焦点时打开输入法。 | +#### mledit\_set\_overwrite 函数 +----------------------- + +* 函数功能： + +>

设置编辑器是否启用覆盖行（在行数达到最大行数时，可继续新增行，但最早的行将会消失）。 + +* 函数原型： + +``` +ret_t mledit_set_overwrite (widget_t* widget, bool_t overwrite); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| widget | widget\_t* | widget对象。 | +| overwrite | bool\_t | 是否启用覆盖行。 | #### mledit\_set\_readonly 函数 ----------------------- @@ -549,6 +593,22 @@ ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word); * 类型：bool\_t +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | +| 可持久化 | 是 | +| 可脚本化 | 是 | +| 可在IDE中设置 | 是 | +| 可在XML中设置 | 是 | +| 可通过widget\_get\_prop读取 | 是 | +| 可通过widget\_set\_prop修改 | 是 | +#### overwrite 属性 +----------------------- +>

是否启用覆盖行。 + +* 类型：bool\_t + | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | diff --git a/docs/manual/named_value_t.md b/docs/manual/named_value_t.md index 4a4486b3e..b437f094c 100644 --- a/docs/manual/named_value_t.md +++ b/docs/manual/named_value_t.md @@ -8,7 +8,10 @@ | 函数名称 | 说明 | | -------- | ------------ | | named\_value\_cast | 转换为named_value对象(供脚本语言使用)。 | +| named\_value\_compare | 比较。 | +| named\_value\_compare\_by\_name | 比较。 | | named\_value\_create | 创建named_value对象。 | +| named\_value\_create\_ex | 创建named_value对象。 | | named\_value\_deinit | 重置named_value对象。 | | named\_value\_destroy | 销毁named_value对象。 | | named\_value\_get\_value | 获取值对象(主要给脚本语言使用)。 | @@ -41,6 +44,46 @@ named_value_t* named_value_cast (named_value_t* nv); | -------- | ----- | --------- | | 返回值 | named\_value\_t* | 返回named\_value对象。 | | nv | named\_value\_t* | named\_value对象。 | +#### named\_value\_compare 函数 +----------------------- + +* 函数功能： + +>

比较。 + +* 函数原型： + +``` +ret_t named_value_compare (named_value_t* nv, named_value_t* other); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| nv | named\_value\_t* | named\_value对象。 | +| other | named\_value\_t* | named\_value对象。 | +#### named\_value\_compare\_by\_name 函数 +----------------------- + +* 函数功能： + +>

比较。 + +* 函数原型： + +``` +ret_t named_value_compare_by_name (named_value_t* nv, const char* name); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| nv | named\_value\_t* | named\_value对象。 | +| name | const char* | 名称。 | #### named\_value\_create 函数 ----------------------- @@ -59,6 +102,26 @@ named_value_t* named_value_create (); | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | named\_value\_t* | 返回named\_value对象。 | +#### named\_value\_create\_ex 函数 +----------------------- + +* 函数功能： + +>

创建named_value对象。 + +* 函数原型： + +``` +ret_t named_value_create_ex (const char* name, const value_t* value); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回named\_value对象。 | +| name | const char* | 名称。 | +| value | const value\_t* | 值。 | #### named\_value\_deinit 函数 ----------------------- diff --git a/docs/manual/native_window_t.md b/docs/manual/native_window_t.md index 93f4a7500..3a3120a84 100644 --- a/docs/manual/native_window_t.md +++ b/docs/manual/native_window_t.md @@ -20,6 +20,8 @@ | native\_window\_restore | 恢复窗口大小。 | | native\_window\_set\_cursor | 设置鼠标光标。 | | native\_window\_set\_fullscreen | 是否全屏。 | +| native\_window\_set\_orientation | 调整窗口旋转。 | +| native\_window\_set\_title | 设置程序窗口的名称。 | | native\_window\_show\_border | 是否显示边框。 | #### native\_window\_center 函数 ----------------------- @@ -240,6 +242,47 @@ ret_t native_window_set_fullscreen (native_window_t* win, bool_t fullscreen); | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | win | native\_window\_t* | win对象。 | | fullscreen | bool\_t | 是否全屏。 | +#### native\_window\_set\_orientation 函数 +----------------------- + +* 函数功能： + +>

调整窗口旋转。 + +* 函数原型： + +``` +ret_t native_window_set_orientation (native_window_t* win, lcd_orientation_t old_orientation, lcd_orientation_t new_orientation); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| win | native\_window\_t* | win对象。 | +| old\_orientation | lcd\_orientation\_t | 旧的旋转角度。 | +| new\_orientation | lcd\_orientation\_t | 新的旋转角度。 | +#### native\_window\_set\_title 函数 +----------------------- + +* 函数功能： + +>

设置程序窗口的名称。 + +* 函数原型： + +``` +ret_t native_window_set_title (native_window_t* win, const char* app_name); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| win | native\_window\_t* | win对象。 | +| app\_name | const char* | 程序窗口的名称。 | #### native\_window\_show\_border 函数 ----------------------- diff --git a/docs/manual/object_default_t.md b/docs/manual/object_default_t.md index c7deda478..0a4ebdb96 100644 --- a/docs/manual/object_default_t.md +++ b/docs/manual/object_default_t.md @@ -14,16 +14,9 @@ | object\_default\_clear\_props | 清除全部属性。 | | object\_default\_clone | 克隆对象。 | | object\_default\_create | 创建对象。 | +| object\_default\_create\_ex | 创建对象。 | | object\_default\_find\_prop | 查找满足条件的属性，并返回它的值。 | | object\_default\_unref | for script gc | -### 属性 -

- -| 属性名称 | 类型 | 说明 | -| -------- | ----- | ------------ | -| props | named\_value\_t | 属性数组。 | -| props\_capacity | uint32\_t | 属性数组的容量。 | -| props\_size | uint32\_t | 属性个数。 | #### object\_default\_clear\_props 函数 ----------------------- @@ -80,6 +73,25 @@ object_t* object_default_create (); | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | object\_t* | 返回object对象。 | +#### object\_default\_create\_ex 函数 +----------------------- + +* 函数功能： + +>

创建对象。 + +* 函数原型： + +``` +object_t* object_default_create_ex (bool_t enable_path); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | object\_t* | 返回object对象。 | +| enable\_path | bool\_t | 是否支持按路径访问属性。 | #### object\_default\_find\_prop 函数 ----------------------- @@ -120,34 +132,3 @@ ret_t object_default_unref (object_t* obj); | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | obj | object\_t* | 对象。 | -#### props 属性 ------------------------ ->

属性数组。 - -* 类型：named\_value\_t - -| 特性 | 是否支持 | -| -------- | ----- | -| 可直接读取 | 是 | -| 可直接修改 | 否 | -#### props\_capacity 属性 ------------------------ ->

属性数组的容量。 - -* 类型：uint32\_t - -| 特性 | 是否支持 | -| -------- | ----- | -| 可直接读取 | 是 | -| 可直接修改 | 否 | -#### props\_size 属性 ------------------------ ->

属性个数。 - -* 类型：uint32\_t - -| 特性 | 是否支持 | -| -------- | ----- | -| 可直接读取 | 是 | -| 可直接修改 | 否 | -| 可脚本化 | 是 | diff --git a/docs/manual/object_t.md b/docs/manual/object_t.md index 10ce89026..31a19b965 100644 --- a/docs/manual/object_t.md +++ b/docs/manual/object_t.md @@ -15,10 +15,12 @@ | object\_compare | 比较两个对象。 | | object\_copy\_prop | 拷贝指定的属性。 | | object\_create | 创建对象。 | +| object\_create\_ex | 创建对象。 | | object\_eval | 计算一个表达式，表达式中引用的变量从prop中获取。 | | object\_exec | 执行指定的命令。 | | object\_exec\_by\_path | 执行指定的命令。 | | object\_foreach\_prop | 遍历所有属性。 | +| object\_get\_child\_object | 获取下一级子对象。 | | object\_get\_desc | 获取对象的描述信息。 | | object\_get\_prop | 获取指定属性的值。 | | object\_get\_prop\_bool | 获取指定属性的bool类型的值。 | @@ -197,15 +199,37 @@ ret_t object_copy_prop (object_t* obj, object_t* src, const char* name); * 函数原型： ``` -ret_t object_create (const object_vtable_t* vt); +object_t* object_create (const object_vtable_t* vt); ``` * 参数说明： | 参数 | 类型 | 说明 | | -------- | ----- | --------- | -| 返回值 | ret\_t | 返回object对象。 | +| 返回值 | object\_t* | 返回object对象。 | | vt | const object\_vtable\_t* | 虚函数表。 | +#### object\_create\_ex 函数 +----------------------- + +* 函数功能： + +>

创建对象。 + +> 仅供子类调用。 + +* 函数原型： + +``` +object_t* object_create_ex (const object_vtable_t* vt, uint32_t extra_data_size); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | object\_t* | 返回object对象。 | +| vt | const object\_vtable\_t* | 虚函数表。 | +| extra\_data\_size | uint32\_t | 额外的内存大小。 | #### object\_eval 函数 ----------------------- @@ -290,6 +314,28 @@ ret_t object_foreach_prop (object_t* obj, tk_visit_t on_prop, void* ctx); | obj | object\_t* | object对象。 | | on\_prop | tk\_visit\_t | 回调函数。 | | ctx | void* | 回调函数上下文。 | +#### object\_get\_child\_object 函数 +----------------------- + +* 函数功能： + +>

获取下一级子对象。 +> 属性路径之间使用符号"."分割，例如：name.sub_name。 + +* 函数原型： + +``` +object_t* object_get_child_object (object_t* obj, const char* path, const char** next_path); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | object\_t* | 返回下一级子对象，如果找不到则返回 NULL。 | +| obj | object\_t* | object对象。 | +| path | const char* | 属性路径。 | +| next\_path | const char** | 返回下一级属性路径。 | #### object\_get\_desc 函数 ----------------------- diff --git a/docs/manual/object_widget_t.md b/docs/manual/object_widget_t.md new file mode 100644 index 000000000..1753767d9 --- /dev/null +++ b/docs/manual/object_widget_t.md @@ -0,0 +1,48 @@ +## object\_widget\_t +### 概述 +![image](images/object_widget_t_0.png) + +将widget包装成object。 +> 备注：主要用于 fscript 实现 widget.prop 方式访问控件属性。 +---------------------------------- +### 函数 +

+ +| 函数名称 | 说明 | +| -------- | ------------ | +| object\_widget\_create | 创建widget对象。 | +### 属性 +

+ +| 属性名称 | 类型 | 说明 | +| -------- | ----- | ------------ | +| widget | widget\_t* | widget对象。 | +#### object\_widget\_create 函数 +----------------------- + +* 函数功能： + +>

创建widget对象。 + +* 函数原型： + +``` +object_t* object_widget_create (widget_t* widget); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | object\_t* | 返回object对象。 | +| widget | widget\_t* | 控件。 | +#### widget 属性 +----------------------- +>

widget对象。 + +* 类型：widget\_t* + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | diff --git a/docs/manual/orientation_event_t.md b/docs/manual/orientation_event_t.md index 4644923b1..886cd268b 100644 --- a/docs/manual/orientation_event_t.md +++ b/docs/manual/orientation_event_t.md @@ -16,6 +16,7 @@ | 属性名称 | 类型 | 说明 | | -------- | ----- | ------------ | +| old\_orientation | int32\_t | 旧的屏幕方向。 | | orientation | int32\_t | 屏幕方向。 | #### orientation\_event\_cast 函数 ----------------------- @@ -46,7 +47,7 @@ orientation_event_t* orientation_event_cast (event_t* event); * 函数原型： ``` -event_t* orientation_event_init (orientation_event_t* event, void* target, uint32_t type, int32_t dy); +event_t* orientation_event_init (orientation_event_t* event, uint32_t type, void* target, lcd_orientation_t old_orientation, lcd_orientation_t new_orientation); ``` * 参数说明： @@ -55,9 +56,21 @@ event_t* orientation_event_init (orientation_event_t* event, void* target, uint3 | -------- | ----- | --------- | | 返回值 | event\_t* | event对象。 | | event | orientation\_event\_t* | event对象。 | -| target | void* | 事件目标。 | | type | uint32\_t | 事件类型。 | -| dy | int32\_t | 滚轮的y值。 | +| target | void* | 事件目标。 | +| old\_orientation | lcd\_orientation\_t | 旧的屏幕方向。 | +| new\_orientation | lcd\_orientation\_t | 新的屏幕方向。 | +#### old\_orientation 属性 +----------------------- +>

旧的屏幕方向。 + +* 类型：int32\_t + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | +| 可脚本化 | 是 | #### orientation 属性 ----------------------- >

屏幕方向。 diff --git a/docs/manual/rect_t.md b/docs/manual/rect_t.md index 6b8792eea..0cf597f12 100644 --- a/docs/manual/rect_t.md +++ b/docs/manual/rect_t.md @@ -12,12 +12,15 @@ | rect\_create | 创建rect对象。 | | rect\_destroy | 销毁rect对象。 | | rect\_fix | 确保rect在指定的大小范围内。 | +| rect\_from\_rectf | rectf 类型转换到 rect 类型。 | | rect\_has\_intersect | 判断两个rect的是否存在交集。 | | rect\_init | 初始化rect对象。 | | rect\_intersect | 求两个rect的交集。 | | rect\_merge | 合并两个rect对象。 | | rect\_scale | 缩放rect对象。 | | rect\_set | 设置rect对象的xywh。 | +| rect\_to\_rectf | rect 类型转换到 rectf 类型。 | +| rectf\_scale | 缩放rectf对象。 | ### 属性

@@ -133,6 +136,25 @@ rect_t rect_fix (rect_t* r); | -------- | ----- | --------- | | 返回值 | rect\_t | 返回修复之后的rect对象。 | | r | rect\_t* | rect对象。 | +#### rect\_from\_rectf 函数 +----------------------- + +* 函数功能： + +>

rectf 类型转换到 rect 类型。 + +* 函数原型： + +``` +rect_t rect_from_rectf (const rectf_t* r); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | rect\_t | 返回 rect 对象。 | +| r | const rectf\_t* | rectf 对象。 | #### rect\_has\_intersect 函数 ----------------------- @@ -260,6 +282,45 @@ rect_t* rect_set (rect_t* rect, xy_t x, xy_t y, wh_t w, wh_t h); | y | xy\_t | y坐标。 | | w | wh\_t | 宽度。 | | h | wh\_t | 高度。 | +#### rect\_to\_rectf 函数 +----------------------- + +* 函数功能： + +>

rect 类型转换到 rectf 类型。 + +* 函数原型： + +``` +rectf_t rect_to_rectf (const rect_t* r1); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | rectf\_t | 返回 rectf\_t 对象。 | +| r1 | const rect\_t* | rect 对象。 | +#### rectf\_scale 函数 +----------------------- + +* 函数功能： + +>

缩放rectf对象。 + +* 函数原型： + +``` +rectf_t* rectf_scale (rectf_t* r, float_t scale); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | rectf\_t* | 返回rect对象。 | +| r | rectf\_t* | rect对象。 | +| scale | float\_t | 缩放比例。 | #### h 属性 ----------------------- >

高度。 diff --git a/docs/manual/socket.md b/docs/manual/socket.md index 40acaa9d8..9a0208709 100644 --- a/docs/manual/socket.md +++ b/docs/manual/socket.md @@ -11,6 +11,7 @@ | socket\_close | 关闭socket句柄。 | | socket\_deinit | tcp/udp 平台~初始化。 | | socket\_init | tcp/udp 平台初始化。 | +| socket\_is\_last\_io\_ok | 判断最后一次IO操作是否正常。 | | socket\_resolve | 解析主机名，并初始化addr对象。 | | socket\_set\_blocking | 设置为阻塞或非阻塞模式。 | | socket\_wait\_for\_data | 等待数据。 | @@ -89,6 +90,24 @@ ret_t socket_init (); | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +#### socket\_is\_last\_io\_ok 函数 +----------------------- + +* 函数功能： + +>

判断最后一次IO操作是否正常。 + +* 函数原型： + +``` +bool_t socket_is_last_io_ok (); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | bool\_t | 返回TRUE表示Broken，否则表示正常。 | #### socket\_resolve 函数 ----------------------- diff --git a/docs/manual/style_t.md b/docs/manual/style_t.md index 95a0ece23..78986bd73 100644 --- a/docs/manual/style_t.md +++ b/docs/manual/style_t.md @@ -20,6 +20,7 @@ uint16_t font_size = style_get_int(style, STYLE_ID_FONT_SIZE, TK_DEFAULT_FONT_SI | -------- | ------------ | | style\_destroy | 销毁style对象 | | style\_get\_color | 获取指定name的颜色值。 | +| style\_get\_gradient | 获取指定name的渐变颜色值。 | | style\_get\_int | 获取指定name的整数格式的值。 | | style\_get\_str | 获取指定name的字符串格式的值。 | | style\_get\_style\_state | 获取风格对象的风格状态 | @@ -72,6 +73,27 @@ color_t style_get_color (style_t* s, const char* name, color_t defval); | s | style\_t* | style对象。 | | name | const char* | 属性名。 | | defval | color\_t | 缺省值。 | +#### style\_get\_gradient 函数 +----------------------- + +* 函数功能： + +>

获取指定name的渐变颜色值。 + +* 函数原型： + +``` +gradient_t* style_get_gradient (style_t* s, const char* name, gradient_t* gradient); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | gradient\_t* | 返回渐变颜色值。 | +| s | style\_t* | style对象。 | +| name | const char* | 属性名。 | +| gradient | gradient\_t* | 返回值。 | #### style\_get\_int 函数 ----------------------- diff --git a/docs/manual/tab_button_group_t.md b/docs/manual/tab_button_group_t.md index be14e560f..d011fdf99 100644 --- a/docs/manual/tab_button_group_t.md +++ b/docs/manual/tab_button_group_t.md @@ -47,6 +47,7 @@ widget\_t的函数均适用于tab\_button\_group\_t控件。 | 属性名称 | 类型 | 说明 | | -------- | ----- | ------------ | | compact | bool\_t | 紧凑型排版子控件(缺省FALSE)。 | +| enable\_hscroll\_animator | bool\_t | 是否开启 tab_button 的左右滚动动画(缺省TRUE)。 | | scrollable | bool\_t | 是否支持滚动(缺省FALSE)。 | #### tab\_button\_group\_cast 函数 ----------------------- @@ -146,6 +147,21 @@ ret_t tab_button_group_set_scrollable (widget_t* widget, bool_t scrollable); | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | +#### enable\_hscroll\_animator 属性 +----------------------- +>

是否开启 tab_button 的左右滚动动画(缺省TRUE)。 + +* 类型：bool\_t + +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | +| 可持久化 | 是 | +| 可在IDE中设置 | 是 | +| 可在XML中设置 | 是 | +| 可通过widget\_get\_prop读取 | 是 | +| 可通过widget\_set\_prop修改 | 是 | #### scrollable 属性 ----------------------- >

是否支持滚动(缺省FALSE)。 diff --git a/docs/manual/text_edit_t.md b/docs/manual/text_edit_t.md index c222dcdac..66296fc2b 100644 --- a/docs/manual/text_edit_t.md +++ b/docs/manual/text_edit_t.md @@ -18,6 +18,7 @@ | text\_edit\_get\_lines\_of\_each\_row | 获取每一个逻辑行(row)占几个物理行(line)。 | | text\_edit\_get\_selected\_text | 获取选中文本。 | | text\_edit\_get\_state | 获取编辑器的状态。 | +| text\_edit\_insert\_text | 插入一段文本。 | | text\_edit\_invert\_caret\_visible | 如果caret可见，将其设置为不可见。 如果caret不可见，将其设置为可见。 | | text\_edit\_key\_down | 处理按键事件。 | | text\_edit\_key\_up | 处理按键事件。 | @@ -38,6 +39,7 @@ | text\_edit\_set\_max\_rows | 设置最大行数。 | | text\_edit\_set\_offset | 设置滚动偏移。 | | text\_edit\_set\_on\_state\_changed | 设置状态改变回调函数。 | +| text\_edit\_set\_overwrite | 设置是否覆盖行。 | | text\_edit\_set\_select | 选择指定范围的文本。 | | text\_edit\_set\_tips | 设置提示信息。 | | text\_edit\_set\_wrap\_word | 设置是否自动折行。 | @@ -259,6 +261,27 @@ ret_t text_edit_get_state (text_edit_t* text_edit, text_edit_state_t* state); | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | text\_edit | text\_edit\_t* | text\_edit对象。 | | state | text\_edit\_state\_t* | 状态。 | +#### text\_edit\_insert\_text 函数 +----------------------- + +* 函数功能： + +>

插入一段文本。 + +* 函数原型： + +``` +ret_t text_edit_insert_text (text_edit_t* text_edit, uint32_t offset, const char* text); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| text\_edit | text\_edit\_t* | text\_edit对象。 | +| offset | uint32\_t | 插入的偏移位置。 | +| text | const char* | 待插入的文本。 | #### text\_edit\_invert\_caret\_visible 函数 ----------------------- @@ -655,6 +678,26 @@ ret_t text_edit_set_on_state_changed (text_edit_t* text_edit, text_edit_on_state | text\_edit | text\_edit\_t* | text\_edit对象。 | | on\_state\_changed | text\_edit\_on\_state\_changed\_t | 回调函数。 | | ctx | void* | 回调函数上下文。 | +#### text\_edit\_set\_overwrite 函数 +----------------------- + +* 函数功能： + +>

设置是否覆盖行。 + +* 函数原型： + +``` +ret_t text_edit_set_overwrite (text_edit_t* text_edit, bool_t overwrite); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| text\_edit | text\_edit\_t* | text\_edit对象。 | +| overwrite | bool\_t | 是否覆盖行。 | #### text\_edit\_set\_select 函数 ----------------------- diff --git a/docs/manual/text_selector_t.md b/docs/manual/text_selector_t.md index b706e095d..d8c09fa08 100644 --- a/docs/manual/text_selector_t.md +++ b/docs/manual/text_selector_t.md @@ -54,6 +54,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L4 | text\_selector\_get\_value | 获取text_selector的值。 | | text\_selector\_reset\_options | 重置所有选项。 | | text\_selector\_set\_animating\_time | 设置滚动动画播放时间。 | +| text\_selector\_set\_enable\_value\_animator | 设置是否修改值时启用动画。 | | text\_selector\_set\_localize\_options | 设置是否本地化(翻译)选项。 | | text\_selector\_set\_loop\_options | 设置是否循环选项。 | | text\_selector\_set\_options | 设置选项。 | @@ -70,6 +71,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L4 | 属性名称 | 类型 | 说明 | | -------- | ----- | ------------ | | animating\_time | uint32\_t | 滚动动画播放时间。(单位毫秒) | +| enable\_value\_animator | bool\_t | 是否修改值时启用动画。 | | localize\_options | bool\_t | 是否本地化(翻译)选项(缺省为FALSE)。 | | loop\_options | bool\_t | 是否循环选项(缺省为FALSE)。 | | options | char* | 设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。 | @@ -262,6 +264,26 @@ ret_t text_selector_set_animating_time (widget_t* widget, uint32_t animating_tim | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | widget | widget\_t* | 控件对象。 | | animating\_time | uint32\_t | 滚动动画播放时间。(单位毫秒) | +#### text\_selector\_set\_enable\_value\_animator 函数 +----------------------- + +* 函数功能： + +>

设置是否修改值时启用动画。 + +* 函数原型： + +``` +ret_t text_selector_set_enable_value_animator (widget_t* widget, bool_t enable_value_animator); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| widget | widget\_t* | 控件对象。 | +| enable\_value\_animator | bool\_t | 是否修改值时启用动画 | #### text\_selector\_set\_localize\_options 函数 ----------------------- @@ -473,6 +495,22 @@ ret_t text_selector_set_yspeed_scale (widget_t* widget, float_t yspeed_scale); * 类型：uint32\_t +| 特性 | 是否支持 | +| -------- | ----- | +| 可直接读取 | 是 | +| 可直接修改 | 否 | +| 可持久化 | 是 | +| 可脚本化 | 是 | +| 可在IDE中设置 | 是 | +| 可在XML中设置 | 是 | +| 可通过widget\_get\_prop读取 | 是 | +| 可通过widget\_set\_prop修改 | 是 | +#### enable\_value\_animator 属性 +----------------------- +>

是否修改值时启用动画。 + +* 类型：bool\_t + | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | diff --git a/docs/manual/value_t.md b/docs/manual/value_t.md index 9f7b3d5ba..aef0c30cf 100644 --- a/docs/manual/value_t.md +++ b/docs/manual/value_t.md @@ -30,6 +30,7 @@ value_set_int(&v, 100); | value\_equal | 判断两个value是否相同。 | | value\_float | 获取类型为float\_t的值。 | | value\_float32 | 获取类型为float的值。 | +| value\_gradient | 获取为gradient的值。 | | value\_int | 转换为int的值。 | | value\_int16 | 获取类型为int16的值。 | | value\_int32 | 获取类型为int32的值。 | @@ -44,6 +45,7 @@ value_set_int(&v, 100); | value\_set\_double | 设置类型为double的值。 | | value\_set\_float | 设置类型为float\_t的值。 | | value\_set\_float32 | 设置类型为float的值。 | +| value\_set\_gradient | 设置类型为gradient的值。 | | value\_set\_int | 设置类型为int的值。 | | value\_set\_int16 | 设置类型为int16的值。 | | value\_set\_int32 | 设置类型为int32的值。 | @@ -346,6 +348,25 @@ float value_float32 (value_t* v); | -------- | ----- | --------- | | 返回值 | float | 值。 | | v | value\_t* | value对象。 | +#### value\_gradient 函数 +----------------------- + +* 函数功能： + +>

获取为gradient的值。 + +* 函数原型： + +``` +binary_data_t* value_gradient (value_t* v); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | binary\_data\_t* | 值。 | +| v | value\_t* | value对象。 | #### value\_int 函数 ----------------------- @@ -618,6 +639,27 @@ value_t* value_set_float32 (value_t* v, float value); | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | float | 待设置的值。 | +#### value\_set\_gradient 函数 +----------------------- + +* 函数功能： + +>

设置类型为gradient的值。 + +* 函数原型： + +``` +value_t* value_set_gradient (value_t* v, void* value, uint32_t size); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | value\_t* | value对象本身。 | +| v | value\_t* | value对象。 | +| value | void* | 待设置的值。 | +| size | uint32\_t | 长度。 | #### value\_set\_int 函数 ----------------------- diff --git a/docs/manual/value_type_t.md b/docs/manual/value_type_t.md index 6d7a5395c..676850ebf 100644 --- a/docs/manual/value_type_t.md +++ b/docs/manual/value_type_t.md @@ -27,3 +27,4 @@ | VALUE\_TYPE\_BINARY | 二进制数据。 | | VALUE\_TYPE\_UBJSON | 二进制数据(UBJSON)。 | | VALUE\_TYPE\_TOKEN | 特殊用途。 | +| VALUE\_TYPE\_GRADIENT | 渐变颜色。 | diff --git a/docs/manual/velocity_t.md b/docs/manual/velocity_t.md index 91d8bbc6a..670dbd133 100644 --- a/docs/manual/velocity_t.md +++ b/docs/manual/velocity_t.md @@ -38,7 +38,7 @@ velocity_t* velocity_reset (velocity_t* v); * 函数原型： ``` -ret_t velocity_update (velocity_t* v, uint32_t time, xy_t x, xy_t y); +ret_t velocity_update (velocity_t* v, uint64_t time, xy_t x, xy_t y); ``` * 参数说明： @@ -47,6 +47,6 @@ ret_t velocity_update (velocity_t* v, uint32_t time, xy_t x, xy_t y); | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | v | velocity\_t* | velocity对象。 | -| time | uint32\_t | 时间。 | +| time | uint64\_t | 时间。 | | x | xy\_t | x坐标。 | | y | xy\_t | y坐标。 | diff --git a/docs/manual/vg_gradient_t.md b/docs/manual/vg_gradient_t.md index da648e288..f2efff409 100644 --- a/docs/manual/vg_gradient_t.md +++ b/docs/manual/vg_gradient_t.md @@ -7,15 +7,12 @@ | 函数名称 | 说明 | | -------- | ------------ | -| vg\_gradient\_add\_stop | 增加关键点。 | | vg\_gradient\_create\_linear | 创建线性渐变。 | | vg\_gradient\_create\_radial | 创建放射渐变。 | | vg\_gradient\_destroy | 销毁gradient对象。 | -| vg\_gradient\_get\_first\_color | 获取开始的颜色。 | -| vg\_gradient\_get\_last\_color | 获取结束的颜色。 | -| vg\_gradient\_get\_stop | 获取关键点。 | | vg\_gradient\_init\_linear | 初始化线性。 | | vg\_gradient\_init\_radial | 初始化放射渐变。 | +| vg\_gradient\_init\_with\_gradient | 初始化矢量画布的渐变对象。 | | vgcanvas\_asset\_manager | 获取缺省矢量画布资源管理器。 | | vgcanvas\_asset\_manager\_add\_font | 添加一个字库资源 | | vgcanvas\_asset\_manager\_add\_image | 添加一个贴图资源 | @@ -34,29 +31,6 @@ | 属性名称 | 类型 | 说明 | | -------- | ----- | ------------ | | info | vg\_gradient\_info\_t | 信息。 | -| nr | uint32\_t | stop个数。 | -| type | vg\_gradient\_type\_t | 类型。 | -#### vg\_gradient\_add\_stop 函数 ------------------------ - -* 函数功能： - ->

增加关键点。 - -* 函数原型： - -``` -ret_t vg_gradient_add_stop (vg_gradient_t* gradient, color_t color, float stop); -``` - -* 参数说明： - -| 参数 | 类型 | 说明 | -| -------- | ----- | --------- | -| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | -| gradient | vg\_gradient\_t* | gradient对象。 | -| color | color\_t | 颜色。 | -| stop | float | 位置。 | #### vg\_gradient\_create\_linear 函数 ----------------------- @@ -122,64 +96,6 @@ ret_t vg_gradient_destroy (vg_gradient_t* gradient); | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | gradient | vg\_gradient\_t* | gradient对象。 | -#### vg\_gradient\_get\_first\_color 函数 ------------------------ - -* 函数功能： - ->

获取开始的颜色。 - -* 函数原型： - -``` -color_t vg_gradient_get_first_color (vg_gradient_t* gradient); -``` - -* 参数说明： - -| 参数 | 类型 | 说明 | -| -------- | ----- | --------- | -| 返回值 | color\_t | 返回颜色。 | -| gradient | vg\_gradient\_t* | gradient对象。 | -#### vg\_gradient\_get\_last\_color 函数 ------------------------ - -* 函数功能： - ->

获取结束的颜色。 - -* 函数原型： - -``` -color_t vg_gradient_get_last_color (vg_gradient_t* gradient); -``` - -* 参数说明： - -| 参数 | 类型 | 说明 | -| -------- | ----- | --------- | -| 返回值 | color\_t | 返回颜色。 | -| gradient | vg\_gradient\_t* | gradient对象。 | -#### vg\_gradient\_get\_stop 函数 ------------------------ - -* 函数功能： - ->

获取关键点。 - -* 函数原型： - -``` -ret_t vg_gradient_get_stop (vg_gradient_t* gradient, uint32_t index); -``` - -* 参数说明： - -| 参数 | 类型 | 说明 | -| -------- | ----- | --------- | -| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | -| gradient | vg\_gradient\_t* | gradient对象。 | -| index | uint32\_t | 序数。 | #### vg\_gradient\_init\_linear 函数 ----------------------- @@ -228,6 +144,27 @@ vg_gradient_t* vg_gradient_init_radial (vg_gradient_t* gradient, float x0, float | x1 | float | 结束圆的x坐标。 | | y1 | float | 结束圆的y坐标。 | | r1 | float | 结束圆的半径。 | +#### vg\_gradient\_init\_with\_gradient 函数 +----------------------- + +* 函数功能： + +>

初始化矢量画布的渐变对象。 + +* 函数原型： + +``` +vg_gradient_t* vg_gradient_init_with_gradient (vg_gradient_t* gradient, const rect_t* rect, const gradient_t* g); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | vg\_gradient\_t* | 返回gradient对象。 | +| gradient | vg\_gradient\_t* | gradient对象。 | +| rect | const rect\_t* | 矩形区域。 | +| g | const gradient\_t* | 渐变对象。 | #### vgcanvas\_asset\_manager 函数 ----------------------- @@ -486,23 +423,3 @@ ret_t vgcanvas_asset_manager_set (vgcanvas_asset_manager_t* vgcanvas_asset_manag | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | -#### nr 属性 ------------------------ ->

stop个数。 - -* 类型：uint32\_t - -| 特性 | 是否支持 | -| -------- | ----- | -| 可直接读取 | 是 | -| 可直接修改 | 否 | -#### type 属性 ------------------------ ->

类型。 - -* 类型：vg\_gradient\_type\_t - -| 特性 | 是否支持 | -| -------- | ----- | -| 可直接读取 | 是 | -| 可直接修改 | 否 | diff --git a/docs/manual/widget_factory_t.md b/docs/manual/widget_factory_t.md index 196909b65..5d01483e6 100644 --- a/docs/manual/widget_factory_t.md +++ b/docs/manual/widget_factory_t.md @@ -17,6 +17,7 @@ | widget\_factory\_create\_widget | 创建指定类型的控件。 | | widget\_factory\_destroy | 析构并释放控件工厂对象。 | | widget\_factory\_register | 注册控件创建函数。 | +| widget\_factory\_register\_multi | 注册控件创建函数。 | | widget\_factory\_set | 设置缺省的控件工厂对象。 | #### widget\_factory 函数 ----------------------- @@ -118,6 +119,26 @@ ret_t widget_factory_register (widget_factory_t* factory, const char* type, widg | factory | widget\_factory\_t* | 控件工厂对象。 | | type | const char* | 控件类型。 | | create | widget\_create\_t | 创建函数。 | +#### widget\_factory\_register\_multi 函数 +----------------------- + +* 函数功能： + +>

注册控件创建函数。 + +* 函数原型： + +``` +ret_t widget_factory_register_multi (widget_factory_t* factory, const general_factory_table_t* table); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| factory | widget\_factory\_t* | 控件工厂对象。 | +| table | const general\_factory\_table\_t* | 表。 | #### widget\_factory\_set 函数 ----------------------- diff --git a/docs/manual/widget_prop_t.md b/docs/manual/widget_prop_t.md index c1871f1fa..c02379540 100644 --- a/docs/manual/widget_prop_t.md +++ b/docs/manual/widget_prop_t.md @@ -47,6 +47,7 @@ | WIDGET\_PROP\_CLOSABLE | 是否可以关闭。 | | WIDGET\_PROP\_POINTER\_CURSOR | 鼠标指针。 | | WIDGET\_PROP\_VALUE | 值。 | +| WIDGET\_PROP\_RADIO | CheckButton是否单选。 | | WIDGET\_PROP\_REVERSE | 进度条反向显示。 | | WIDGET\_PROP\_LENGTH | 长度。 | | WIDGET\_PROP\_LINE\_WRAP | 自动换行。 | diff --git a/docs/manual/widget_t.md b/docs/manual/widget_t.md index 0aa0b8ea5..cd3b6ced1 100644 --- a/docs/manual/widget_t.md +++ b/docs/manual/widget_t.md @@ -64,6 +64,7 @@ widget_on(button, EVT_CLICK, on_click, NULL); | widget\_child\_on | 为指定名称的子控件注册指定事件的处理函数。 | | widget\_clone | clone。 | | widget\_close\_window | 关闭控件所在的窗口。 | +| widget\_close\_window\_force | 关闭控件所在的窗口。 | | widget\_count\_children | 获取子控件的个数。 | | widget\_create | 创建控件。仅在子类控件构造函数中使用。 | | widget\_create\_animator | 创建动画。 | @@ -643,6 +644,25 @@ ret_t widget_close_window (widget_t* widget); * 参数说明： +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| widget | widget\_t* | widget对象。 | +#### widget\_close\_window\_force 函数 +----------------------- + +* 函数功能： + +>

关闭控件所在的窗口。 + +* 函数原型： + +``` +ret_t widget_close_window_force (widget_t* widget); +``` + +* 参数说明： + | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | diff --git a/docs/manual/window_animator_t.md b/docs/manual/window_animator_t.md index 6dac825a5..a0e71a4ee 100644 --- a/docs/manual/window_animator_t.md +++ b/docs/manual/window_animator_t.md @@ -101,7 +101,7 @@ ret_t window_animator_end_frame (window_animator_t* wa); * 函数原型： ``` -ret_t window_animator_update (window_animator_t* wa, canvas_t* canvas, uint32_t time_ms); +ret_t window_animator_update (window_animator_t* wa, canvas_t* canvas, uint64_t time_ms); ``` * 参数说明： @@ -111,4 +111,4 @@ ret_t window_animator_update (window_animator_t* wa, canvas_t* canvas, uint32_t | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | wa | window\_animator\_t* | 窗口动画对象。 | | canvas | canvas\_t* | 画布对象。 | -| time\_ms | uint32\_t | 当前时间(毫秒)。 | +| time\_ms | uint64\_t | 当前时间(毫秒)。 | diff --git a/docs/manual/window_t.md b/docs/manual/window_t.md index df5f7ecbe..0da17b3a9 100644 --- a/docs/manual/window_t.md +++ b/docs/manual/window_t.md @@ -76,7 +76,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau * 函数原型： ``` -ret_t image_blend (bitmap_t* dst, bitmap_t* src, const rect_t* dst_r, const rect_t* src_r, uint8_t global_alpha); +ret_t image_blend (bitmap_t* dst, bitmap_t* src, const rectf_t* dst_r, const rectf_t* src_r, uint8_t global_alpha); ``` * 参数说明： @@ -86,8 +86,8 @@ ret_t image_blend (bitmap_t* dst, bitmap_t* src, const rect_t* dst_r, const rect | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败，返回失败则上层用软件实现。 | | dst | bitmap\_t* | 目标图片对象。 | | src | bitmap\_t* | 源图片对象。 | -| dst\_r | const rect\_t* | 目的区域。 | -| src\_r | const rect\_t* | 源区域。 | +| dst\_r | const rectf\_t* | 目的区域。 | +| src\_r | const rectf\_t* | 源区域。 | | global\_alpha | uint8\_t | 全局alpha。 | #### image\_clear 函数 ----------------------- diff --git a/docs/manual/wstr_t.md b/docs/manual/wstr_t.md index f0de040bc..5fff15f72 100644 --- a/docs/manual/wstr_t.md +++ b/docs/manual/wstr_t.md @@ -41,6 +41,7 @@ wstr_reset(&s); | wstr\_set | 设置字符串。 | | wstr\_set\_utf8 | 设置UTF8字符串。 | | wstr\_set\_utf8\_with\_len | 设置UTF8字符串。 | +| wstr\_set\_with\_len | 设置字符串。 | | wstr\_to\_float | 将字符串转成浮点数。 | | wstr\_to\_int | 将字符串转成整数。 | | wstr\_trim\_float\_zero | 去掉浮点数小数点尾部的零。 | @@ -476,6 +477,27 @@ ret_t wstr_set_utf8_with_len (wstr_t* str, char* text, uint32_t len); | str | wstr\_t* | str对象。 | | text | char* | 要设置的字符串。 | | len | uint32\_t | 长度。 | +#### wstr\_set\_with\_len 函数 +----------------------- + +* 函数功能： + +>

设置字符串。 + +* 函数原型： + +``` +ret_t wstr_set_with_len (wstr_t* str, wchar_t* text, uint32_t len); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| str | wstr\_t* | str对象。 | +| text | wchar\_t* | 要设置的字符串。 | +| len | uint32\_t | 字符串长度。 | #### wstr\_to\_float 函数 -----------------------