From 2ab14663349007ae163da688e00ebdceb8231e87 Mon Sep 17 00:00:00 2001 From: xianjimli Date: Thu, 27 Dec 2018 10:32:01 +0800 Subject: [PATCH] update docs --- docs/manual.md | 8 +-- docs/manual/button_t.md | 3 +- docs/manual/progress_bar_t.md | 3 +- docs/manual/slider_t.md | 3 +- docs/manual/value_t.md | 94 ++++++++++++++++++++++++----------- docs/manual/vgcanvas_t.md | 2 +- 6 files changed, 77 insertions(+), 36 deletions(-) diff --git a/docs/manual.md b/docs/manual.md index cbbbed472..ab31a18bd 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -71,9 +71,9 @@ ## 二、基本函数库 -[tkmem](docs/tk_mem_t.md) 内存管理。 -[value](docs/value_t.md) 通用值对象。 -[str](docs/str_t.md) UTF-8字符串对象。 -[wstr](docs/wstr_t.md) Unicode字符串对象。 +* [tkmem](manual/tk_mem_t.md) 内存管理。 +* [value](manual/value_t.md) 通用值对象。 +* [str](manual/str_t.md) UTF-8字符串对象。 +* [wstr](manual/wstr_t.md) Unicode字符串对象。 diff --git a/docs/manual/button_t.md b/docs/manual/button_t.md index 794534c23..dc99b1e08 100644 --- a/docs/manual/button_t.md +++ b/docs/manual/button_t.md @@ -44,7 +44,8 @@ ``` > 更多用法请参考： - [theme default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L31) + [theme + default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L31) ### 函数

diff --git a/docs/manual/progress_bar_t.md b/docs/manual/progress_bar_t.md index 9e5a417ac..37d13c42c 100644 --- a/docs/manual/progress_bar_t.md +++ b/docs/manual/progress_bar_t.md @@ -36,7 +36,8 @@ ``` > 更多用法请参考： - [theme default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L183) + [theme + default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L183) ### 函数

diff --git a/docs/manual/slider_t.md b/docs/manual/slider_t.md index 473ab4c3b..e1ca4516e 100644 --- a/docs/manual/slider_t.md +++ b/docs/manual/slider_t.md @@ -39,7 +39,8 @@ ``` > 更多用法请参考： - [theme default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L179) + [theme + default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L179) ### 函数

diff --git a/docs/manual/value_t.md b/docs/manual/value_t.md index 88d5ea767..2aac33f2b 100644 --- a/docs/manual/value_t.md +++ b/docs/manual/value_t.md @@ -1,6 +1,16 @@ ## value\_t ### 概述 - 一个通用数据类型，用来存放整数、浮点数、obj_t、str_t和其它对象。 + 一个通用数据类型，用来存放整数、浮点数、字符串和其它对象。 + + 在C/C++中，一般不需动态创建对象，直接声明并初始化即可。如： + + ```c + value_t v; + value_set_int(&v, 100); + ``` + +> 在脚本语言中，需要动态创建对象。 + ### 函数

@@ -9,7 +19,7 @@ | -------- | ------------ | | value\_bool | 获取类型为bool的值。 | | value\_copy | 拷贝value的值。 | -| value\_create | 创建value对象 | +| value\_create | 创建value对象。 | | value\_destroy | @deconstructor | | value\_double | 获取类型为double的值。 | | value\_equal | 判断两个value是否相同。 | @@ -32,22 +42,18 @@ | value\_set\_int64 | 设置类型为int64的值。 | | value\_set\_int8 | 设置类型为int8的值。 | | value\_set\_pointer | 设置类型为pointer的值。 | -| value\_set\_str | 设置类型为char*的值。 | +| value\_set\_str | 设置类型为字符串的值。 | | value\_set\_uint16 | 设置类型为uint16的值。 | | value\_set\_uint32 | 设置类型为uint32的值。 | | value\_set\_uint64 | 设置类型为uint64的值。 | | value\_set\_uint8 | 设置类型为uint8的值。 | -| value\_str | 获取类型为str_t的值。 | +| value\_set\_wstr | 设置类型为宽字符串的值。 | +| value\_str | 获取类型为字符串的值。 | | value\_uint16 | 获取类型为uint16的值。 | | value\_uint32 | 获取类型为uint32的值。 | | value\_uint64 | 获取类型为uint64的值。 | | value\_uint8 | 获取类型为uint8的值。 | -### 属性 -

- -| 名属性称 | 类型 | 说明 | -| -------- | ----- | ------------ | -| type | int8\_t | 类型。 | +| value\_wstr | 获取类型为宽字符串的值。 | #### value\_bool 函数 ----------------------- @@ -83,14 +89,14 @@ bool_t value_bool (value_t* v); * 函数原型： ``` -void value_copy (value_t* dst, value_t* src); +ret_t value_copy (value_t* dst, value_t* src); ``` * 参数说明： | 参数 | 类型 | 说明 | | -------- | ----- | --------- | -| 返回值 | void | 值。 | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | dst | value\_t* | 目的value对象。 | | src | value\_t* | 源value对象。 | #### value\_create 函数 @@ -98,7 +104,7 @@ void value_copy (value_t* dst, value_t* src); * 函数功能： ->

创建value对象 +>

创建value对象。 @@ -120,7 +126,7 @@ value_t* value_create (); * 函数功能： >

@deconstructor - 销毁value对象 + 销毁value对象。 @@ -128,14 +134,14 @@ value_t* value_create (); * 函数原型： ``` -void value_destroy (value_t* v); +ret_t value_destroy (value_t* v); ``` * 参数说明： | 参数 | 类型 | 说明 | | -------- | ----- | --------- | -| 返回值 | void | | +| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 | | v | value\_t* | value对象。 | #### value\_double 函数 ----------------------- @@ -615,7 +621,7 @@ value_t* value_set_pointer (value_t* v, pointer_t value); * 函数功能： ->

设置类型为char*的值。 +>

设置类型为字符串的值。 @@ -623,7 +629,7 @@ value_t* value_set_pointer (value_t* v, pointer_t value); * 函数原型： ``` -value_t* value_set_str (value_t* v, char* value); +value_t* value_set_str (value_t* v, const char* value); ``` * 参数说明： @@ -632,7 +638,7 @@ value_t* value_set_str (value_t* v, char* value); | -------- | ----- | --------- | | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | -| value | char* | 待设置的值。 | +| value | const char* | 待设置的值。 | #### value\_set\_uint16 函数 ----------------------- @@ -725,12 +731,35 @@ value_t* value_set_uint8 (value_t* v, uint8_t value); | 返回值 | value\_t* | value对象本身。 | | v | value\_t* | value对象。 | | value | uint8\_t | 待设置的值。 | +#### value\_set\_wstr 函数 +----------------------- + +* 函数功能： + +>

设置类型为宽字符串的值。 + + + + +* 函数原型： + +``` +value_t* value_set_wstr (value_t* v, const wchar_t* value); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | value\_t* | value对象本身。 | +| v | value\_t* | value对象。 | +| value | const wchar\_t* | 待设置的值。 | #### value\_str 函数 ----------------------- * 函数功能： ->

获取类型为str_t的值。 +>

获取类型为字符串的值。 @@ -835,16 +864,25 @@ int8_t value_uint8 (value_t* v); | -------- | ----- | --------- | | 返回值 | int8\_t | 值。 | | v | value\_t* | value对象。 | -#### type 属性 +#### value\_wstr 函数 ----------------------- ->

类型。 + +* 函数功能： + +>

获取类型为宽字符串的值。 -* 类型：int8\_t -| 特性 | 是否支持 | -| -------- | ----- | -| 可直接读取 | 是 | -| 可直接修改 | 否 | -| 可脚本化 | 是 | +* 函数原型： + +``` +const wchar_t* value_wstr (value_t* v); +``` + +* 参数说明： + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | const wchar\_t* | 值。 | +| v | value\_t* | value对象。 | diff --git a/docs/manual/vgcanvas_t.md b/docs/manual/vgcanvas_t.md index 8c1a5be98..b52cc1fe0 100644 --- a/docs/manual/vgcanvas_t.md +++ b/docs/manual/vgcanvas_t.md @@ -23,7 +23,7 @@ vgcanvas_t* vg = canvas_get_vgcanvas(c); vgcanvas_save(vg); vgcanvas_translate(vg, 0, 100); - + vgcanvas_set_line_width(vg, 1); vgcanvas_set_fill_color(vg, color_init(0xff, 0, 0, 0xff)); vgcanvas_rect(vg, 5, 5, 100, 100);