update docs

This commit is contained in:
xianjimli 2019-12-18 15:40:09 +08:00
parent fec8ef7c0f
commit 8fd2f13a6f
5 changed files with 120 additions and 8 deletions

View File

@ -69,6 +69,8 @@
| EVT\_WIDGET\_CREATED | 控件创建事件(event\_t)。 | | EVT\_WIDGET\_CREATED | 控件创建事件(event\_t)。 |
| EVT\_REQUEST\_QUIT\_APP | 请求退出应用程序事件。点击原生窗口关闭按钮时通过窗口管理器触发注册该事件并返回RET\_STOP可以阻止窗口关闭。 | | EVT\_REQUEST\_QUIT\_APP | 请求退出应用程序事件。点击原生窗口关闭按钮时通过窗口管理器触发注册该事件并返回RET\_STOP可以阻止窗口关闭。 |
| EVT\_THEME\_CHANGED | 主题变化(event\_t)。 | | EVT\_THEME\_CHANGED | 主题变化(event\_t)。 |
| EVT\_WIDGET\_ADD\_CHILD | 控件加载新的子控件(event\_t)。 |
| EVT\_WIDGET\_REMOVE\_CHILD | 控件移除子控件(event\_t)。 |
| EVT\_REQ\_START | event queue其它请求编号起始值。 | | EVT\_REQ\_START | event queue其它请求编号起始值。 |
| EVT\_USER\_START | 用户定义事件起始值。 | | EVT\_USER\_START | 用户定义事件起始值。 |
| EVT\_NONE | 无效事件名称。 | | EVT\_NONE | 无效事件名称。 |

View File

@ -11,6 +11,29 @@ tab\_button\_t是[widget\_t](widget_t.md)的子类控件widget\_t的函数均
在xml中使用"tab\_button"标签创建标签按钮控件。如: 在xml中使用"tab\_button"标签创建标签按钮控件。如:
```xml ```xml
<!-- tab_button_view_page1.xml -->
<view w="100%" h="100%">
<label x="c" y="m" w="100%" h="60" text="page1" />
<button name="close" x="c" y="bottom:100" w="80" h="40" text="Close" />
</view>
```
```xml
<!-- tab_button dynamic load UI -->
<pages name="pages" x="right" y="0" w="70%" h="100%">
</pages>
<list_view x="0" y="0" w="30%" h="100%" item_height="40" auto_hide_scroll_bar="true">
<scroll_view name="view" x="0" y="0" w="-12" h="100%">
<tab_button text="page1" load_ui="tab_button_view_page1" value="true"/>
<tab_button text="page2" load_ui="tab_button_view_page2" />
<tab_button text="page3" load_ui="tab_button_view_page3" />
<scroll_view />
<scroll_bar_d name="bar" x="right" y="0" w="12" h="100%" value="0"/>
</list_view>
```
```xml
<!-- tab_button static load UI -->
<tab_button_group x="c" y="bottom:10" w="90%" h="30" compact="true" > <tab_button_group x="c" y="bottom:10" w="90%" h="30" compact="true" >
<tab_button text="General"/> <tab_button text="General"/>
<tab_button text="Network" value="true" /> <tab_button text="Network" value="true" />
@ -45,6 +68,7 @@ tab\_button\_t是[widget\_t](widget_t.md)的子类控件widget\_t的函数均
| -------- | ------------ | | -------- | ------------ |
| <a href="#tab_button_t_tab_button_cast">tab\_button\_cast</a> | 转换tab_button对象(供脚本语言使用)。 | | <a href="#tab_button_t_tab_button_cast">tab\_button\_cast</a> | 转换tab_button对象(供脚本语言使用)。 |
| <a href="#tab_button_t_tab_button_create">tab\_button\_create</a> | 创建tab_button对象 | | <a href="#tab_button_t_tab_button_create">tab\_button\_create</a> | 创建tab_button对象 |
| <a href="#tab_button_t_tab_button_ex_set_load_ui">tab\_button\_ex\_set\_load\_ui</a> | 设置控件动态加载显示UI。 |
| <a href="#tab_button_t_tab_button_set_active_icon">tab\_button\_set\_active\_icon</a> | 设置控件的active图标。 | | <a href="#tab_button_t_tab_button_set_active_icon">tab\_button\_set\_active\_icon</a> | 设置控件的active图标。 |
| <a href="#tab_button_t_tab_button_set_icon">tab\_button\_set\_icon</a> | 设置控件的图标。 | | <a href="#tab_button_t_tab_button_set_icon">tab\_button\_set\_icon</a> | 设置控件的图标。 |
| <a href="#tab_button_t_tab_button_set_value">tab\_button\_set\_value</a> | 设置为当前标签。 | | <a href="#tab_button_t_tab_button_set_value">tab\_button\_set\_value</a> | 设置为当前标签。 |
@ -55,6 +79,7 @@ tab\_button\_t是[widget\_t](widget_t.md)的子类控件widget\_t的函数均
| -------- | ----- | ------------ | | -------- | ----- | ------------ |
| <a href="#tab_button_t_active_icon">active\_icon</a> | char* | 当前项的图标的名称。 | | <a href="#tab_button_t_active_icon">active\_icon</a> | char* | 当前项的图标的名称。 |
| <a href="#tab_button_t_icon">icon</a> | char* | 非当前项的图标的名称。 | | <a href="#tab_button_t_icon">icon</a> | char* | 非当前项的图标的名称。 |
| <a href="#tab_button_t_load_ui">load\_ui</a> | char* | 激活后加载的UI名字。 |
| <a href="#tab_button_t_value">value</a> | bool\_t | 值。 | | <a href="#tab_button_t_value">value</a> | bool\_t | 值。 |
### 事件 ### 事件
<p id="tab_button_t_events"> <p id="tab_button_t_events">
@ -105,6 +130,26 @@ widget_t* tab_button_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
| y | xy\_t | y坐标 | | y | xy\_t | y坐标 |
| w | wh\_t | 宽度 | | w | wh\_t | 宽度 |
| h | wh\_t | 高度 | | h | wh\_t | 高度 |
#### tab\_button\_ex\_set\_load\_ui 函数
-----------------------
* 函数功能:
> <p id="tab_button_t_tab_button_ex_set_load_ui">设置控件动态加载显示UI。
* 函数原型:
```
ret_t tab_button_ex_set_load_ui (widget_t* widget, char* name);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | tab\_button对象。 |
| name | char* | 动态加载UI的资源名称。 |
#### tab\_button\_set\_active\_icon 函数 #### tab\_button\_set\_active\_icon 函数
----------------------- -----------------------
@ -187,6 +232,22 @@ ret_t tab_button_set_value (widget_t* widget, uint32_t value);
* 类型char* * 类型char*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化 | 是 |
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### load\_ui 属性
-----------------------
> <p id="tab_button_t_load_ui">激活后加载的UI名字。
* 类型char*
| 特性 | 是否支持 | | 特性 | 是否支持 |
| -------- | ----- | | -------- | ----- |
| 可直接读取 | 是 | | 可直接读取 | 是 |

View File

@ -19,14 +19,14 @@ tk_utf8_from_utf16(wstr, res_str, ARRAY_SIZE(res_str));
| 函数名称 | 说明 | | 函数名称 | 说明 |
| -------- | ------------ | | -------- | ------------ |
| <a href="#tk_utf8_from_utf16">tk\_utf8\_from\_utf16</a> | 将wchar_t类型转换为char类型。 | | <a href="#utf8_t_tk_utf8_from_utf16">tk\_utf8\_from\_utf16</a> | 将wchar_t类型转换为char类型。 |
| <a href="#tk_utf8_to_utf16">tk\_utf8\_to\_utf16</a> | 将char类型转换为wchar_t类型。 | | <a href="#utf8_t_tk_utf8_to_utf16">tk\_utf8\_to\_utf16</a> | 将char类型转换为wchar_t类型。 |
#### utf8\_from\_utf16 函数 #### tk\_utf8\_from\_utf16 函数
----------------------- -----------------------
* 函数功能: * 函数功能:
> <p id="tk_utf8_from_utf16">将wchar_t类型转换为char类型。 > <p id="utf8_t_tk_utf8_from_utf16">将wchar_t类型转换为char类型。
* 函数原型: * 函数原型:
@ -42,12 +42,12 @@ char* tk_utf8_from_utf16 (const wchar_t* str, const char* out, uint32_t size);
| str | const wchar\_t* | str。 | | str | const wchar\_t* | str。 |
| out | const char* | 返回结果缓冲区。 | | out | const char* | 返回结果缓冲区。 |
| size | uint32\_t | 缓冲区大小。 | | size | uint32\_t | 缓冲区大小。 |
#### utf8\_from\_utf16 函数 #### tk\_utf8\_to\_utf16 函数
----------------------- -----------------------
* 函数功能: * 函数功能:
> <p id="tk_utf8_to_utf16">将char类型转换为wchar_t类型。 > <p id="utf8_t_tk_utf8_to_utf16">将char类型转换为wchar_t类型。
* 函数原型: * 函数原型:

View File

@ -110,6 +110,7 @@
| WIDGET\_PROP\_SELECTED | 是否被选中。 | | WIDGET\_PROP\_SELECTED | 是否被选中。 |
| WIDGET\_PROP\_CHECKED | 是否被勾选。 | | WIDGET\_PROP\_CHECKED | 是否被勾选。 |
| WIDGET\_PROP\_ACTIVE\_ICON | active状态下的图标。 | | WIDGET\_PROP\_ACTIVE\_ICON | active状态下的图标。 |
| WIDGET\_PROP\_LOAD\_UI | 动态加载UI名字。 |
| WIDGET\_PROP\_OPEN\_WINDOW | 要打开窗口的名称。 | | WIDGET\_PROP\_OPEN\_WINDOW | 要打开窗口的名称。 |
| WIDGET\_PROP\_SELECTED\_INDEX | 被选中项的索引。 | | WIDGET\_PROP\_SELECTED\_INDEX | 被选中项的索引。 |
| WIDGET\_PROP\_CLOSE\_WHEN\_CLICK | 点击窗口时关闭窗口。 | | WIDGET\_PROP\_CLOSE\_WHEN\_CLICK | 点击窗口时关闭窗口。 |

View File

@ -3907,6 +3907,14 @@
"desc": "主题变化(event_t)。", "desc": "主题变化(event_t)。",
"name": "EVT_THEME_CHANGED" "name": "EVT_THEME_CHANGED"
}, },
{
"desc": "控件加载新的子控件(event_t)。",
"name": "EVT_WIDGET_ADD_CHILD"
},
{
"desc": "控件移除子控件(event_t)。",
"name": "EVT_WIDGET_REMOVE_CHILD"
},
{ {
"desc": "event queue其它请求编号起始值。", "desc": "event queue其它请求编号起始值。",
"name": "EVT_REQ_START" "name": "EVT_REQ_START"
@ -15523,6 +15531,10 @@
"desc": "active状态下的图标。", "desc": "active状态下的图标。",
"name": "WIDGET_PROP_ACTIVE_ICON" "name": "WIDGET_PROP_ACTIVE_ICON"
}, },
{
"desc": "动态加载UI名字。",
"name": "WIDGET_PROP_LOAD_UI"
},
{ {
"desc": "要打开窗口的名称。", "desc": "要打开窗口的名称。",
"name": "WIDGET_PROP_OPEN_WINDOW" "name": "WIDGET_PROP_OPEN_WINDOW"
@ -16040,7 +16052,7 @@
], ],
"annotation": {}, "annotation": {},
"desc": "将char类型转换为wchar_t类型。", "desc": "将char类型转换为wchar_t类型。",
"name": "tk_utf8_from_utf16", "name": "tk_utf8_to_utf16",
"return": { "return": {
"type": "wchar_t*", "type": "wchar_t*",
"desc": "值。" "desc": "值。"
@ -43260,6 +43272,29 @@
"type": "ret_t", "type": "ret_t",
"desc": "返回RET_OK表示成功否则表示失败。" "desc": "返回RET_OK表示成功否则表示失败。"
} }
},
{
"params": [
{
"type": "widget_t*",
"name": "widget",
"desc": "tab_button对象。"
},
{
"type": "char*",
"name": "name",
"desc": "动态加载UI的资源名称。"
}
],
"annotation": {
"scriptable": true
},
"desc": "设置控件动态加载显示UI。",
"name": "tab_button_ex_set_load_ui",
"return": {
"type": "ret_t",
"desc": "返回RET_OK表示成功否则表示失败。"
}
} }
], ],
"events": [ "events": [
@ -43288,6 +43323,19 @@
"scriptable": true "scriptable": true
} }
}, },
{
"name": "load_ui",
"desc": "激活后加载的UI名字。",
"type": "char*",
"annotation": {
"set_prop": true,
"get_prop": true,
"readable": true,
"persitent": true,
"design": true,
"scriptable": true
}
},
{ {
"name": "active_icon", "name": "active_icon",
"desc": "当前项的图标的名称。", "desc": "当前项的图标的名称。",
@ -43316,7 +43364,7 @@
} }
], ],
"header": "widgets/tab_button.h", "header": "widgets/tab_button.h",
"desc": "标签按钮控件。\n\n标签按钮有点类似单选按钮但点击标签按钮之后会自动切换当前的标签页。\n\ntab\\_button\\_t是[widget\\_t](widget_t.md)的子类控件widget\\_t的函数均适用于tab\\_button\\_t控件。\n\n在xml中使用\"tab\\_button\"标签创建标签按钮控件。如:\n\n```xml\n<tab_button_group x=\"c\" y=\"bottom:10\" w=\"90%\" h=\"30\" compact=\"true\" >\n<tab_button text=\"General\"/>\n<tab_button text=\"Network\" value=\"true\" />\n<tab_button text=\"Security\"/>\n</tab_button_group>\n```\n\n标签按钮一般放在标签按钮分组中布局由标签按钮分组控件决定不需要指定自己的布局参数和坐标。\n\n> 更多用法请参考:\n[tab control](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/ui/)\n\n可用通过style来设置控件的显示风格如字体的大小和颜色等等。如\n\n```xml\n<tab_button>\n<style name=\"default\" border_color=\"#a0a0a0\" text_color=\"black\">\n<normal bg_color=\"#d0d0d0\" />\n<pressed bg_color=\"#f0f0f0\" />\n<over bg_color=\"#e0e0e0\" />\n<normal_of_active bg_color=\"#f0f0f0\" />\n<pressed_of_active bg_color=\"#f0f0f0\" />\n<over_of_active bg_color=\"#f0f0f0\" />\n</style>\n</tab_button>\n```", "desc": "标签按钮控件。\n\n标签按钮有点类似单选按钮但点击标签按钮之后会自动切换当前的标签页。\n\ntab\\_button\\_t是[widget\\_t](widget_t.md)的子类控件widget\\_t的函数均适用于tab\\_button\\_t控件。\n\n在xml中使用\"tab\\_button\"标签创建标签按钮控件。如:\n\n```xml\n<!-- tab_button_view_page1.xml -->\n<view w=\"100%\" h=\"100%\">\n<label x=\"c\" y=\"m\" w=\"100%\" h=\"60\" text=\"page1\" />\n<button name=\"close\" x=\"c\" y=\"bottom:100\" w=\"80\" h=\"40\" text=\"Close\" />\n</view>\n```\n\n```xml\n<!-- tab_button dynamic load UI -->\n<pages name=\"pages\" x=\"right\" y=\"0\" w=\"70%\" h=\"100%\">\n</pages>\n<list_view x=\"0\" y=\"0\" w=\"30%\" h=\"100%\" item_height=\"40\" auto_hide_scroll_bar=\"true\">\n<scroll_view name=\"view\" x=\"0\" y=\"0\" w=\"-12\" h=\"100%\">\n<tab_button text=\"page1\" load_ui=\"tab_button_view_page1\" value=\"true\"/>\n<tab_button text=\"page2\" load_ui=\"tab_button_view_page2\" />\n<tab_button text=\"page3\" load_ui=\"tab_button_view_page3\" />\n<scroll_view />\n<scroll_bar_d name=\"bar\" x=\"right\" y=\"0\" w=\"12\" h=\"100%\" value=\"0\"/>\n</list_view>\n```\n\n```xml\n<!-- tab_button static load UI -->\n<tab_button_group x=\"c\" y=\"bottom:10\" w=\"90%\" h=\"30\" compact=\"true\" >\n<tab_button text=\"General\"/>\n<tab_button text=\"Network\" value=\"true\" />\n<tab_button text=\"Security\"/>\n</tab_button_group>\n```\n\n标签按钮一般放在标签按钮分组中布局由标签按钮分组控件决定不需要指定自己的布局参数和坐标。\n\n> 更多用法请参考:\n[tab control](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/ui/)\n\n可用通过style来设置控件的显示风格如字体的大小和颜色等等。如\n\n```xml\n<tab_button>\n<style name=\"default\" border_color=\"#a0a0a0\" text_color=\"black\">\n<normal bg_color=\"#d0d0d0\" />\n<pressed bg_color=\"#f0f0f0\" />\n<over bg_color=\"#e0e0e0\" />\n<normal_of_active bg_color=\"#f0f0f0\" />\n<pressed_of_active bg_color=\"#f0f0f0\" />\n<over_of_active bg_color=\"#f0f0f0\" />\n</style>\n</tab_button>\n```",
"name": "tab_button_t", "name": "tab_button_t",
"parent": "widget_t", "parent": "widget_t",
"annotation": { "annotation": {