mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-11-29 18:48:09 +08:00
update docs
This commit is contained in:
lixianjing
parent
7e91e1f45b
commit
f556b4cc5b
@ -9,7 +9,7 @@
|
||||
| -------- | ------------ |
|
||||
| <a href="#async_t_async_call">async\_call</a> | 异步执行exec函数，执行完成后，在后台线程调用on_result函数。 |
|
||||
| <a href="#async_t_async_call_deinit">async\_call\_deinit</a> | 全局~初始化。 |
|
||||
| <a href="#async_t_async_call_init">async\_call\_init</a> | 全局初始化。 |
|
||||
| <a href="#async_t_async_call_init_ex">async\_call\_init\_ex</a> | 全局初始化。 |
|
||||
#### async\_call 函数
|
||||
-----------------------
|
||||
|
||||
@ -49,17 +49,17 @@ ret_t async_call_deinit ();
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### async\_call\_init 函数
|
||||
#### async\_call\_init\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="async_t_async_call_init">全局初始化。
|
||||
> <p id="async_t_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 | 最小线程数。 |
|
||||
|
||||
@ -7,6 +7,7 @@
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#bitmap_t_bitmap_clone">bitmap\_clone</a> | Clone图片。 |
|
||||
| <a href="#bitmap_t_bitmap_create">bitmap\_create</a> | 创建图片对象(一般供脚本语言中使用)。 |
|
||||
| <a href="#bitmap_t_bitmap_create_ex">bitmap\_create\_ex</a> | 创建图片对象。 |
|
||||
| <a href="#bitmap_t_bitmap_destroy">bitmap\_destroy</a> | 销毁图片。 |
|
||||
@ -23,6 +24,7 @@
|
||||
| <a href="#bitmap_t_bitmap_mono_dump">bitmap\_mono\_dump</a> | dump mono bitmap。 |
|
||||
| <a href="#bitmap_t_bitmap_save_png">bitmap\_save\_png</a> | 把bitmap保存为png。 |
|
||||
| <a href="#bitmap_t_bitmap_set_line_length">bitmap\_set\_line\_length</a> | 设置line_length。 |
|
||||
| <a href="#bitmap_t_bitmap_transform">bitmap\_transform</a> | 对图片每个像素进行变换。 |
|
||||
| <a href="#bitmap_t_bitmap_unlock_buffer">bitmap\_unlock\_buffer</a> | 解锁图像缓冲区。 |
|
||||
### 属性
|
||||
<p id="bitmap_t_properties">
|
||||
@ -36,6 +38,25 @@
|
||||
| <a href="#bitmap_t_line_length">line\_length</a> | uint32\_t | 每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。 |
|
||||
| <a href="#bitmap_t_name">name</a> | const char* | 名称。 |
|
||||
| <a href="#bitmap_t_w">w</a> | wh\_t | 宽度。 |
|
||||
#### bitmap\_clone 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="bitmap_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="bitmap_t_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -26,8 +26,11 @@
|
||||
| <a href="#canvas_t_canvas_draw_vline">canvas\_draw\_vline</a> | 画垂直线。 |
|
||||
| <a href="#canvas_t_canvas_end_frame">canvas\_end\_frame</a> | 绘制结束。 |
|
||||
| <a href="#canvas_t_canvas_fill_rect">canvas\_fill\_rect</a> | 绘制矩形。 |
|
||||
| <a href="#canvas_t_canvas_fill_rect_gradient">canvas\_fill\_rect\_gradient</a> | 绘制矩形。 |
|
||||
| <a href="#canvas_t_canvas_fill_rounded_rect">canvas\_fill\_rounded\_rect</a> | 填充区域。 |
|
||||
| <a href="#canvas_t_canvas_fill_rounded_rect_ex">canvas\_fill\_rounded\_rect\_ex</a> | 填充区域。 |
|
||||
| <a href="#canvas_t_canvas_fill_rounded_rect_ex">canvas\_fill\_rounded\_rect\_ex</a> | 填充圆角矩形区域。 |
|
||||
| <a href="#canvas_t_canvas_fill_rounded_rect_gradient">canvas\_fill\_rounded\_rect\_gradient</a> | 填充圆角矩形区域。 |
|
||||
| <a href="#canvas_t_canvas_fill_rounded_rect_gradient_ex">canvas\_fill\_rounded\_rect\_gradient\_ex</a> | 填充圆角矩形区域。 |
|
||||
| <a href="#canvas_t_canvas_get_clip_rect">canvas\_get\_clip\_rect</a> | 获取裁剪区。 |
|
||||
| <a href="#canvas_t_canvas_get_font_height">canvas\_get\_font\_height</a> | 获取字体的高度。 |
|
||||
| <a href="#canvas_t_canvas_get_height">canvas\_get\_height</a> | 获取画布的高度。 |
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="canvas_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
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="canvas_t_canvas_fill_rounded_rect_ex">填充区域。
|
||||
> <p id="canvas_t_canvas_fill_rounded_rect_ex">填充圆角矩形区域。
|
||||
半径半径小于等于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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="canvas_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="canvas_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -72,6 +72,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#check_button_t_radio">radio</a> | bool\_t | 是否是单选按钮。 |
|
||||
| <a href="#check_button_t_value">value</a> | bool\_t | 值(勾选为TRUE，非勾选为FALSE)。 |
|
||||
### 事件
|
||||
<p id="check_button_t_events">
|
||||
@ -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 属性
|
||||
-----------------------
|
||||
> <p id="check_button_t_radio">是否是单选按钮。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 否 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### value 属性
|
||||
-----------------------
|
||||
> <p id="check_button_t_value">值(勾选为TRUE，非勾选为FALSE)。
|
||||
|
||||
@ -125,6 +125,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau
|
||||
| <a href="#combo_box_t_combo_box_get_option">combo\_box\_get\_option</a> | 获取第index个选项。 |
|
||||
| <a href="#combo_box_t_combo_box_get_text">combo\_box\_get\_text</a> | 获取combo_box的文本。 |
|
||||
| <a href="#combo_box_t_combo_box_get_value">combo\_box\_get\_value</a> | 获取combo_box的值。 |
|
||||
| <a href="#combo_box_t_combo_box_remove_option">combo\_box\_remove\_option</a> | 删除选项。 |
|
||||
| <a href="#combo_box_t_combo_box_reset_options">combo\_box\_reset\_options</a> | 重置所有选项。 |
|
||||
| <a href="#combo_box_t_combo_box_set_custom_open_popup">combo\_box\_set\_custom\_open\_popup</a> | 设置自定义的打开弹出窗口的函数。 |
|
||||
| <a href="#combo_box_t_combo_box_set_item_height">combo\_box\_set\_item\_height</a> | 设置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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="combo_box_t_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -16,8 +16,10 @@
|
||||
| <a href="#conf_doc_t_conf_doc_destroy">conf\_doc\_destroy</a> | 析构函数。 |
|
||||
| <a href="#conf_doc_t_conf_doc_destroy_node">conf\_doc\_destroy\_node</a> | 销毁节点对象。 |
|
||||
| <a href="#conf_doc_t_conf_doc_exists">conf\_doc\_exists</a> | 判断指定路径的节点是否存在。 |
|
||||
| <a href="#conf_doc_t_conf_doc_find_node">conf\_doc\_find\_node</a> | 根据path查找节点。 |
|
||||
| <a href="#conf_doc_t_conf_doc_get">conf\_doc\_get</a> | 获取指定路径节点的值。 |
|
||||
| <a href="#conf_doc_t_conf_doc_get_bool">conf\_doc\_get\_bool</a> | 获取指定路径节点的值。 |
|
||||
| <a href="#conf_doc_t_conf_doc_get_ex">conf\_doc\_get\_ex</a> | 获取指定路径节点的值。 |
|
||||
| <a href="#conf_doc_t_conf_doc_get_float">conf\_doc\_get\_float</a> | 获取指定路径节点的值。 |
|
||||
| <a href="#conf_doc_t_conf_doc_get_int">conf\_doc\_get\_int</a> | 获取指定路径节点的值。 |
|
||||
| <a href="#conf_doc_t_conf_doc_get_str">conf\_doc\_get\_str</a> | 获取指定路径节点的值。 |
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -33,7 +33,9 @@ darray_destroy(darray);
|
||||
| <a href="#darray_t_darray_destroy">darray\_destroy</a> | 销毁darray对象。 |
|
||||
| <a href="#darray_t_darray_find">darray\_find</a> | 查找第一个满足条件的元素。 |
|
||||
| <a href="#darray_t_darray_find_all">darray\_find\_all</a> | 查找全部满足条件的元素。 |
|
||||
| <a href="#darray_t_darray_find_ex">darray\_find\_ex</a> | 查找第一个满足条件的元素。 |
|
||||
| <a href="#darray_t_darray_find_index">darray\_find\_index</a> | 查找第一个满足条件的元素，并返回位置。 |
|
||||
| <a href="#darray_t_darray_find_index_ex">darray\_find\_index\_ex</a> | 查找第一个满足条件的元素，并返回位置。 |
|
||||
| <a href="#darray_t_darray_foreach">darray\_foreach</a> | 遍历元素。 |
|
||||
| <a href="#darray_t_darray_get">darray\_get</a> | 获取指定序数的元素。 |
|
||||
| <a href="#darray_t_darray_head">darray\_head</a> | 返回第一个元素。 |
|
||||
@ -43,8 +45,12 @@ darray_destroy(darray);
|
||||
| <a href="#darray_t_darray_push">darray\_push</a> | 在尾巴追加一个元素。 |
|
||||
| <a href="#darray_t_darray_remove">darray\_remove</a> | 删除第一个满足条件的元素。 |
|
||||
| <a href="#darray_t_darray_remove_all">darray\_remove\_all</a> | 删除全部满足条件的元素。 |
|
||||
| <a href="#darray_t_darray_remove_ex">darray\_remove\_ex</a> | 删除第一个满足条件的元素。 |
|
||||
| <a href="#darray_t_darray_remove_index">darray\_remove\_index</a> | 删除指定位置的元素。 |
|
||||
| <a href="#darray_t_darray_replace">darray\_replace</a> | 设置指定序数的元素(销毁旧的数据)。 |
|
||||
| <a href="#darray_t_darray_set">darray\_set</a> | 设置指定序数的元素(不销毁旧的数据)。 |
|
||||
| <a href="#darray_t_darray_sort">darray\_sort</a> | 排序。 |
|
||||
| <a href="#darray_t_darray_sorted_insert">darray\_sorted\_insert</a> | 插入一个元素到有序数组。 |
|
||||
| <a href="#darray_t_darray_tail">darray\_tail</a> | 返回最后一个元素。 |
|
||||
### 属性
|
||||
<p id="darray_t_properties">
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="darray_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="darray_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="darray_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="darray_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="darray_t_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -104,7 +104,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau
|
||||
| <a href="#edit_t_cancelable">cancelable</a> | bool\_t | 是否支持撤销编辑。如果为TRUE，在失去焦点之前可以撤销所有修改(恢复获得焦点之前的内容)。 |
|
||||
| <a href="#edit_t_close_im_when_blured">close\_im\_when\_blured</a> | bool\_t | 是否在失去焦点时关闭输入法(默认是)。 |
|
||||
| <a href="#edit_t_input_type">input\_type</a> | input\_type\_t | 输入类型。 |
|
||||
| <a href="#edit_t_keyboard">keyboard</a> | char* | 自定义软键盘名称。AWTK优先查找keyboard属性设置的键盘文件名（该键盘的XML文件需要在default\raw\ui目录下存在），如果keyboard为空就找input_type设置的键盘类型 |
|
||||
| <a href="#edit_t_keyboard">keyboard</a> | char* | 自定义软键盘名称。AWTK优先查找keyboard属性设置的键盘文件名（该键盘的XML文件需要在default\raw\ui目录下存在），如果没有指定keyboard，就找input_type设置的键盘类型。如果指定为空字符串，则表示不需要软键盘。 |
|
||||
| <a href="#edit_t_max">max</a> | double | 最大值或最大长度。 |
|
||||
| <a href="#edit_t_min">min</a> | double | 最小值或最小长度。 |
|
||||
| <a href="#edit_t_open_im_when_focused">open\_im\_when\_focused</a> | bool\_t | 获得焦点时打开输入法。 |
|
||||
@ -865,7 +865,7 @@ ret_t edit_set_tr_tips (widget_t* widget, const char* tr_tips);
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### keyboard 属性
|
||||
-----------------------
|
||||
> <p id="edit_t_keyboard">自定义软键盘名称。AWTK优先查找keyboard属性设置的键盘文件名（该键盘的XML文件需要在default\raw\ui目录下存在），如果keyboard为空就找input_type设置的键盘类型
|
||||
> <p id="edit_t_keyboard">自定义软键盘名称。AWTK优先查找keyboard属性设置的键盘文件名（该键盘的XML文件需要在default\raw\ui目录下存在），如果没有指定keyboard，就找input_type设置的键盘类型。如果指定为空字符串，则表示不需要软键盘。
|
||||
|
||||
* 类型：char*
|
||||
|
||||
|
||||
28
docs/manual/ext_widgets_t.md
Normal file
28
docs/manual/ext_widgets_t.md
Normal file
@ -0,0 +1,28 @@
|
||||
## ext\_widgets\_t
|
||||
### 概述
|
||||
扩展控件。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="ext_widgets_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#ext_widgets_t_tk_ext_widgets_init">tk\_ext\_widgets\_init</a> | 初始化AWTK扩展控件。 |
|
||||
#### tk\_ext\_widgets\_init 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="ext_widgets_t_tk_ext_widgets_init">初始化AWTK扩展控件。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_ext_widgets_init ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
@ -15,6 +15,7 @@
|
||||
| <a href="#fscript_t_fscript_global_deinit">fscript\_global\_deinit</a> | 全局释放。 |
|
||||
| <a href="#fscript_t_fscript_global_init">fscript\_global\_init</a> | 全局初始化。 |
|
||||
| <a href="#fscript_t_fscript_register_func">fscript\_register\_func</a> | 注册全局自定义函数。 |
|
||||
| <a href="#fscript_t_fscript_register_funcs">fscript\_register\_funcs</a> | 注册全局自定义函数。 |
|
||||
| <a href="#fscript_t_fscript_set_error">fscript\_set\_error</a> | 用于扩展函数设置遇到的错误。 |
|
||||
| <a href="#fscript_t_fscript_syntax_check">fscript\_syntax\_check</a> | 解析代码，分析是否有语法错误。 |
|
||||
| <a href="#fscript_t_tk_expr_eval">tk\_expr\_eval</a> | 对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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fscript_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
31
docs/manual/gradient_stop_t.md
Normal file
31
docs/manual/gradient_stop_t.md
Normal file
@ -0,0 +1,31 @@
|
||||
## gradient\_stop\_t
|
||||
### 概述
|
||||
渐变关键点。
|
||||
----------------------------------
|
||||
### 属性
|
||||
<p id="gradient_stop_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#gradient_stop_t_color">color</a> | color\_t | 颜色。 |
|
||||
| <a href="#gradient_stop_t_offset">offset</a> | float | 偏移量(0-1)。 |
|
||||
#### color 属性
|
||||
-----------------------
|
||||
> <p id="gradient_stop_t_color">颜色。
|
||||
|
||||
* 类型：color\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### offset 属性
|
||||
-----------------------
|
||||
> <p id="gradient_stop_t_offset">偏移量(0-1)。
|
||||
|
||||
* 类型：float
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
343
docs/manual/gradient_t.md
Normal file
343
docs/manual/gradient_t.md
Normal file
@ -0,0 +1,343 @@
|
||||
## gradient\_t
|
||||
### 概述
|
||||
渐变。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="gradient_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#gradient_t_gradient_add_stop">gradient\_add\_stop</a> | 增加关键点。 |
|
||||
| <a href="#gradient_t_gradient_deinit">gradient\_deinit</a> | 释放gradient对象。 |
|
||||
| <a href="#gradient_t_gradient_get_color">gradient\_get\_color</a> | 获取颜色。 |
|
||||
| <a href="#gradient_t_gradient_get_first_color">gradient\_get\_first\_color</a> | 获取开始的颜色。 |
|
||||
| <a href="#gradient_t_gradient_get_last_color">gradient\_get\_last\_color</a> | 获取结束的颜色。 |
|
||||
| <a href="#gradient_t_gradient_get_stop">gradient\_get\_stop</a> | 获取关键点。 |
|
||||
| <a href="#gradient_t_gradient_init">gradient\_init</a> | 初始化gradient对象。 |
|
||||
| <a href="#gradient_t_gradient_init_from_binary">gradient\_init\_from\_binary</a> | 从二进制数据初始化gradient对象。 |
|
||||
| <a href="#gradient_t_gradient_init_from_str">gradient\_init\_from\_str</a> | 从字符串初始化gradient对象。 |
|
||||
| <a href="#gradient_t_gradient_init_simple">gradient\_init\_simple</a> | 初始化gradient对象。 |
|
||||
| <a href="#gradient_t_gradient_set_linear_degree">gradient\_set\_linear\_degree</a> | 设置线性渐变的角度。 |
|
||||
| <a href="#gradient_t_gradient_set_type">gradient\_set\_type</a> | 设置类型。 |
|
||||
| <a href="#gradient_t_gradient_to_binary">gradient\_to\_binary</a> | 转成二进制格式。 |
|
||||
| <a href="#gradient_t_gradient_to_str">gradient\_to\_str</a> | 转换成字符串格式。 |
|
||||
### 属性
|
||||
<p id="gradient_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#gradient_t_degree">degree</a> | uint32\_t | 线性渐变的角度。 |
|
||||
| <a href="#gradient_t_nr">nr</a> | uint32\_t | stop个数。 |
|
||||
| <a href="#gradient_t_type">type</a> | gradient\_type\_t | 类型。 |
|
||||
#### gradient\_add\_stop 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_t_gradient_deinit">释放gradient对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t gradient_deinit (gradient_t* gradient);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| gradient | gradient\_t* | gradient对象。 |
|
||||
#### gradient\_get\_color 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_t_gradient_get_first_color">获取开始的颜色。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
color_t gradient_get_first_color (gradient_t* gradient);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | color\_t | 返回颜色。 |
|
||||
| gradient | gradient\_t* | gradient对象。 |
|
||||
#### gradient\_get\_last\_color 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_t_gradient_get_last_color">获取结束的颜色。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
color_t gradient_get_last_color (gradient_t* gradient);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | color\_t | 返回颜色。 |
|
||||
| gradient | gradient\_t* | gradient对象。 |
|
||||
#### gradient\_get\_stop 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_t_gradient_init">初始化gradient对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
gradient_t* gradient_init (gradient_t* gradient);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | gradient\_t* | 返回gradient对象。 |
|
||||
| gradient | gradient\_t* | gradient对象。 |
|
||||
#### gradient\_init\_from\_binary 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="gradient_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 属性
|
||||
-----------------------
|
||||
> <p id="gradient_t_degree">线性渐变的角度。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### nr 属性
|
||||
-----------------------
|
||||
> <p id="gradient_t_nr">stop个数。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### type 属性
|
||||
-----------------------
|
||||
> <p id="gradient_t_type">类型。
|
||||
|
||||
* 类型：gradient\_type\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
11
docs/manual/gradient_type_t.md
Normal file
11
docs/manual/gradient_type_t.md
Normal file
@ -0,0 +1,11 @@
|
||||
## gradient\_type\_t
|
||||
### 概述
|
||||
渐变色类型。
|
||||
### 常量
|
||||
<p id="gradient_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| GRADIENT\_NONE | 无效类型。 |
|
||||
| GRADIENT\_LINEAR | 线性渐变。 |
|
||||
| GRADIENT\_RADIAL | 放射渐变。 |
|
||||
@ -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来设置控件的显示风格，如字体的大小和颜色等等。如：
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@
|
||||
| <a href="#image_manager_t_image_manager_preload">image\_manager\_preload</a> | 预加载指定的图片。 |
|
||||
| <a href="#image_manager_t_image_manager_set">image\_manager\_set</a> | 设置缺省的图片管理器。 |
|
||||
| <a href="#image_manager_t_image_manager_set_assets_manager">image\_manager\_set\_assets\_manager</a> | 设置资源管理器对象。 |
|
||||
| <a href="#image_manager_t_image_manager_set_max_mem_size_of_cached_images">image\_manager\_set\_max\_mem\_size\_of\_cached\_images</a> | 设置图片缓存占用的最大内存。 |
|
||||
| <a href="#image_manager_t_image_manager_unload_all">image\_manager\_unload\_all</a> | 从图片管理器中卸载全部图片。 |
|
||||
| <a href="#image_manager_t_image_manager_unload_bitmap">image\_manager\_unload\_bitmap</a> | 从图片管理器中卸载指定的图片。 |
|
||||
| <a href="#image_manager_t_image_manager_unload_unused">image\_manager\_unload\_unused</a> | 从图片管理器中卸载指定时间内没有使用的图片。 |
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="image_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
BIN
docs/manual/images/object_widget_t_0.png
Normal file
BIN
docs/manual/images/object_widget_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.1 KiB |
158
docs/manual/lcd_fb_dirty_rects_t.md
Normal file
158
docs/manual/lcd_fb_dirty_rects_t.md
Normal file
@ -0,0 +1,158 @@
|
||||
## lcd\_fb\_dirty\_rects\_t
|
||||
### 概述
|
||||
lcd fb脏矩形。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="lcd_fb_dirty_rects_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#lcd_fb_dirty_rects_t_lcd_fb_dirty_rects_add_fb_info">lcd\_fb\_dirty\_rects\_add\_fb\_info</a> | 添加新的 fb 信息 |
|
||||
| <a href="#lcd_fb_dirty_rects_t_lcd_fb_dirty_rects_deinit">lcd\_fb\_dirty\_rects\_deinit</a> | 清除 lcd_fb_dirty_rects_t 对象数据 |
|
||||
| <a href="#lcd_fb_dirty_rects_t_lcd_fb_dirty_rects_get_dirty_rects_by_fb">lcd\_fb\_dirty\_rects\_get\_dirty\_rects\_by\_fb</a> | 根据 fb 来获取脏矩形对象 |
|
||||
| <a href="#lcd_fb_dirty_rects_t_lcd_fb_dirty_rects_init">lcd\_fb\_dirty\_rects\_init</a> | 初始化 lcd_fb_dirty_rects_t 对象 |
|
||||
| <a href="#lcd_fb_dirty_rects_t_lcd_fb_dirty_rects_reinit">lcd\_fb\_dirty\_rects\_reinit</a> | 修改 lcd_fb_dirty_rects_t 对象的宽高 |
|
||||
| <a href="#lcd_fb_dirty_rects_t_lcd_fb_dirty_rects_reset_dirty_rects_by_fb">lcd\_fb\_dirty\_rects\_reset\_dirty\_rects\_by\_fb</a> | 清除对应 fb 的脏矩形列表。 |
|
||||
| <a href="#lcd_fb_dirty_rects_t_lcd_fb_dirty_rects_update_all_fb_dirty_rects">lcd\_fb\_dirty\_rects\_update\_all\_fb\_dirty\_rects</a> | 把当前脏矩形列表合并到所有 fb 的脏矩形中。 |
|
||||
#### lcd\_fb\_dirty\_rects\_add\_fb\_info 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="lcd_fb_dirty_rects_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="lcd_fb_dirty_rects_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="lcd_fb_dirty_rects_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="lcd_fb_dirty_rects_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="lcd_fb_dirty_rects_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="lcd_fb_dirty_rects_t_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* | 当前脏矩形列表。 |
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -11,6 +11,7 @@
|
||||
| <a href="#main_loop_t_main_loop_add_event_source">main\_loop\_add\_event\_source</a> | 添加event_source。 |
|
||||
| <a href="#main_loop_t_main_loop_remove_event_source">main\_loop\_remove\_event\_source</a> | 删除event_source。 |
|
||||
| <a href="#main_loop_t_main_loop_remove_event_source_by_tag">main\_loop\_remove\_event\_source\_by\_tag</a> | 删除event_source。 |
|
||||
| <a href="#main_loop_t_main_loop_step">main\_loop\_step</a> | 执行一次迭代。 |
|
||||
#### 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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="main_loop_t_main_loop_step">执行一次迭代。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t main_loop_step (main_loop_t* l);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| l | main\_loop\_t* | main\_loop对象。 |
|
||||
|
||||
@ -35,6 +35,7 @@ time\_clock一般不需要设置style。
|
||||
| <a href="#mledit_t_mledit_create">mledit\_create</a> | 创建mledit对象 |
|
||||
| <a href="#mledit_t_mledit_get_cursor">mledit\_get\_cursor</a> | 获取编辑器光标位置。 |
|
||||
| <a href="#mledit_t_mledit_get_selected_text">mledit\_get\_selected\_text</a> | 获取选中的文本。 |
|
||||
| <a href="#mledit_t_mledit_insert_text">mledit\_insert\_text</a> | 插入一段文本。 |
|
||||
| <a href="#mledit_t_mledit_scroll_to_offset">mledit\_scroll\_to\_offset</a> | 设置编辑器滚动到指定偏移位置。 |
|
||||
| <a href="#mledit_t_mledit_set_cancelable">mledit\_set\_cancelable</a> | 设置编辑器是否为可撤销修改。 |
|
||||
| <a href="#mledit_t_mledit_set_close_im_when_blured">mledit\_set\_close\_im\_when\_blured</a> | 设置编辑器是否在失去焦点时关闭输入法。 |
|
||||
@ -44,6 +45,7 @@ time\_clock一般不需要设置style。
|
||||
| <a href="#mledit_t_mledit_set_max_chars">mledit\_set\_max\_chars</a> | 设置编辑器的最大字符数（0 为不限制字符数）。 |
|
||||
| <a href="#mledit_t_mledit_set_max_lines">mledit\_set\_max\_lines</a> | 设置编辑器的最大行数。 |
|
||||
| <a href="#mledit_t_mledit_set_open_im_when_focused">mledit\_set\_open\_im\_when\_focused</a> | 设置编辑器是否在获得焦点时打开输入法。 |
|
||||
| <a href="#mledit_t_mledit_set_overwrite">mledit\_set\_overwrite</a> | 设置编辑器是否启用覆盖行（在行数达到最大行数时，可继续新增行，但最早的行将会消失）。 |
|
||||
| <a href="#mledit_t_mledit_set_readonly">mledit\_set\_readonly</a> | 设置编辑器是否为只读。 |
|
||||
| <a href="#mledit_t_mledit_set_scroll_line">mledit\_set\_scroll\_line</a> | 设置编辑器滚动速度。 |
|
||||
| <a href="#mledit_t_mledit_set_select">mledit\_set\_select</a> | 选择编辑器中指定范围的文本。 |
|
||||
@ -61,6 +63,7 @@ time\_clock一般不需要设置style。
|
||||
| <a href="#mledit_t_max_chars">max\_chars</a> | uint32\_t | 最大字符数。 |
|
||||
| <a href="#mledit_t_max_lines">max\_lines</a> | uint32\_t | 最大行数。 |
|
||||
| <a href="#mledit_t_open_im_when_focused">open\_im\_when\_focused</a> | bool\_t | 获得焦点时打开输入法。 |
|
||||
| <a href="#mledit_t_overwrite">overwrite</a> | bool\_t | 是否启用覆盖行。 |
|
||||
| <a href="#mledit_t_readonly">readonly</a> | bool\_t | 编辑器是否为只读。 |
|
||||
| <a href="#mledit_t_scroll_line">scroll\_line</a> | uint32\_t | 鼠标一次滚动行数。 |
|
||||
| <a href="#mledit_t_tips">tips</a> | char* | 输入提示。 |
|
||||
@ -154,6 +157,27 @@ char* mledit_get_selected_text (widget_t* widget);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | char* | 返回选中文本。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
#### mledit\_insert\_text 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="mledit_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="mledit_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 属性
|
||||
-----------------------
|
||||
> <p id="mledit_t_overwrite">是否启用覆盖行。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -8,7 +8,10 @@
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#named_value_t_named_value_cast">named\_value\_cast</a> | 转换为named_value对象(供脚本语言使用)。 |
|
||||
| <a href="#named_value_t_named_value_compare">named\_value\_compare</a> | 比较。 |
|
||||
| <a href="#named_value_t_named_value_compare_by_name">named\_value\_compare\_by\_name</a> | 比较。 |
|
||||
| <a href="#named_value_t_named_value_create">named\_value\_create</a> | 创建named_value对象。 |
|
||||
| <a href="#named_value_t_named_value_create_ex">named\_value\_create\_ex</a> | 创建named_value对象。 |
|
||||
| <a href="#named_value_t_named_value_deinit">named\_value\_deinit</a> | 重置named_value对象。 |
|
||||
| <a href="#named_value_t_named_value_destroy">named\_value\_destroy</a> | 销毁named_value对象。 |
|
||||
| <a href="#named_value_t_named_value_get_value">named\_value\_get\_value</a> | 获取值对象(主要给脚本语言使用)。 |
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="named_value_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="named_value_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="named_value_t_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -20,6 +20,8 @@
|
||||
| <a href="#native_window_t_native_window_restore">native\_window\_restore</a> | 恢复窗口大小。 |
|
||||
| <a href="#native_window_t_native_window_set_cursor">native\_window\_set\_cursor</a> | 设置鼠标光标。 |
|
||||
| <a href="#native_window_t_native_window_set_fullscreen">native\_window\_set\_fullscreen</a> | 是否全屏。 |
|
||||
| <a href="#native_window_t_native_window_set_orientation">native\_window\_set\_orientation</a> | 调整窗口旋转。 |
|
||||
| <a href="#native_window_t_native_window_set_title">native\_window\_set\_title</a> | 设置程序窗口的名称。 |
|
||||
| <a href="#native_window_t_native_window_show_border">native\_window\_show\_border</a> | 是否显示边框。 |
|
||||
#### 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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="native_window_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="native_window_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -14,16 +14,9 @@
|
||||
| <a href="#object_default_t_object_default_clear_props">object\_default\_clear\_props</a> | 清除全部属性。 |
|
||||
| <a href="#object_default_t_object_default_clone">object\_default\_clone</a> | 克隆对象。 |
|
||||
| <a href="#object_default_t_object_default_create">object\_default\_create</a> | 创建对象。 |
|
||||
| <a href="#object_default_t_object_default_create_ex">object\_default\_create\_ex</a> | 创建对象。 |
|
||||
| <a href="#object_default_t_object_default_find_prop">object\_default\_find\_prop</a> | 查找满足条件的属性，并返回它的值。 |
|
||||
| <a href="#object_default_t_object_default_unref">object\_default\_unref</a> | for script gc |
|
||||
### 属性
|
||||
<p id="object_default_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#object_default_t_props">props</a> | named\_value\_t | 属性数组。 |
|
||||
| <a href="#object_default_t_props_capacity">props\_capacity</a> | uint32\_t | 属性数组的容量。 |
|
||||
| <a href="#object_default_t_props_size">props\_size</a> | uint32\_t | 属性个数。 |
|
||||
#### object\_default\_clear\_props 函数
|
||||
-----------------------
|
||||
|
||||
@ -80,6 +73,25 @@ object_t* object_default_create ();
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回object对象。 |
|
||||
#### object\_default\_create\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_default_t_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 属性
|
||||
-----------------------
|
||||
> <p id="object_default_t_props">属性数组。
|
||||
|
||||
* 类型：named\_value\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### props\_capacity 属性
|
||||
-----------------------
|
||||
> <p id="object_default_t_props_capacity">属性数组的容量。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### props\_size 属性
|
||||
-----------------------
|
||||
> <p id="object_default_t_props_size">属性个数。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
|
||||
@ -15,10 +15,12 @@
|
||||
| <a href="#object_t_object_compare">object\_compare</a> | 比较两个对象。 |
|
||||
| <a href="#object_t_object_copy_prop">object\_copy\_prop</a> | 拷贝指定的属性。 |
|
||||
| <a href="#object_t_object_create">object\_create</a> | 创建对象。 |
|
||||
| <a href="#object_t_object_create_ex">object\_create\_ex</a> | 创建对象。 |
|
||||
| <a href="#object_t_object_eval">object\_eval</a> | 计算一个表达式，表达式中引用的变量从prop中获取。 |
|
||||
| <a href="#object_t_object_exec">object\_exec</a> | 执行指定的命令。 |
|
||||
| <a href="#object_t_object_exec_by_path">object\_exec\_by\_path</a> | 执行指定的命令。 |
|
||||
| <a href="#object_t_object_foreach_prop">object\_foreach\_prop</a> | 遍历所有属性。 |
|
||||
| <a href="#object_t_object_get_child_object">object\_get\_child\_object</a> | 获取下一级子对象。 |
|
||||
| <a href="#object_t_object_get_desc">object\_get\_desc</a> | 获取对象的描述信息。 |
|
||||
| <a href="#object_t_object_get_prop">object\_get\_prop</a> | 获取指定属性的值。 |
|
||||
| <a href="#object_t_object_get_prop_bool">object\_get\_prop\_bool</a> | 获取指定属性的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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_t_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
48
docs/manual/object_widget_t.md
Normal file
48
docs/manual/object_widget_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## object\_widget\_t
|
||||
### 概述
|
||||
|
||||
|
||||
将widget包装成object。
|
||||
> 备注：主要用于 fscript 实现 widget.prop 方式访问控件属性。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="object_widget_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#object_widget_t_object_widget_create">object\_widget\_create</a> | 创建widget对象。 |
|
||||
### 属性
|
||||
<p id="object_widget_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#object_widget_t_widget">widget</a> | widget\_t* | widget对象。 |
|
||||
#### object\_widget\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_widget_t_object_widget_create">创建widget对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* object_widget_create (widget_t* widget);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回object对象。 |
|
||||
| widget | widget\_t* | 控件。 |
|
||||
#### widget 属性
|
||||
-----------------------
|
||||
> <p id="object_widget_t_widget">widget对象。
|
||||
|
||||
* 类型：widget\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
@ -16,6 +16,7 @@
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#orientation_event_t_old_orientation">old\_orientation</a> | int32\_t | 旧的屏幕方向。 |
|
||||
| <a href="#orientation_event_t_orientation">orientation</a> | 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 属性
|
||||
-----------------------
|
||||
> <p id="orientation_event_t_old_orientation">旧的屏幕方向。
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
#### orientation 属性
|
||||
-----------------------
|
||||
> <p id="orientation_event_t_orientation">屏幕方向。
|
||||
|
||||
@ -12,12 +12,15 @@
|
||||
| <a href="#rect_t_rect_create">rect\_create</a> | 创建rect对象。 |
|
||||
| <a href="#rect_t_rect_destroy">rect\_destroy</a> | 销毁rect对象。 |
|
||||
| <a href="#rect_t_rect_fix">rect\_fix</a> | 确保rect在指定的大小范围内。 |
|
||||
| <a href="#rect_t_rect_from_rectf">rect\_from\_rectf</a> | rectf 类型转换到 rect 类型。 |
|
||||
| <a href="#rect_t_rect_has_intersect">rect\_has\_intersect</a> | 判断两个rect的是否存在交集。 |
|
||||
| <a href="#rect_t_rect_init">rect\_init</a> | 初始化rect对象。 |
|
||||
| <a href="#rect_t_rect_intersect">rect\_intersect</a> | 求两个rect的交集。 |
|
||||
| <a href="#rect_t_rect_merge">rect\_merge</a> | 合并两个rect对象。 |
|
||||
| <a href="#rect_t_rect_scale">rect\_scale</a> | 缩放rect对象。 |
|
||||
| <a href="#rect_t_rect_set">rect\_set</a> | 设置rect对象的xywh。 |
|
||||
| <a href="#rect_t_rect_to_rectf">rect\_to\_rectf</a> | rect 类型转换到 rectf 类型。 |
|
||||
| <a href="#rect_t_rectf_scale">rectf\_scale</a> | 缩放rectf对象。 |
|
||||
### 属性
|
||||
<p id="rect_t_properties">
|
||||
|
||||
@ -133,6 +136,25 @@ rect_t rect_fix (rect_t* r);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | rect\_t | 返回修复之后的rect对象。 |
|
||||
| r | rect\_t* | rect对象。 |
|
||||
#### rect\_from\_rectf 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="rect_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="rect_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="rect_t_rectf_scale">缩放rectf对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
rectf_t* rectf_scale (rectf_t* r, float_t scale);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | rectf\_t* | 返回rect对象。 |
|
||||
| r | rectf\_t* | rect对象。 |
|
||||
| scale | float\_t | 缩放比例。 |
|
||||
#### h 属性
|
||||
-----------------------
|
||||
> <p id="rect_t_h">高度。
|
||||
|
||||
@ -11,6 +11,7 @@
|
||||
| <a href="#socket_socket_close">socket\_close</a> | 关闭socket句柄。 |
|
||||
| <a href="#socket_socket_deinit">socket\_deinit</a> | tcp/udp 平台~初始化。 |
|
||||
| <a href="#socket_socket_init">socket\_init</a> | tcp/udp 平台初始化。 |
|
||||
| <a href="#socket_socket_is_last_io_ok">socket\_is\_last\_io\_ok</a> | 判断最后一次IO操作是否正常。 |
|
||||
| <a href="#socket_socket_resolve">socket\_resolve</a> | 解析主机名，并初始化addr对象。 |
|
||||
| <a href="#socket_socket_set_blocking">socket\_set\_blocking</a> | 设置为阻塞或非阻塞模式。 |
|
||||
| <a href="#socket_socket_wait_for_data">socket\_wait\_for\_data</a> | 等待数据。 |
|
||||
@ -89,6 +90,24 @@ ret_t socket_init ();
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### socket\_is\_last\_io\_ok 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="socket_socket_is_last_io_ok">判断最后一次IO操作是否正常。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t socket_is_last_io_ok ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回TRUE表示Broken，否则表示正常。 |
|
||||
#### socket\_resolve 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -20,6 +20,7 @@ uint16_t font_size = style_get_int(style, STYLE_ID_FONT_SIZE, TK_DEFAULT_FONT_SI
|
||||
| -------- | ------------ |
|
||||
| <a href="#style_t_style_destroy">style\_destroy</a> | 销毁style对象 |
|
||||
| <a href="#style_t_style_get_color">style\_get\_color</a> | 获取指定name的颜色值。 |
|
||||
| <a href="#style_t_style_get_gradient">style\_get\_gradient</a> | 获取指定name的渐变颜色值。 |
|
||||
| <a href="#style_t_style_get_int">style\_get\_int</a> | 获取指定name的整数格式的值。 |
|
||||
| <a href="#style_t_style_get_str">style\_get\_str</a> | 获取指定name的字符串格式的值。 |
|
||||
| <a href="#style_t_style_get_style_state">style\_get\_style\_state</a> | 获取风格对象的风格状态 |
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="style_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -47,6 +47,7 @@ widget\_t的函数均适用于tab\_button\_group\_t控件。
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#tab_button_group_t_compact">compact</a> | bool\_t | 紧凑型排版子控件(缺省FALSE)。 |
|
||||
| <a href="#tab_button_group_t_enable_hscroll_animator">enable\_hscroll\_animator</a> | bool\_t | 是否开启 tab_button 的左右滚动动画(缺省TRUE)。 |
|
||||
| <a href="#tab_button_group_t_scrollable">scrollable</a> | 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 属性
|
||||
-----------------------
|
||||
> <p id="tab_button_group_t_enable_hscroll_animator">是否开启 tab_button 的左右滚动动画(缺省TRUE)。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### scrollable 属性
|
||||
-----------------------
|
||||
> <p id="tab_button_group_t_scrollable">是否支持滚动(缺省FALSE)。
|
||||
|
||||
@ -18,6 +18,7 @@
|
||||
| <a href="#text_edit_t_text_edit_get_lines_of_each_row">text\_edit\_get\_lines\_of\_each\_row</a> | 获取每一个逻辑行(row)占几个物理行(line)。 |
|
||||
| <a href="#text_edit_t_text_edit_get_selected_text">text\_edit\_get\_selected\_text</a> | 获取选中文本。 |
|
||||
| <a href="#text_edit_t_text_edit_get_state">text\_edit\_get\_state</a> | 获取编辑器的状态。 |
|
||||
| <a href="#text_edit_t_text_edit_insert_text">text\_edit\_insert\_text</a> | 插入一段文本。 |
|
||||
| <a href="#text_edit_t_text_edit_invert_caret_visible">text\_edit\_invert\_caret\_visible</a> | 如果caret可见，将其设置为不可见。 如果caret不可见，将其设置为可见。 |
|
||||
| <a href="#text_edit_t_text_edit_key_down">text\_edit\_key\_down</a> | 处理按键事件。 |
|
||||
| <a href="#text_edit_t_text_edit_key_up">text\_edit\_key\_up</a> | 处理按键事件。 |
|
||||
@ -38,6 +39,7 @@
|
||||
| <a href="#text_edit_t_text_edit_set_max_rows">text\_edit\_set\_max\_rows</a> | 设置最大行数。 |
|
||||
| <a href="#text_edit_t_text_edit_set_offset">text\_edit\_set\_offset</a> | 设置滚动偏移。 |
|
||||
| <a href="#text_edit_t_text_edit_set_on_state_changed">text\_edit\_set\_on\_state\_changed</a> | 设置状态改变回调函数。 |
|
||||
| <a href="#text_edit_t_text_edit_set_overwrite">text\_edit\_set\_overwrite</a> | 设置是否覆盖行。 |
|
||||
| <a href="#text_edit_t_text_edit_set_select">text\_edit\_set\_select</a> | 选择指定范围的文本。 |
|
||||
| <a href="#text_edit_t_text_edit_set_tips">text\_edit\_set\_tips</a> | 设置提示信息。 |
|
||||
| <a href="#text_edit_t_text_edit_set_wrap_word">text\_edit\_set\_wrap\_word</a> | 设置是否自动折行。 |
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="text_edit_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="text_edit_t_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -54,6 +54,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L4
|
||||
| <a href="#text_selector_t_text_selector_get_value">text\_selector\_get\_value</a> | 获取text_selector的值。 |
|
||||
| <a href="#text_selector_t_text_selector_reset_options">text\_selector\_reset\_options</a> | 重置所有选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_animating_time">text\_selector\_set\_animating\_time</a> | 设置滚动动画播放时间。 |
|
||||
| <a href="#text_selector_t_text_selector_set_enable_value_animator">text\_selector\_set\_enable\_value\_animator</a> | 设置是否修改值时启用动画。 |
|
||||
| <a href="#text_selector_t_text_selector_set_localize_options">text\_selector\_set\_localize\_options</a> | 设置是否本地化(翻译)选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_loop_options">text\_selector\_set\_loop\_options</a> | 设置是否循环选项。 |
|
||||
| <a href="#text_selector_t_text_selector_set_options">text\_selector\_set\_options</a> | 设置选项。 |
|
||||
@ -70,6 +71,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L4
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#text_selector_t_animating_time">animating\_time</a> | uint32\_t | 滚动动画播放时间。(单位毫秒) |
|
||||
| <a href="#text_selector_t_enable_value_animator">enable\_value\_animator</a> | bool\_t | 是否修改值时启用动画。 |
|
||||
| <a href="#text_selector_t_localize_options">localize\_options</a> | bool\_t | 是否本地化(翻译)选项(缺省为FALSE)。 |
|
||||
| <a href="#text_selector_t_loop_options">loop\_options</a> | bool\_t | 是否循环选项(缺省为FALSE)。 |
|
||||
| <a href="#text_selector_t_options">options</a> | 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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="text_selector_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 属性
|
||||
-----------------------
|
||||
> <p id="text_selector_t_enable_value_animator">是否修改值时启用动画。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -30,6 +30,7 @@ value_set_int(&v, 100);
|
||||
| <a href="#value_t_value_equal">value\_equal</a> | 判断两个value是否相同。 |
|
||||
| <a href="#value_t_value_float">value\_float</a> | 获取类型为float\_t的值。 |
|
||||
| <a href="#value_t_value_float32">value\_float32</a> | 获取类型为float的值。 |
|
||||
| <a href="#value_t_value_gradient">value\_gradient</a> | 获取为gradient的值。 |
|
||||
| <a href="#value_t_value_int">value\_int</a> | 转换为int的值。 |
|
||||
| <a href="#value_t_value_int16">value\_int16</a> | 获取类型为int16的值。 |
|
||||
| <a href="#value_t_value_int32">value\_int32</a> | 获取类型为int32的值。 |
|
||||
@ -44,6 +45,7 @@ value_set_int(&v, 100);
|
||||
| <a href="#value_t_value_set_double">value\_set\_double</a> | 设置类型为double的值。 |
|
||||
| <a href="#value_t_value_set_float">value\_set\_float</a> | 设置类型为float\_t的值。 |
|
||||
| <a href="#value_t_value_set_float32">value\_set\_float32</a> | 设置类型为float的值。 |
|
||||
| <a href="#value_t_value_set_gradient">value\_set\_gradient</a> | 设置类型为gradient的值。 |
|
||||
| <a href="#value_t_value_set_int">value\_set\_int</a> | 设置类型为int的值。 |
|
||||
| <a href="#value_t_value_set_int16">value\_set\_int16</a> | 设置类型为int16的值。 |
|
||||
| <a href="#value_t_value_set_int32">value\_set\_int32</a> | 设置类型为int32的值。 |
|
||||
@ -346,6 +348,25 @@ float value_float32 (value_t* v);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | float | 值。 |
|
||||
| v | value\_t* | value对象。 |
|
||||
#### value\_gradient 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="value_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="value_t_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -27,3 +27,4 @@
|
||||
| VALUE\_TYPE\_BINARY | 二进制数据。 |
|
||||
| VALUE\_TYPE\_UBJSON | 二进制数据(UBJSON)。 |
|
||||
| VALUE\_TYPE\_TOKEN | 特殊用途。 |
|
||||
| VALUE\_TYPE\_GRADIENT | 渐变颜色。 |
|
||||
|
||||
@ -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坐标。 |
|
||||
|
||||
@ -7,15 +7,12 @@
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#vg_gradient_t_vg_gradient_add_stop">vg\_gradient\_add\_stop</a> | 增加关键点。 |
|
||||
| <a href="#vg_gradient_t_vg_gradient_create_linear">vg\_gradient\_create\_linear</a> | 创建线性渐变。 |
|
||||
| <a href="#vg_gradient_t_vg_gradient_create_radial">vg\_gradient\_create\_radial</a> | 创建放射渐变。 |
|
||||
| <a href="#vg_gradient_t_vg_gradient_destroy">vg\_gradient\_destroy</a> | 销毁gradient对象。 |
|
||||
| <a href="#vg_gradient_t_vg_gradient_get_first_color">vg\_gradient\_get\_first\_color</a> | 获取开始的颜色。 |
|
||||
| <a href="#vg_gradient_t_vg_gradient_get_last_color">vg\_gradient\_get\_last\_color</a> | 获取结束的颜色。 |
|
||||
| <a href="#vg_gradient_t_vg_gradient_get_stop">vg\_gradient\_get\_stop</a> | 获取关键点。 |
|
||||
| <a href="#vg_gradient_t_vg_gradient_init_linear">vg\_gradient\_init\_linear</a> | 初始化线性。 |
|
||||
| <a href="#vg_gradient_t_vg_gradient_init_radial">vg\_gradient\_init\_radial</a> | 初始化放射渐变。 |
|
||||
| <a href="#vg_gradient_t_vg_gradient_init_with_gradient">vg\_gradient\_init\_with\_gradient</a> | 初始化矢量画布的渐变对象。 |
|
||||
| <a href="#vg_gradient_t_vgcanvas_asset_manager">vgcanvas\_asset\_manager</a> | 获取缺省矢量画布资源管理器。 |
|
||||
| <a href="#vg_gradient_t_vgcanvas_asset_manager_add_font">vgcanvas\_asset\_manager\_add\_font</a> | 添加一个字库资源 |
|
||||
| <a href="#vg_gradient_t_vgcanvas_asset_manager_add_image">vgcanvas\_asset\_manager\_add\_image</a> | 添加一个贴图资源 |
|
||||
@ -34,29 +31,6 @@
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#vg_gradient_t_info">info</a> | vg\_gradient\_info\_t | 信息。 |
|
||||
| <a href="#vg_gradient_t_nr">nr</a> | uint32\_t | stop个数。 |
|
||||
| <a href="#vg_gradient_t_type">type</a> | vg\_gradient\_type\_t | 类型。 |
|
||||
#### vg\_gradient\_add\_stop 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vg_gradient_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vg_gradient_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vg_gradient_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vg_gradient_t_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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="vg_gradient_t_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 属性
|
||||
-----------------------
|
||||
> <p id="vg_gradient_t_nr">stop个数。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### type 属性
|
||||
-----------------------
|
||||
> <p id="vg_gradient_t_type">类型。
|
||||
|
||||
* 类型：vg\_gradient\_type\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
|
||||
@ -17,6 +17,7 @@
|
||||
| <a href="#widget_factory_t_widget_factory_create_widget">widget\_factory\_create\_widget</a> | 创建指定类型的控件。 |
|
||||
| <a href="#widget_factory_t_widget_factory_destroy">widget\_factory\_destroy</a> | 析构并释放控件工厂对象。 |
|
||||
| <a href="#widget_factory_t_widget_factory_register">widget\_factory\_register</a> | 注册控件创建函数。 |
|
||||
| <a href="#widget_factory_t_widget_factory_register_multi">widget\_factory\_register\_multi</a> | 注册控件创建函数。 |
|
||||
| <a href="#widget_factory_t_widget_factory_set">widget\_factory\_set</a> | 设置缺省的控件工厂对象。 |
|
||||
#### 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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_factory_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -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 | 自动换行。 |
|
||||
|
||||
@ -64,6 +64,7 @@ widget_on(button, EVT_CLICK, on_click, NULL);
|
||||
| <a href="#widget_t_widget_child_on">widget\_child\_on</a> | 为指定名称的子控件注册指定事件的处理函数。 |
|
||||
| <a href="#widget_t_widget_clone">widget\_clone</a> | clone。 |
|
||||
| <a href="#widget_t_widget_close_window">widget\_close\_window</a> | 关闭控件所在的窗口。 |
|
||||
| <a href="#widget_t_widget_close_window_force">widget\_close\_window\_force</a> | 关闭控件所在的窗口。 |
|
||||
| <a href="#widget_t_widget_count_children">widget\_count\_children</a> | 获取子控件的个数。 |
|
||||
| <a href="#widget_t_widget_create">widget\_create</a> | 创建控件。仅在子类控件构造函数中使用。 |
|
||||
| <a href="#widget_t_widget_create_animator">widget\_create\_animator</a> | 创建动画。 |
|
||||
@ -643,6 +644,25 @@ ret_t widget_close_window (widget_t* widget);
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | widget对象。 |
|
||||
#### widget\_close\_window\_force 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="widget_t_widget_close_window_force">关闭控件所在的窗口。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t widget_close_window_force (widget_t* widget);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
|
||||
@ -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 | 当前时间(毫秒)。 |
|
||||
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
@ -41,6 +41,7 @@ wstr_reset(&s);
|
||||
| <a href="#wstr_t_wstr_set">wstr\_set</a> | 设置字符串。 |
|
||||
| <a href="#wstr_t_wstr_set_utf8">wstr\_set\_utf8</a> | 设置UTF8字符串。 |
|
||||
| <a href="#wstr_t_wstr_set_utf8_with_len">wstr\_set\_utf8\_with\_len</a> | 设置UTF8字符串。 |
|
||||
| <a href="#wstr_t_wstr_set_with_len">wstr\_set\_with\_len</a> | 设置字符串。 |
|
||||
| <a href="#wstr_t_wstr_to_float">wstr\_to\_float</a> | 将字符串转成浮点数。 |
|
||||
| <a href="#wstr_t_wstr_to_int">wstr\_to\_int</a> | 将字符串转成整数。 |
|
||||
| <a href="#wstr_t_wstr_trim_float_zero">wstr\_trim\_float\_zero</a> | 去掉浮点数小数点尾部的零。 |
|
||||
@ -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 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wstr_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 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user