diff --git a/docs/manual/app_conf_t.md b/docs/manual/app_conf_t.md index 68713864e..e6930eb5b 100644 --- a/docs/manual/app_conf_t.md +++ b/docs/manual/app_conf_t.md @@ -23,7 +23,7 @@ | app\_conf\_off\_changed\_by\_ctx | 注销配置变化事件。 | | app\_conf\_on\_changed | 注册配置变化事件。 | | app\_conf\_remove | 删除配置项。 | -| app\_conf\_save | 保存配置。 | +| app\_conf\_save | 持久保存配置。 | | app\_conf\_set | 设置配置项的值。 | | app\_conf\_set\_bool | 设置bool类型配置项的值。 | | app\_conf\_set\_double | 设置双精度类型配置项的值。 | @@ -269,7 +269,7 @@ ret_t app_conf_remove (const char* key); * 函数功能： ->

保存配置。 +>

持久保存配置。 * 函数原型： diff --git a/docs/manual/conf_json_t.md b/docs/manual/conf_json_t.md index 57a0dd174..79f2960c9 100644 --- a/docs/manual/conf_json_t.md +++ b/docs/manual/conf_json_t.md @@ -10,27 +10,6 @@ conf json对象。 | 函数名称 | 说明 | | -------- | ------------ | | conf\_json\_load | | -| conf\_json\_load | | -#### conf\_json\_load 函数 ------------------------ - -* 函数功能： - ->

- -* 函数原型： - -``` -object_t* conf_json_load (const char* url, bool_t create_if_not_exist); -``` - -* 参数说明： - -| 参数 | 类型 | 说明 | -| -------- | ----- | --------- | -| 返回值 | object\_t* | 返回配置对象。 | -| url | const char* | 路径(通常是文件路径)。 | -| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | #### conf\_json\_load 函数 ----------------------- diff --git a/docs/manual/conf_node_t.md b/docs/manual/conf_node_t.md index 34ddc6956..1f446d026 100644 --- a/docs/manual/conf_node_t.md +++ b/docs/manual/conf_node_t.md @@ -9,9 +9,9 @@ | -------- | ------------ | | conf\_node\_find\_child | 查找指定名称的子节点。 | | conf\_node\_find\_sibling | 查找指定名称的兄弟节点。 | +| conf\_node\_get\_first\_child | 获取第一个子节点。 | | conf\_node\_get\_name | 获得节点的名称。 | | conf\_node\_get\_value | 设置节点的值。 | -| conf\_node\_set\_first\_child | 获取第一个子节点。 | | conf\_node\_set\_first\_child | 设置第一个子节点。 | | conf\_node\_set\_value | 设置节点的值。 | ### 属性 @@ -63,6 +63,25 @@ conf_node_t* conf_node_find_sibling (conf_node_t* node, const char* name); | 返回值 | conf\_node\_t* | 返回节点对象。 | | node | conf\_node\_t* | 节点对象。 | | name | const char* | 节点名称。 | +#### conf\_node\_get\_first\_child 函数 +----------------------- + +* 函数功能： + +>

获取第一个子节点。 + +* 函数原型： + +``` +conf_node_t* conf_node_get_first_child (conf_node_t* node); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | conf\_node\_t* | 返回第一个子节点。 | +| node | conf\_node\_t* | 节点对象。 | #### conf\_node\_get\_name 函数 ----------------------- @@ -107,25 +126,6 @@ ret_t conf_node_get_value (conf_node_t* node, value_t* v); * 函数功能： ->

获取第一个子节点。 - -* 函数原型： - -``` -conf_node_t* conf_node_set_first_child (conf_node_t* node); -``` - -* 参数说明： - -| 参数 | 类型 | 说明 | -| -------- | ----- | --------- | -| 返回值 | conf\_node\_t* | 返回第一个子节点。 | -| node | conf\_node\_t* | 节点对象。 | -#### conf\_node\_set\_first\_child 函数 ------------------------ - -* 函数功能： - >

设置第一个子节点。 * 函数原型： diff --git a/docs/manual/conf_ubjson_t.md b/docs/manual/conf_ubjson_t.md new file mode 100644 index 000000000..4107d2551 --- /dev/null +++ b/docs/manual/conf_ubjson_t.md @@ -0,0 +1,32 @@ +## conf\_ubjson\_t +### 概述 +![image](images/conf_ubjson_t_0.png) + +conf json对象。 +---------------------------------- +### 函数 +

+ +| 函数名称 | 说明 | +| -------- | ------------ | +| conf\_ubjson\_load | | +#### conf\_ubjson\_load 函数 +----------------------- + +* 函数功能： + +>

+ +* 函数原型： + +``` +object_t* conf_ubjson_load (const char* url, bool_t create_if_not_exist); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | object\_t* | 返回配置对象。 | +| url | const char* | 路径(通常是文件路径)。 | +| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | diff --git a/docs/manual/images/conf_ubjson_t_0.png b/docs/manual/images/conf_ubjson_t_0.png new file mode 100644 index 000000000..fd0f4a5b1 Binary files /dev/null and b/docs/manual/images/conf_ubjson_t_0.png differ diff --git a/docs/manual/widget_t.md b/docs/manual/widget_t.md index c1e466877..9751207e7 100644 --- a/docs/manual/widget_t.md +++ b/docs/manual/widget_t.md @@ -94,6 +94,7 @@ widget_on(button, EVT_CLICK, on_click, NULL); | widget\_get\_window\_manager | 获取当前的窗口管理器。 | | widget\_grab | 让指定子控件抓住事件。 | | widget\_index\_of | 获取控件在父控件中的索引编号。 | +| widget\_init | 初始化控件。仅在子类控件构造函数中使用。 | | widget\_insert\_child | 插入子控件到指定的位置。 | | widget\_invalidate | 请求重绘指定的区域，如果widget->dirty已经为TRUE，直接返回。 | | widget\_invalidate\_force | 请求强制重绘控件。 | @@ -102,6 +103,7 @@ widget_on(button, EVT_CLICK, on_click, NULL); | widget\_is\_instance\_of | 检查控件是否是指定的类型。 | | widget\_is\_normal\_window | 检查控件是否是普通窗口类型。 | | widget\_is\_opened\_popup | 检查控件弹出窗口控件是否已经打开了（而非挂起状态）。 | +| widget\_is\_point\_in | 判断一个点是否在控件内。 | | widget\_is\_popup | 检查控件是否是弹出窗口类型。 | | widget\_is\_system\_bar | 检查控件是否是system bar类型。 | | widget\_is\_window | 判断当前控件是否是窗口。 | @@ -121,6 +123,7 @@ widget_on(button, EVT_CLICK, on_click, NULL); | widget\_off\_by\_tag | 注销指定tag的事件处理函数。 | | widget\_on | 注册指定事件的处理函数。 | | widget\_on\_with\_tag | 注册指定tag的事件处理函数。 | +| widget\_paint | 绘制控件到一个canvas上。 | | widget\_paint\_helper | 帮助子控件实现自己的绘制函数。 | | widget\_pause\_animator | 暂停动画。 | | widget\_ref | 增加控件的引用计数。 | @@ -1181,6 +1184,35 @@ int32_t widget_index_of (widget_t* widget); | -------- | ----- | --------- | | 返回值 | int32\_t | 在父控件中的索引编号。 | | widget | widget\_t* | 控件对象。 | +#### widget\_init 函数 +----------------------- + +* 函数功能： + +>

初始化控件。仅在子类控件构造函数中使用。 + +> 请用widget\_create代替本函数。 + +@depreated + +* 函数原型： + +``` +widget_t* widget_init (widget_t* widget, widget_t* parent, widget_vtable_t* vt, xy_t x, xy_t y, wh_t w, wh_t h); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | widget\_t* | widget对象本身。 | +| widget | widget\_t* | widget对象。 | +| parent | widget\_t* | widget的父控件。 | +| vt | widget\_vtable\_t* | 虚表。 | +| x | xy\_t | x坐标 | +| y | xy\_t | y坐标 | +| w | wh\_t | 宽度 | +| h | wh\_t | 高度 | #### widget\_insert\_child 函数 ----------------------- @@ -1338,6 +1370,28 @@ bool_t widget_is_opened_popup (widget_t* widget); | -------- | ----- | --------- | | 返回值 | bool\_t | 返回FALSE表示不是，否则表示是。 | | widget | widget\_t* | widget对象。 | +#### widget\_is\_point\_in 函数 +----------------------- + +* 函数功能： + +>

判断一个点是否在控件内。 + +* 函数原型： + +``` +bool_t widget_is_point_in (widget_t* widget, xy_t x, xy_t y, bool_t is_local); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | bool\_t | 返回RET\_OK表示成功，否则表示失败。 | +| widget | widget\_t* | 控件对象。 | +| x | xy\_t | x坐标 | +| y | xy\_t | y坐标 | +| is\_local | bool\_t | TRUE表示是相对与控件左上角的坐标，否则表示全局坐标。 | #### widget\_is\_popup 函数 ----------------------- @@ -1753,6 +1807,26 @@ uint32_t widget_on_with_tag (widget_t* widget, event_type_t type, event_func_t o | on\_event | event\_func\_t | 事件处理函数。 | | ctx | void* | 事件处理函数上下文。 | | tag | uint32\_t | tag。 | +#### widget\_paint 函数 +----------------------- + +* 函数功能： + +>

绘制控件到一个canvas上。 + +* 函数原型： + +``` +ret_t widget_paint (widget_t* widget, canvas_t* c); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | +| widget | widget\_t* | 控件对象。 | +| c | canvas\_t* | 画布对象。 | #### widget\_paint\_helper 函数 -----------------------