mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-11-30 02:58:26 +08:00
update docs
This commit is contained in:
lixianjing
parent
2dcba49eab
commit
de6d32ca96
@ -6,7 +6,8 @@
|
||||
* 入选码云最有价值开源项目，根据要求修改 READMEM 中的链接。
|
||||
* 增加文档 [如何在主题文件中写控件布局参数](how_to_write_layout_params_in_style.md)
|
||||
* 完善窗口切换的处理，窗口切换到前台时，重新设置原来的焦点控件为焦点。
|
||||
|
||||
* combobox 支持 hscroll label 作为子控。
|
||||
|
||||
> 主题数据格式变化，请使用资源生成脚本，重新生成资源数据！！！
|
||||
|
||||
* 2019/12/10
|
||||
|
||||
@ -28,8 +28,21 @@ language.xml:
|
||||
</list_view>
|
||||
</popup>
|
||||
```
|
||||
>
|
||||
更多用法请参考：[combo_box.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/ui/combo_box.xml)
|
||||
> 更多用法请参考：[combo_box.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/ui/combo_box.xml)
|
||||
如果在文本比较长时，希望在获得焦点时文本自动滚动，可以放入一个hscroll_label为子控件，并命名为"value"。如：
|
||||
```xml
|
||||
<combo_box left_margin="6" readonly="true" x="10" y="50" w="80" h="30" options="leftttttttttt;centerrrrrrrrrrrrrrrr;rightttttttttt;"
|
||||
selected_index="1">
|
||||
<hscroll_label x="0" y="0" w="-30" h="100%"
|
||||
name="value"
|
||||
lull="1000"
|
||||
loop="true"
|
||||
yoyo="true"
|
||||
ellipses="true"
|
||||
only_parent_focus="true"/>
|
||||
<button style="combobox_down" x="right:5" y="middle" w="20" h="20"/>
|
||||
</combo_box>
|
||||
```
|
||||
在c代码中使用函数combo\_box\_create创建下拉列表控件。如：
|
||||
```c
|
||||
widget_t* combo_box = combo_box_create(win, 10, 10, 128, 30);
|
||||
|
||||
@ -47,6 +47,7 @@
|
||||
| EVT\_ANIM\_ONCE | 控件动画yoyo/repeat时，完成一次的事件(event\_t)。 |
|
||||
| EVT\_ANIM\_END | 控件动画完成事件(event\_t)。 |
|
||||
| EVT\_WINDOW\_LOAD | 窗口加载完成事件(event\_t)。 |
|
||||
| EVT\_WIDGET\_LOAD | 控件加载完成事件(event\_t)。 |
|
||||
| EVT\_WINDOW\_WILL\_OPEN | 窗口即将打开事件(event\_t)。如果有窗口动画，在窗口动画开始前触发。如果没有窗口动画，在窗口被加载后的下一次循环中触发。 |
|
||||
| EVT\_WINDOW\_OPEN | 窗口打开事件(event\_t)。如果有窗口动画，在窗口动画完成时触发。如果没有窗口动画，在窗口被加载后的下一次循环中触发。 |
|
||||
| EVT\_WINDOW\_TO\_BACKGROUND | 窗口被切换到后台事件(event\_t)。打开新窗口时，当前窗口被切换到后台时，对当前窗口触发本事件。 |
|
||||
|
||||
@ -16,3 +16,4 @@
|
||||
| INPUT\_PASSWORD | 密码。 |
|
||||
| INPUT\_PHONE | 电话号码。 |
|
||||
| INPUT\_CUSTOM | 使用自定义的软键盘(如计算器等应用不希望弹出系统软键盘)。 |
|
||||
| INPUT\_CUSTOM\_PASSWORD | 使用自定义的密码软键盘。 |
|
||||
|
||||
@ -38,3 +38,5 @@ style常量定义。
|
||||
| STYLE\_ID\_SELECTED\_FG\_COLOR | 编辑器中选中区域的前景颜色。 |
|
||||
| STYLE\_ID\_SELECTED\_TEXT\_COLOR | 编辑器中选中区域的文本颜色。 |
|
||||
| STYLE\_ID\_ROUND\_RADIUS | 圆角半径(仅在WITH\_VGCANVAS定义时生效)。 |
|
||||
| STYLE\_ID\_CHILDREN\_LAYOUT | 子控件布局参数。 |
|
||||
| STYLE\_ID\_SELF\_LAYOUT | 控件布局参数。 |
|
||||
|
||||
@ -100,6 +100,7 @@ vgcanvas_restore(vg);
|
||||
| <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_stride">stride</a> | uint32\_t | 一行占的字节 |
|
||||
| <a href="#vgcanvas_t_stroke_color">stroke\_color</a> | color\_t | 线条颜色 |
|
||||
| <a href="#vgcanvas_t_text_align">text\_align</a> | const char* | 文本对齐方式。 |
|
||||
| <a href="#vgcanvas_t_text_baseline">text\_baseline</a> | const char* | 文本基线。 |
|
||||
@ -1497,6 +1498,18 @@ ret_t vgcanvas_translate (vgcanvas_t* vg, float_t x, float_t y);
|
||||
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
#### stride 属性
|
||||
-----------------------
|
||||
> <p id="vgcanvas_t_stride">一行占的字节
|
||||
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -156,6 +156,7 @@ widget_on(button, EVT_CLICK, on_click, NULL);
|
||||
| <a href="#widget_t_focused">focused</a> | bool\_t | 是否得到焦点。 |
|
||||
| <a href="#widget_t_h">h</a> | wh\_t | 高度。 |
|
||||
| <a href="#widget_t_initializing">initializing</a> | bool\_t | 标识控件正在初始化。 |
|
||||
| <a href="#widget_t_loading">loading</a> | bool\_t | 标识控件正在加载。 |
|
||||
| <a href="#widget_t_name">name</a> | char* | 控件名字。 |
|
||||
| <a href="#widget_t_need_relayout_children">need\_relayout\_children</a> | bool\_t | 标识控件是否需要重新layout子控件。 |
|
||||
| <a href="#widget_t_need_update_style">need\_update\_style</a> | bool\_t | 标识控件是否需要update style。 |
|
||||
@ -2563,6 +2564,17 @@ ret_t widget_use_style (widget_t* widget, char* style);
|
||||
> <p id="widget_t_initializing">标识控件正在初始化。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### loading 属性
|
||||
-----------------------
|
||||
> <p id="widget_t_loading">标识控件正在加载。
|
||||
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
|
||||
@ -2767,6 +2767,10 @@
|
||||
"desc": "窗口加载完成事件(event_t)。\n",
|
||||
"name": "EVT_WINDOW_LOAD"
|
||||
},
|
||||
{
|
||||
"desc": "控件加载完成事件(event_t)。\n",
|
||||
"name": "EVT_WIDGET_LOAD"
|
||||
},
|
||||
{
|
||||
"desc": "窗口即将打开事件(event_t)。\n如果有窗口动画，在窗口动画开始前触发。如果没有窗口动画，在窗口被加载后的下一次循环中触发。\n",
|
||||
"name": "EVT_WINDOW_WILL_OPEN"
|
||||
@ -7017,6 +7021,10 @@
|
||||
{
|
||||
"desc": "使用自定义的软键盘(如计算器等应用不希望弹出系统软键盘)。\n",
|
||||
"name": "INPUT_CUSTOM"
|
||||
},
|
||||
{
|
||||
"desc": "使用自定义的密码软键盘。\n",
|
||||
"name": "INPUT_CUSTOM_PASSWORD"
|
||||
}
|
||||
],
|
||||
"header": "base/input_method.h",
|
||||
@ -10129,6 +10137,14 @@
|
||||
{
|
||||
"desc": "圆角半径(仅在WITH_VGCANVAS定义时生效)。\n",
|
||||
"name": "STYLE_ID_ROUND_RADIUS"
|
||||
},
|
||||
{
|
||||
"desc": "子控件布局参数。\n",
|
||||
"name": "STYLE_ID_CHILDREN_LAYOUT"
|
||||
},
|
||||
{
|
||||
"desc": "控件布局参数。\n",
|
||||
"name": "STYLE_ID_SELF_LAYOUT"
|
||||
}
|
||||
],
|
||||
"header": "base/style.h",
|
||||
@ -14011,6 +14027,15 @@
|
||||
"scriptable": true
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "stride",
|
||||
"desc": "一行占的字节\n",
|
||||
"type": "uint32_t",
|
||||
"annotation": {
|
||||
"readable": true,
|
||||
"scriptable": true
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "ratio",
|
||||
"desc": "显示比例。\n",
|
||||
@ -18590,6 +18615,14 @@
|
||||
"readable": true
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "loading",
|
||||
"desc": "标识控件正在加载。\n",
|
||||
"type": "bool_t",
|
||||
"annotation": {
|
||||
"readable": true
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "destroying",
|
||||
"desc": "标识控件正在被销毁。\n",
|
||||
@ -43145,7 +43178,7 @@
|
||||
}
|
||||
],
|
||||
"header": "widgets/combo_box.h",
|
||||
"desc": "下拉列表控件。\n点击右边的按钮，可弹出一个下拉列表，从中选择一项作为当前的值。\ncombo\\_box\\_t是[edit\\_t](edit_t.md)的子类控件，edit\\_t的函数均适用于combo\\_box\\_t控件。\n在xml中使用\"combo_box\"标签创建下拉列表控件。\n列表选项可以直接写在\"options\"属性中。如：\n```xml\n<combo_box readonly=\"true\" x=\"10\" y=\"bottom:5\" w=\"200\" h=\"30\" tr_text=\"ok\"\noptions=\"1:ok;2:cancel;\"/>\n```\n列表选项也可以放在独立的窗口中，用属性\"open_window\"指定窗口的名称。如：\n```xml\n<combo_box open_window=\"language\" readonly=\"true\" x=\"10\" y=\"bottom:50\" w=\"200\" h=\"30\"\ntr_text=\"english\"/>\n```\nlanguage.xml:\n```xml\n<popup close_when_click_outside=\"true\" h=\"80\" >\n<list_view x=\"0\" y=\"0\" w=\"100%\" h=\"100%\" item_height=\"30\">\n<scroll_view name=\"view\" x=\"0\" y=\"0\" w=\"-12\" h=\"100%\">\n<combo_box_item tr_text=\"english\"/>\n<combo_box_item tr_text=\"chinese\" />\n</scroll_view>\n<scroll_bar_d name=\"bar\" x=\"right\" y=\"0\" w=\"12\" h=\"100%\" value=\"0\"/>\n</list_view>\n</popup>\n```\n>\n更多用法请参考：[combo_box.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/ui/combo_box.xml)\n在c代码中使用函数combo\\_box\\_create创建下拉列表控件。如：\n```c\nwidget_t* combo_box = combo_box_create(win, 10, 10, 128, 30);\ncombo_box_set_options(combo_box, \"left;center;right;\");\ncombo_box_set_selected_index(combo_box, 1);\n```\n创建之后：\n* 用combo\\_box\\_set\\_options设置可选项目。\n* 用combo\\_box\\_set\\_selected\\_index设置缺省项。\n> 完整示例请参考：[combo_box\ndemo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/combo_box.c)\n可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：\n```xml\n<combo_box>\n<style name=\"default\" border_color=\"#a0a0a0\" text_color=\"black\" text_align_h=\"left\">\n<normal bg_color=\"#f0f0f0\" />\n<focused bg_color=\"#f0f0f0\" border_color=\"black\"/>\n<empty bg_color=\"#f0f0f0\" text_color=\"#a0a0a0\" />\n</style>\n</combo_box>\n```\n* 1.combobox的下拉按钮的style名称为combobox_down，可以在主题文件中设置。\n```xml\n<button>\n<style name=\"combobox_down\" border_color=\"#a0a0a0\">\n<normal bg_color=\"#f0f0f0\" icon=\"arrow_down_n\"/>\n<pressed bg_color=\"#c0c0c0\" icon=\"arrow_down_p\"/>\n<over bg_color=\"#e0e0e0\" icon=\"arrow_down_o\"/>\n</style>\n</button>\n```\n* 2.combobox的弹出popup窗口的style名称为combobox_popup，可以在主题文件中设置。\n```xml\n<popup>\n<style name=\"combobox_popup\" border_color=\"red\">\n<normal bg_color=\"#808080\"/>\n</style>\n</popup>\n```\n> 更多用法请参考：[theme\ndefault](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/styles/default.xml#L422)\n",
|
||||
"desc": "下拉列表控件。\n点击右边的按钮，可弹出一个下拉列表，从中选择一项作为当前的值。\ncombo\\_box\\_t是[edit\\_t](edit_t.md)的子类控件，edit\\_t的函数均适用于combo\\_box\\_t控件。\n在xml中使用\"combo_box\"标签创建下拉列表控件。\n列表选项可以直接写在\"options\"属性中。如：\n```xml\n<combo_box readonly=\"true\" x=\"10\" y=\"bottom:5\" w=\"200\" h=\"30\" tr_text=\"ok\"\noptions=\"1:ok;2:cancel;\"/>\n```\n列表选项也可以放在独立的窗口中，用属性\"open_window\"指定窗口的名称。如：\n```xml\n<combo_box open_window=\"language\" readonly=\"true\" x=\"10\" y=\"bottom:50\" w=\"200\" h=\"30\"\ntr_text=\"english\"/>\n```\nlanguage.xml:\n```xml\n<popup close_when_click_outside=\"true\" h=\"80\" >\n<list_view x=\"0\" y=\"0\" w=\"100%\" h=\"100%\" item_height=\"30\">\n<scroll_view name=\"view\" x=\"0\" y=\"0\" w=\"-12\" h=\"100%\">\n<combo_box_item tr_text=\"english\"/>\n<combo_box_item tr_text=\"chinese\" />\n</scroll_view>\n<scroll_bar_d name=\"bar\" x=\"right\" y=\"0\" w=\"12\" h=\"100%\" value=\"0\"/>\n</list_view>\n</popup>\n```\n> 更多用法请参考：[combo_box.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/ui/combo_box.xml)\n如果在文本比较长时，希望在获得焦点时文本自动滚动，可以放入一个hscroll_label为子控件，并命名为\"value\"。如：\n```xml\n<combo_box left_margin=\"6\" readonly=\"true\" x=\"10\" y=\"50\" w=\"80\" h=\"30\" options=\"leftttttttttt;centerrrrrrrrrrrrrrrr;rightttttttttt;\"\nselected_index=\"1\">\n<hscroll_label x=\"0\" y=\"0\" w=\"-30\" h=\"100%\"\nname=\"value\"\nlull=\"1000\"\nloop=\"true\"\nyoyo=\"true\"\nellipses=\"true\"\nonly_parent_focus=\"true\"/>\n<button style=\"combobox_down\" x=\"right:5\" y=\"middle\" w=\"20\" h=\"20\"/>\n</combo_box>\n```\n在c代码中使用函数combo\\_box\\_create创建下拉列表控件。如：\n```c\nwidget_t* combo_box = combo_box_create(win, 10, 10, 128, 30);\ncombo_box_set_options(combo_box, \"left;center;right;\");\ncombo_box_set_selected_index(combo_box, 1);\n```\n创建之后：\n* 用combo\\_box\\_set\\_options设置可选项目。\n* 用combo\\_box\\_set\\_selected\\_index设置缺省项。\n> 完整示例请参考：[combo_box\ndemo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/combo_box.c)\n可用通过style来设置控件的显示风格，如字体的大小和颜色等等。如：\n```xml\n<combo_box>\n<style name=\"default\" border_color=\"#a0a0a0\" text_color=\"black\" text_align_h=\"left\">\n<normal bg_color=\"#f0f0f0\" />\n<focused bg_color=\"#f0f0f0\" border_color=\"black\"/>\n<empty bg_color=\"#f0f0f0\" text_color=\"#a0a0a0\" />\n</style>\n</combo_box>\n```\n* 1.combobox的下拉按钮的style名称为combobox_down，可以在主题文件中设置。\n```xml\n<button>\n<style name=\"combobox_down\" border_color=\"#a0a0a0\">\n<normal bg_color=\"#f0f0f0\" icon=\"arrow_down_n\"/>\n<pressed bg_color=\"#c0c0c0\" icon=\"arrow_down_p\"/>\n<over bg_color=\"#e0e0e0\" icon=\"arrow_down_o\"/>\n</style>\n</button>\n```\n* 2.combobox的弹出popup窗口的style名称为combobox_popup，可以在主题文件中设置。\n```xml\n<popup>\n<style name=\"combobox_popup\" border_color=\"red\">\n<normal bg_color=\"#808080\"/>\n</style>\n</popup>\n```\n> 更多用法请参考：[theme\ndefault](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/styles/default.xml#L422)\n",
|
||||
"name": "combo_box_t",
|
||||
"parent": "widget_t",
|
||||
"annotation": {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user