update docs

This commit is contained in:
xianjimli 2019-03-14 16:33:02 +08:00
parent bd3773b7d2
commit ecafe2b617
4 changed files with 54 additions and 2 deletions

View File

@ -16,6 +16,7 @@
| <a href="#emitter_t_emitter_destroy">emitter\_destroy</a> | 销毁。 |
| <a href="#emitter_t_emitter_disable">emitter\_disable</a> | 禁用。 |
| <a href="#emitter_t_emitter_dispatch">emitter\_dispatch</a> | 分发事件。如果当前分发的回调函数返回RET_REMOVE该回调函数将被移出。 |
| <a href="#emitter_t_emitter_dispatch_simple_event">emitter\_dispatch\_simple\_event</a> | 分发事件。 |
| <a href="#emitter_t_emitter_enable">emitter\_enable</a> | 启用。 |
| <a href="#emitter_t_emitter_find">emitter\_find</a> | 通过ID查找emitter_item_t主要用于辅助测试。 |
| <a href="#emitter_t_emitter_init">emitter\_init</a> | 初始化emitter对象。 |
@ -171,6 +172,29 @@ ret_t emitter_dispatch (emitter_t* emitter, event_t* e);
| 返回值 | ret\_t | |
| emitter | emitter\_t* | emitter对象。 |
| e | event\_t* | 事件对象。 |
#### emitter\_dispatch\_simple\_event 函数
-----------------------
* 函数功能:
> <p id="emitter_t_emitter_dispatch_simple_event"> 分发事件。
> 对emitter_dispatch的包装分发一个简单的事件。
如果当前分发的回调函数返回RET_STOPdispatch中断分发并返回RET_STOP否则返回RET_OK。
* 函数原型:
```
ret_t emitter_dispatch_simple_event (emitter_t* emitter);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | |
| emitter | emitter\_t* | emitter对象。 |
#### emitter\_enable 函数
-----------------------

View File

@ -9,5 +9,7 @@
| -------- | ------- |
| EVT\_PROP\_WILL\_CHANGE | 对象的属性即将改变的事件名(prop\_change\_event\_t)。 |
| EVT\_PROP\_CHANGED | 对象的属性改变的事件名(prop\_change\_event\_t)。 |
| EVT\_ITEMS\_WILL\_CHANGE | 即将增加和删除集合中的项目(event\_t)。 |
| EVT\_ITEMS\_CHANGED | 完成增加和删除集合中的项目(event\_t)。 |
| EVT\_PROPS\_CHANGED | 对象的属性改变的事件名(props\_event\_t)。 |
| EVT\_DESTROY | 对象销毁事件名(event\_t)。 |

View File

@ -136,7 +136,7 @@ ret_t list_view_set_auto_hide_scroll_bar (widget_t* widget, bool_t auto_hide_scr
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| widget | widget\_t* | 控件对象。 |
| auto\_hide\_scroll\_bar | bool\_t | 列表项的高度。 |
| auto\_hide\_scroll\_bar | bool\_t | 是否自动隐藏滚动条。 |
#### list\_view\_set\_default\_item\_height 函数
-----------------------

View File

@ -14588,6 +14588,24 @@
"desc": ""
}
},
{
"params": [
{
"type": "emitter_t*",
"name": "emitter",
"desc": "emitter对象。"
}
],
"annotation": {
"scriptable": true
},
"desc": " 分发事件。\n > 对emitter_dispatch的包装分发一个简单的事件。\n 如果当前分发的回调函数返回RET_STOPdispatch中断分发并返回RET_STOP否则返回RET_OK。\n\n",
"name": "emitter_dispatch_simple_event",
"return": {
"type": "ret_t",
"desc": ""
}
},
{
"params": [
{
@ -14923,6 +14941,14 @@
"desc": " 对象的属性改变的事件名(prop_change_event_t)。\n\n",
"name": "EVT_PROP_CHANGED"
},
{
"desc": " 即将增加和删除集合中的项目(event_t)。\n\n",
"name": "EVT_ITEMS_WILL_CHANGE"
},
{
"desc": " 完成增加和删除集合中的项目(event_t)。\n\n",
"name": "EVT_ITEMS_CHANGED"
},
{
"desc": " 对象的属性改变的事件名(props_event_t)。\n\n",
"name": "EVT_PROPS_CHANGED"
@ -19211,7 +19237,7 @@
{
"type": "bool_t",
"name": "auto_hide_scroll_bar",
"desc": "列表项的高度。"
"desc": "是否自动隐藏滚动条。"
}
],
"annotation": {