update docs

2024-11-30 02:58:26 +08:00 · 2019-05-07 14:37:26 +08:00 · 2019-05-07 14:37:26 +08:00 · 3908489aae
commit 3908489aae
parent 0117c69a82
9 changed files with 265 additions and 95 deletions
--- a/docs/manual/_children_layouter_default_t.md
+++ b/docs/manual/_children_layouter_default_t.md
@ -1,42 +0,0 @@
-## \_children\_layouter\_default\_t
-### 概述
-![image](images/_children_layouter_default_t_0.png)
-
-
- 缺省的子控件布局算法实现。
-
-> 用法请参考：[缺省子控件布局算法](
-https://github.com/zlgopen/awtk/blob/master/docs/children_layouter_default.md)
-
-
-
----------------------------------
-### 函数
-<p id="_children_layouter_default_t_methods">
-
-| 函数名称 | 说明 | 
-| -------- | ------------ | 
-| <a href="#_children_layouter_default_t_children_layouter_default_create">children\_layouter\_default\_create</a> |  |
-#### children\_layouter\_default\_create 函数
-----------------------
-
-* 函数功能：
-
-> <p id="_children_layouter_default_t_children_layouter_default_create">
- 创建子控件布局对象。
-
-
-
-
-
-* 函数原型：
-
-```
-children_layouter_t* children_layouter_default_create ();
-```
-
-* 参数说明：
-
-| 参数 | 类型 | 说明 |
-| -------- | ----- | --------- |
-| 返回值 | children\_layouter\_t* | 返回创建子控件布局对象。 |
--- a/docs/manual/bitmap_t.md
+++ b/docs/manual/bitmap_t.md
@ -28,7 +28,7 @@
 | <a href="#bitmap_t_format">format</a> | uint16\_t | 格式。请参考{bitmap_format_t}。 |
 | <a href="#bitmap_t_h">h</a> | wh\_t | 高度。 |
 | <a href="#bitmap_t_line_length">line\_length</a> | uint32\_t | 每一行实际占用的内存(也称为stride或pitch)，一般情况下为w*bpp。 |
-| <a href="#bitmap_t_name">name</a> | char* | 名称。 |
+| <a href="#bitmap_t_name">name</a> | const char* | 名称。 |
 | <a href="#bitmap_t_w">w</a> | wh\_t | 宽度。 |
 #### bitmap\_create 函数
 -----------------------
@ -312,7 +312,7 @@ ret_t bitmap_set_line_length (bitmap_t* bitmap, uint32_t line_length);



-* 类型：char*
+* 类型：const char*

 | 特性 | 是否支持 |
 | -------- | ----- |
--- a/docs/manual/global_t.md
+++ b/docs/manual/global_t.md
@ -0,0 +1,105 @@
+## global\_t
+### 概述
+ TK全局对象。
+
+
+----------------------------------
+### 函数
+<p id="global_t_methods">
+
+| 函数名称 | 说明 | 
+| -------- | ------------ | 
+| <a href="#global_t_tk_init">tk\_init</a> | 初始化TK。 |
+| <a href="#global_t_tk_quit">tk\_quit</a> | 退出TK事件主循环。 |
+| <a href="#global_t_tk_run">tk\_run</a> | 进入TK事件主循环。 |
+| <a href="#global_t_tk_set_lcd_orientation">tk\_set\_lcd\_orientation</a> | 设置屏幕的旋转方向(XXX:目前仅支持0度和90度)。 |
+#### tk\_init 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="global_t_tk_init"> 初始化TK。
+
+
+
+
+* 函数原型：
+
+```
+ret_t tk_init (wh_t w, wh_t h, app_type_t app_type, const char* app_name, const char* app_root);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| w | wh\_t | LCD宽度。 |
+| h | wh\_t | LCD高度。 |
+| app\_type | app\_type\_t | 应用程序的类型。 |
+| app\_name | const char* | 应用程序的名称(必须为常量字符串)。 |
+| app\_root | const char* | 应用程序的根目录，用于定位资源文件(必须为常量字符串)。 |
+#### tk\_quit 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="global_t_tk_quit"> 退出TK事件主循环。
+
+
+
+
+* 函数原型：
+
+```
+ret_t tk_quit ();
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+#### tk\_run 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="global_t_tk_run"> 进入TK事件主循环。
+
+
+
+
+* 函数原型：
+
+```
+ret_t tk_run ();
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+#### tk\_set\_lcd\_orientation 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="global_t_tk_set_lcd_orientation"> 设置屏幕的旋转方向(XXX:目前仅支持0度和90度)。
+
+
+
+
+* 函数原型：
+
+```
+ret_t tk_set_lcd_orientation (int orientation);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| orientation | int | 旋转方向。 |
--- a/docs/manual/image_base_t.md
+++ b/docs/manual/image_base_t.md
@ -19,13 +19,13 @@
 | 函数名称 | 说明 | 
 | -------- | ------------ | 
 | <a href="#image_base_t_image_base_cast">image\_base\_cast</a> | 转换为image_base对象(供脚本语言使用)。 |
-| <a href="#image_base_t_image_set_anchor">image\_set\_anchor</a> | 设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。 |
-| <a href="#image_base_t_image_set_clickable">image\_set\_clickable</a> | 设置控件是否可以被点击。 |
-| <a href="#image_base_t_image_set_image">image\_set\_image</a> | 设置控件的图片名称。 |
-| <a href="#image_base_t_image_set_rotation">image\_set\_rotation</a> | 设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。 |
-| <a href="#image_base_t_image_set_scale">image\_set\_scale</a> | 设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。 |
-| <a href="#image_base_t_image_set_selectable">image\_set\_selectable</a> | 设置控件是否可以被选中。 |
-| <a href="#image_base_t_image_set_selected">image\_set\_selected</a> | 设置控件的选中状态。 |
+| <a href="#image_base_t_image_base_set_anchor">image\_base\_set\_anchor</a> | 设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。 |
+| <a href="#image_base_t_image_base_set_clickable">image\_base\_set\_clickable</a> | 设置控件是否可以被点击。 |
+| <a href="#image_base_t_image_base_set_image">image\_base\_set\_image</a> | 设置控件的图片名称。 |
+| <a href="#image_base_t_image_base_set_rotation">image\_base\_set\_rotation</a> | 设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。 |
+| <a href="#image_base_t_image_base_set_scale">image\_base\_set\_scale</a> | 设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。 |
+| <a href="#image_base_t_image_base_set_selectable">image\_base\_set\_selectable</a> | 设置控件是否可以被选中。 |
+| <a href="#image_base_t_image_base_set_selected">image\_base\_set\_selected</a> | 设置控件的选中状态。 |
 ### 属性
 <p id="image_base_t_properties">

@ -61,19 +61,19 @@ widget_t* image_base_cast (widget_t* widget);
 | -------- | ----- | --------- |
 | 返回值 | widget\_t* | image\_base对象。 |
 | widget | widget\_t* | image\_base对象。 |
-#### image\_set\_anchor 函数
+#### image\_base\_set\_anchor 函数
 -----------------------

 * 函数功能：

-> <p id="image_base_t_image_set_anchor"> 设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。
+> <p id="image_base_t_image_base_set_anchor"> 设置控件的锚点(仅在WITH_VGCANVAS定义时生效)。



 * 函数原型：

 ```
-ret_t image_set_anchor (widget_t* widget, float_t anchor_x, float_t anchor_y);
+ret_t image_base_set_anchor (widget_t* widget, float_t anchor_x, float_t anchor_y);
 ```

 * 参数说明：
@ -84,19 +84,19 @@ ret_t image_set_anchor (widget_t* widget, float_t anchor_x, float_t anchor_y);
 | widget | widget\_t* | 控件对象。 |
 | anchor\_x | float\_t | 锚点X(0-1)。0在控件左边，0.5在控件中间，1在控件右边。 |
 | anchor\_y | float\_t | 锚点Y(0-1)。0在控件顶部，0.5在控件中间，1在控件底部。 |
-#### image\_set\_clickable 函数
+#### image\_base\_set\_clickable 函数
 -----------------------

 * 函数功能：

-> <p id="image_base_t_image_set_clickable"> 设置控件是否可以被点击。
+> <p id="image_base_t_image_base_set_clickable"> 设置控件是否可以被点击。



 * 函数原型：

 ```
-ret_t image_set_clickable (widget_t* widget, bool_t clickable);
+ret_t image_base_set_clickable (widget_t* widget, bool_t clickable);
 ```

 * 参数说明：
@ -106,19 +106,19 @@ ret_t image_set_clickable (widget_t* widget, bool_t clickable);
 | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
 | widget | widget\_t* | 控件对象。 |
 | clickable | bool\_t | 是否可以被点击。 |
-#### image\_set\_image 函数
+#### image\_base\_set\_image 函数
 -----------------------

 * 函数功能：

-> <p id="image_base_t_image_set_image"> 设置控件的图片名称。
+> <p id="image_base_t_image_base_set_image"> 设置控件的图片名称。



 * 函数原型：

 ```
-ret_t image_set_image (widget_t* widget, char* name);
+ret_t image_base_set_image (widget_t* widget, char* name);
 ```

 * 参数说明：
@ -128,19 +128,19 @@ ret_t image_set_image (widget_t* widget, char* name);
 | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
 | widget | widget\_t* | image对象。 |
 | name | char* | 图片名称，该图片必须存在于资源管理器。 |
-#### image\_set\_rotation 函数
+#### image\_base\_set\_rotation 函数
 -----------------------

 * 函数功能：

-> <p id="image_base_t_image_set_rotation"> 设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。
+> <p id="image_base_t_image_base_set_rotation"> 设置控件的旋转角度(仅在WITH_VGCANVAS定义时生效)。



 * 函数原型：

 ```
-ret_t image_set_rotation (widget_t* widget, float_t rotation);
+ret_t image_base_set_rotation (widget_t* widget, float_t rotation);
 ```

 * 参数说明：
@ -150,19 +150,19 @@ ret_t image_set_rotation (widget_t* widget, float_t rotation);
 | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
 | widget | widget\_t* | 控件对象。 |
 | rotation | float\_t | 旋转角度(幅度)。 |
-#### image\_set\_scale 函数
+#### image\_base\_set\_scale 函数
 -----------------------

 * 函数功能：

-> <p id="image_base_t_image_set_scale"> 设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。
+> <p id="image_base_t_image_base_set_scale"> 设置控件的缩放比例(仅在WITH_VGCANVAS定义时生效)。



 * 函数原型：

 ```
-ret_t image_set_scale (widget_t* widget, float_t scale_x, float_t scale_y);
+ret_t image_base_set_scale (widget_t* widget, float_t scale_x, float_t scale_y);
 ```

 * 参数说明：
@ -173,19 +173,19 @@ ret_t image_set_scale (widget_t* widget, float_t scale_x, float_t scale_y);
 | widget | widget\_t* | 控件对象。 |
 | scale\_x | float\_t | X方向缩放比例。 |
 | scale\_y | float\_t | Y方向缩放比例。 |
-#### image\_set\_selectable 函数
+#### image\_base\_set\_selectable 函数
 -----------------------

 * 函数功能：

-> <p id="image_base_t_image_set_selectable"> 设置控件是否可以被选中。
+> <p id="image_base_t_image_base_set_selectable"> 设置控件是否可以被选中。



 * 函数原型：

 ```
-ret_t image_set_selectable (widget_t* widget, bool_t selectable);
+ret_t image_base_set_selectable (widget_t* widget, bool_t selectable);
 ```

 * 参数说明：
@ -195,19 +195,19 @@ ret_t image_set_selectable (widget_t* widget, bool_t selectable);
 | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
 | widget | widget\_t* | 控件对象。 |
 | selectable | bool\_t | 是否可以被选中。 |
-#### image\_set\_selected 函数
+#### image\_base\_set\_selected 函数
 -----------------------

 * 函数功能：

-> <p id="image_base_t_image_set_selected"> 设置控件的选中状态。
+> <p id="image_base_t_image_base_set_selected"> 设置控件的选中状态。



 * 函数原型：

 ```
-ret_t image_set_selected (widget_t* widget, bool_t selected);
+ret_t image_base_set_selected (widget_t* widget, bool_t selected);
 ```

 * 参数说明：
--- a/docs/manual/prop_change_event_t.md
+++ b/docs/manual/prop_change_event_t.md
@ -17,8 +17,8 @@

 | 属性名称 | 类型 | 说明 | 
 | -------- | ----- | ------------ | 
-| <a href="#prop_change_event_t_name">name</a> | char* | 属性的名称。 |
-| <a href="#prop_change_event_t_value">value</a> | value\_t* | 属性的值。 |
+| <a href="#prop_change_event_t_name">name</a> | const char* | 属性的名称。 |
+| <a href="#prop_change_event_t_value">value</a> | const value\_t* | 属性的值。 |
 #### prop\_change\_event\_cast 函数
 -----------------------

@ -47,7 +47,7 @@ prop_change_event_t* prop_change_event_cast (event_t* event);



-* 类型：char*
+* 类型：const char*

 | 特性 | 是否支持 |
 | -------- | ----- |
@ -60,7 +60,7 @@ prop_change_event_t* prop_change_event_cast (event_t* event);



-* 类型：value\_t*
+* 类型：const value\_t*

 | 特性 | 是否支持 |
 | -------- | ----- |
--- a/docs/manual/tk_thread_t.md
+++ b/docs/manual/tk_thread_t.md
@ -0,0 +1,102 @@
+## tk\_thread\_t
+### 概述
+ 线程对象。
+
+
+----------------------------------
+### 函数
+<p id="tk_thread_t_methods">
+
+| 函数名称 | 说明 | 
+| -------- | ------------ | 
+| <a href="#tk_thread_t_tk_thread_create">tk\_thread\_create</a> | 创建thread对象。 |
+| <a href="#tk_thread_t_tk_thread_destroy">tk\_thread\_destroy</a> | 销毁thread对象。 |
+| <a href="#tk_thread_t_tk_thread_join">tk\_thread\_join</a> | 等待线程退出。 |
+| <a href="#tk_thread_t_tk_thread_start">tk\_thread\_start</a> | 启动线程。 |
+#### tk\_thread\_create 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="tk_thread_t_tk_thread_create"> 创建thread对象。
+
+
+
+
+* 函数原型：
+
+```
+tk_thread_t* tk_thread_create ();
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | tk\_thread\_t* | thread对象。 |
+#### tk\_thread\_destroy 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="tk_thread_t_tk_thread_destroy"> 销毁thread对象。
+
+
+
+
+* 函数原型：
+
+```
+ret_t tk_thread_destroy (tk_thread_t* thread);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| thread | tk\_thread\_t* | thread对象。 |
+#### tk\_thread\_join 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="tk_thread_t_tk_thread_join"> 等待线程退出。
+
+
+
+
+* 函数原型：
+
+```
+ret_t tk_thread_join (tk_thread_t* thread);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| thread | tk\_thread\_t* | thread对象。 |
+#### tk\_thread\_start 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="tk_thread_t_tk_thread_start"> 启动线程。
+
+
+
+
+* 函数原型：
+
+```
+ret_t tk_thread_start (tk_thread_t* thread);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| thread | tk\_thread\_t* | thread对象。 |
--- a/docs/manual/vgcanvas_t.md
+++ b/docs/manual/vgcanvas_t.md
@ -102,18 +102,18 @@
 | -------- | ----- | ------------ | 
 | <a href="#vgcanvas_t_anti_alias">anti\_alias</a> | bool\_t | 是否启用反走样功能。 |
 | <a href="#vgcanvas_t_fill_color">fill\_color</a> | color\_t | 填充颜色 |
-| <a href="#vgcanvas_t_font">font</a> | char* | 字体。 |
+| <a href="#vgcanvas_t_font">font</a> | const char* | 字体。 |
 | <a href="#vgcanvas_t_font_size">font\_size</a> | float\_t | 字体大小。 |
 | <a href="#vgcanvas_t_global_alpha">global\_alpha</a> | float\_t | 全局alpha。 |
 | <a href="#vgcanvas_t_h">h</a> | wh\_t | canvas的高度 |
-| <a href="#vgcanvas_t_line_cap">line\_cap</a> | char* | line\_cap。 |
-| <a href="#vgcanvas_t_line_join">line\_join</a> | char* | line\_join。 |
+| <a href="#vgcanvas_t_line_cap">line\_cap</a> | const char* | line\_cap。 |
+| <a href="#vgcanvas_t_line_join">line\_join</a> | const char* | line\_join。 |
 | <a href="#vgcanvas_t_line_width">line\_width</a> | float\_t | 线宽。 |
 | <a href="#vgcanvas_t_miter_limit">miter\_limit</a> | float\_t | miter\_limit。 |
 | <a href="#vgcanvas_t_ratio">ratio</a> | float\_t | 显示比例。 |
 | <a href="#vgcanvas_t_stroke_color">stroke\_color</a> | color\_t | 线条颜色 |
-| <a href="#vgcanvas_t_text_align">text\_align</a> | char* | 文本对齐方式。 |
-| <a href="#vgcanvas_t_text_baseline">text\_baseline</a> | char* | 文本基线。 |
+| <a href="#vgcanvas_t_text_align">text\_align</a> | const char* | 文本对齐方式。 |
+| <a href="#vgcanvas_t_text_baseline">text\_baseline</a> | const char* | 文本基线。 |
 | <a href="#vgcanvas_t_w">w</a> | wh\_t | canvas的宽度 |
 #### vgcanvas\_arc 函数
 -----------------------
@ -1532,7 +1532,7 @@ ret_t vgcanvas_translate (vgcanvas_t* vg, float_t x, float_t y);



-* 类型：char*
+* 类型：const char*

 | 特性 | 是否支持 |
 | -------- | ----- |
@ -1585,7 +1585,7 @@ ret_t vgcanvas_translate (vgcanvas_t* vg, float_t x, float_t y);



-* 类型：char*
+* 类型：const char*

 | 特性 | 是否支持 |
 | -------- | ----- |
@ -1599,7 +1599,7 @@ ret_t vgcanvas_translate (vgcanvas_t* vg, float_t x, float_t y);



-* 类型：char*
+* 类型：const char*

 | 特性 | 是否支持 |
 | -------- | ----- |
@ -1666,7 +1666,7 @@ ret_t vgcanvas_translate (vgcanvas_t* vg, float_t x, float_t y);



-* 类型：char*
+* 类型：const char*

 | 特性 | 是否支持 |
 | -------- | ----- |
@ -1681,7 +1681,7 @@ ret_t vgcanvas_translate (vgcanvas_t* vg, float_t x, float_t y);



-* 类型：char*
+* 类型：const char*

 | 特性 | 是否支持 |
 | -------- | ----- |
--- a/docs/manual/widget_state_t.md
+++ b/docs/manual/widget_state_t.md
@ -18,6 +18,7 @@
 | WIDGET\_STATE\_CHECKED | 勾选状态。 |
 | WIDGET\_STATE\_UNCHECKED | 没勾选状态。 |
 | WIDGET\_STATE\_EMPTY | 编辑器无内容状态。 |
+| WIDGET\_STATE\_EMPTY\_FOCUS | 编辑器无内容同时聚焦的状态。 |
 | WIDGET\_STATE\_ERROR | 输入错误状态。 |
 | WIDGET\_STATE\_SELECTED | 选中状态。 |
 | WIDGET\_STATE\_NORMAL\_OF\_CHECKED | 正常状态(选中项)。 |
--- a/tools/idl_gen/idl.json
+++ b/tools/idl_gen/idl.json
@ -10637,6 +10637,10 @@
        "desc": " 编辑器无内容状态。\n\n",
        "name": "WIDGET_STATE_EMPTY"
      },
+      {
+        "desc": " 编辑器无内容同时聚焦的状态。\n\n",
+        "name": "WIDGET_STATE_EMPTY_FOCUS"
+      },
      {
        "desc": " 输入错误状态。\n\n",
        "name": "WIDGET_STATE_ERROR"
@ -18011,23 +18015,23 @@
        "params": [],
        "annotation": {},
        "desc": " 创建thread对象。\n\n\n",
-        "name": "thread_create",
+        "name": "tk_thread_create",
        "return": {
-          "type": "thread_t*",
+          "type": "tk_thread_t*",
          "desc": "thread对象。"
        }
      },
      {
        "params": [
          {
-            "type": "thread_t*",
+            "type": "tk_thread_t*",
            "name": "thread",
            "desc": "thread对象。"
          }
        ],
        "annotation": {},
        "desc": " 启动线程。\n\n\n",
-        "name": "thread_start",
+        "name": "tk_thread_start",
        "return": {
          "type": "ret_t",
          "desc": "返回RET_OK表示成功，否则表示失败。"
@ -18036,14 +18040,14 @@
      {
        "params": [
          {
-            "type": "thread_t*",
+            "type": "tk_thread_t*",
            "name": "thread",
            "desc": "thread对象。"
          }
        ],
        "annotation": {},
        "desc": " 等待线程退出。\n\n\n",
-        "name": "thread_join",
+        "name": "tk_thread_join",
        "return": {
          "type": "ret_t",
          "desc": "返回RET_OK表示成功，否则表示失败。"
@ -18052,14 +18056,14 @@
      {
        "params": [
          {
-            "type": "thread_t*",
+            "type": "tk_thread_t*",
            "name": "thread",
            "desc": "thread对象。"
          }
        ],
        "annotation": {},
        "desc": " 销毁thread对象。\n\n\n",
-        "name": "thread_destroy",
+        "name": "tk_thread_destroy",
        "return": {
          "type": "ret_t",
          "desc": "返回RET_OK表示成功，否则表示失败。"
@ -18070,7 +18074,7 @@
    "properties": [],
    "header": "tkc/thread.h",
    "desc": " 线程对象。\n\n",
-    "name": "thread_t",
+    "name": "tk_thread_t",
    "level": 1
  },
  {