Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xianjimli committed Jan 15, 2019
1 parent 9e7ce8e commit 9ce664c
Show file tree
Hide file tree
Showing 10 changed files with 150 additions and 20 deletions.
4 changes: 3 additions & 1 deletion docs/changes.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# 最新动态
* 2019/01/15
* 整理API文档:progress\_circle/rich\_text/slide\_menu/slide\_view/svg\_image/switch
* 整理API文档:text\_selector
* 整理API文档:text\_selector/time\_clock/digit\_clock
* 增加progress\_circle c语言demo。
* 增加slide\_menu c语言demo。
* 增加slide\_view c语言demo。
* 增加svg\_image c语言demo。
* 增加switch c语言demo。
* 增加text\_selector c语言demo。
* 增加time\_clock c语言demo。
* 增加digit\_clock c语言demo。
* 增加INPUT\_CUSTOM用于关闭系统缺省软键盘。

* 2019/01/14
Expand Down
2 changes: 2 additions & 0 deletions docs/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@
* [svg\_image](manual/svg_image_t.md) SVG图片控件。
* [switch](manual/switch_t.md) 开关控件。
* [text\_selector](manual/text\_selector_t.md) 文本选择器控件。
* [time\_clock](manual/time\_clock_t.md) 模拟时钟控件。
* [digit\_clock](manual/digit\_clock_t.md) 数字时钟控件。

### 画布

Expand Down
34 changes: 34 additions & 0 deletions docs/manual/digit_clock_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,39 @@
![image](images/digit_clock_t_0.png)

数字时钟控件。

digit\_clock\_t是[widget\_t](widget_t.md)的子类控件,widget\_t的函数均适用于digit\_clock\_t控件。

在xml中使用"digit\_clock"标签创建数字时钟控件。如:

```xml
<digit_clock format="YY/MM/DD h:mm:ss"/>
```

> 更多用法请参考:[digit\_clock.xml](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/digit_clock.xml)

在c代码中使用函数digit\_clock\_create创建数字时钟控件。如:

```c
widget_t* tc = digit_clock_create(win, 10, 10, 240, 30);
digit_clock_set_format(tc, "YY/MM/DD h:mm:ss");
```
> 完整示例请参考:[digit\_clock demo](
https://github.com/zlgopen/awtk-c-demos/blob/master/demos/digit_clock.c)
可用通过style来设置控件的显示风格,如字体的大小和颜色等等。如:
```xml
<style name="default">
<normal text_color="black" />
</style>
```

> 更多用法请参考:[theme default](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L138)


----------------------------------
### 函数
Expand Down Expand Up @@ -90,6 +123,7 @@ ret_t digit_clock_set_format (widget_t* widget, const char* format);
#### format 属性
-----------------------
> <p id="digit_clock_t_format"> 显示格式。
Y 代表年(完整显示)
M 代表月(1-12)
D 代表日(1-31)
Expand Down
12 changes: 6 additions & 6 deletions docs/manual/label_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
<label style="center" text="center"/>
```

> 更多用法请参考:
[label.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/label.xml)
> 更多用法请参考:[label.xml](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/label.xml)

在c代码中使用函数label\_create创建文本控件。如:

Expand All @@ -29,8 +29,8 @@
> 创建之后,需要用widget\_set\_text或widget\_set\_text\_utf8设置文本内容。
> 完整示例请参考:
[label demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/label.c)
> 完整示例请参考:[label demo](
https://github.com/zlgopen/awtk-c-demos/blob/master/demos/label.c)
可用通过style来设置控件的显示风格,如字体的大小和颜色等等。如:
Expand All @@ -41,8 +41,8 @@
```

> 更多用法请参考:
[theme
default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L144)
[theme default](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L144)


----------------------------------
Expand Down
31 changes: 30 additions & 1 deletion docs/manual/time_clock_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,36 @@
### 概述
![image](images/time_clock_t_0.png)

时钟控件。
模拟时钟控件。

time\_clock\_t是[widget\_t](widget_t.md)的子类控件,widget\_t的函数均适用于time\_clock\_t控件。

在xml中使用"time\_clock"标签创建开关控件。如:

```xml
<time_clock x="c" y="m" w="300" h="300" bg_image="clock_bg" image="clock"
hour_image="clock_hour" minute_image="clock_minute" second_image="clock_second"/>
```

> 更多用法请参考:[time\_clock.xml](
https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/time_clock.xml)

在c代码中使用函数time\_clock\_create创建开关控件。如:

```c
widget_t* tc = time_clock_create(win, 10, 10, 240, 240);
time_clock_set_image(tc, "clock");
time_clock_set_bg_image(tc, "clock_bg");
time_clock_set_hour_image(tc, "clock_hour");
time_clock_set_minute_image(tc, "clock_minute");
time_clock_set_second_image(tc, "clock_second");
```
> 完整示例请参考:[time_clock demo](
https://github.com/zlgopen/awtk-c-demos/blob/master/demos/time_clock.c)
time\_clock一般不需要设置style。
----------------------------------
### 函数
Expand Down
2 changes: 1 addition & 1 deletion src/ext_widgets/slide_menu/slide_menu.h
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ BEGIN_C_DECLS
* ```c
* widget_on(slide_menu, EVT_VALUE_CHANGED, on_current_changed, slide_menu);
* ```
* 可按下面的方法关注当前按钮被点击的事件:
*
* ```c
Expand Down
34 changes: 34 additions & 0 deletions src/ext_widgets/time_clock/digit_clock.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,47 @@ BEGIN_C_DECLS
* @parent widget_t
* @annotation ["scriptable"]
* 数字时钟控件。
*
* digit\_clock\_t是[widget\_t](widget_t.md)的子类控件,widget\_t的函数均适用于digit\_clock\_t控件。
*
* 在xml中使用"digit\_clock"标签创建数字时钟控件。如:
*
* ```xml
* <digit_clock format="YY/MM/DD h:mm:ss"/>
* ```
*
* > 更多用法请参考:[digit\_clock.xml](
* https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/digit_clock.xml)
*
* 在c代码中使用函数digit\_clock\_create创建数字时钟控件。如:
*
* ```c
* widget_t* tc = digit_clock_create(win, 10, 10, 240, 30);
* digit_clock_set_format(tc, "YY/MM/DD h:mm:ss");
* ```
*
* > 完整示例请参考:[digit\_clock demo](
* https://github.com/zlgopen/awtk-c-demos/blob/master/demos/digit_clock.c)
*
* 可用通过style来设置控件的显示风格,如字体的大小和颜色等等。如:
*
* ```xml
* <style name="default">
* <normal text_color="black" />
* </style>
* ```
*
* > 更多用法请参考:[theme default](
* https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L138)
*
*/
typedef struct _digit_clock_t {
widget_t widget;
/**
* @property {char*} format
* @annotation ["set_prop","get_prop","readable","persitent","design","scriptable"]
* 显示格式。
*
* Y 代表年(完整显示)
* M 代表月(1-12)
* D 代表日(1-31)
Expand Down
31 changes: 30 additions & 1 deletion src/ext_widgets/time_clock/time_clock.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,36 @@ BEGIN_C_DECLS
* @class time_clock_t
* @parent widget_t
* @annotation ["scriptable"]
* 时钟控件。
* 模拟时钟控件。
*
* time\_clock\_t是[widget\_t](widget_t.md)的子类控件,widget\_t的函数均适用于time\_clock\_t控件。
*
* 在xml中使用"time\_clock"标签创建开关控件。如:
*
* ```xml
* <time_clock x="c" y="m" w="300" h="300" bg_image="clock_bg" image="clock"
* hour_image="clock_hour" minute_image="clock_minute" second_image="clock_second"/>
* ```
*
* > 更多用法请参考:[time\_clock.xml](
* https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/time_clock.xml)
*
* 在c代码中使用函数time\_clock\_create创建开关控件。如:
*
* ```c
* widget_t* tc = time_clock_create(win, 10, 10, 240, 240);
* time_clock_set_image(tc, "clock");
* time_clock_set_bg_image(tc, "clock_bg");
* time_clock_set_hour_image(tc, "clock_hour");
* time_clock_set_minute_image(tc, "clock_minute");
* time_clock_set_second_image(tc, "clock_second");
* ```
*
* > 完整示例请参考:[time_clock demo](
* https://github.com/zlgopen/awtk-c-demos/blob/master/demos/time_clock.c)
*
* time\_clock一般不需要设置style。
*
*/
typedef struct _time_clock_t {
widget_t widget;
Expand Down
12 changes: 6 additions & 6 deletions src/widgets/label.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ BEGIN_C_DECLS
* <label style="center" text="center"/>
* ```
*
* > 更多用法请参考:
* [label.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/label.xml)
* > 更多用法请参考:[label.xml](
*https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/label.xml)
*
* 在c代码中使用函数label\_create创建文本控件。如:
*
Expand All @@ -57,8 +57,8 @@ BEGIN_C_DECLS
*
* > 创建之后,需要用widget\_set\_text或widget\_set\_text\_utf8设置文本内容。
*
* > 完整示例请参考:
* [label demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/label.c)
* > 完整示例请参考:[label demo](
*https://github.com/zlgopen/awtk-c-demos/blob/master/demos/label.c)
*
* 可用通过style来设置控件的显示风格,如字体的大小和颜色等等。如:
*
Expand All @@ -69,8 +69,8 @@ BEGIN_C_DECLS
* ```
*
* > 更多用法请参考:
* [theme
* default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L144)
* [theme default](
*https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L144)
*
*/
typedef struct _label_t {
Expand Down
8 changes: 4 additions & 4 deletions tools/idl_gen/idl.json
Original file line number Diff line number Diff line change
Expand Up @@ -20310,7 +20310,7 @@
"properties": [
{
"name": "format",
"desc": " 显示格式。\r\n Y 代表年(完整显示)\r\n M 代表月(1-12)\r\n D 代表日(1-31)\r\n h 代表时(0-23)\r\n m 代表分(0-59)\r\n s 代表秒(0-59)\r\n YY 代表年(只显示末两位)\r\n MM 代表月(01-12)\r\n DD 代表日(01-31)\r\n hh 代表时(00-23)\r\n mm 代表分(00-59)\r\n ss 代表秒(00-59)\r\n\r\n 如 日期时间为:2018/11/12 9:10:20\r\n \"Y/D/M\"显示为\"2018/11/12\"\r\n \"Y-D-M\"显示为\"2018-11-12\"\r\n \"Y-D-M h:m:s\"显示为\"2018-11-12 9:10:20\"\r\n \"Y-D-M hh:mm:ss\"显示为\"2018-11-12 09:10:20\"\r\n",
"desc": " 显示格式。\r\n\r\n Y 代表年(完整显示)\r\n M 代表月(1-12)\r\n D 代表日(1-31)\r\n h 代表时(0-23)\r\n m 代表分(0-59)\r\n s 代表秒(0-59)\r\n YY 代表年(只显示末两位)\r\n MM 代表月(01-12)\r\n DD 代表日(01-31)\r\n hh 代表时(00-23)\r\n mm 代表分(00-59)\r\n ss 代表秒(00-59)\r\n\r\n 如 日期时间为:2018/11/12 9:10:20\r\n \"Y/D/M\"显示为\"2018/11/12\"\r\n \"Y-D-M\"显示为\"2018-11-12\"\r\n \"Y-D-M h:m:s\"显示为\"2018-11-12 9:10:20\"\r\n \"Y-D-M hh:mm:ss\"显示为\"2018-11-12 09:10:20\"\r\n",
"type": "char*",
"annotation": {
"set_prop": true,
Expand All @@ -20323,7 +20323,7 @@
}
],
"header": "time_clock/digit_clock.h",
"desc": " 数字时钟控件。\r\n",
"desc": " 数字时钟控件。\r\n\r\n digit\\_clock\\_t是[widget\\_t](widget_t.md)的子类控件,widget\\_t的函数均适用于digit\\_clock\\_t控件。\r\n\r\n 在xml中使用\"digit\\_clock\"标签创建数字时钟控件。如:\r\n\r\n ```xml\r\n <digit_clock format=\"YY/MM/DD h:mm:ss\"/>\r\n ```\r\n\r\n > 更多用法请参考:[digit\\_clock.xml](\r\n https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/digit_clock.xml)\r\n\r\n 在c代码中使用函数digit\\_clock\\_create创建数字时钟控件。如:\r\n\r\n ```c\r\n widget_t* tc = digit_clock_create(win, 10, 10, 240, 30);\r\n digit_clock_set_format(tc, \"YY/MM/DD h:mm:ss\");\r\n ```\r\n\r\n > 完整示例请参考:[digit\\_clock demo](\r\n https://github.com/zlgopen/awtk-c-demos/blob/master/demos/digit_clock.c)\r\n\r\n 可用通过style来设置控件的显示风格,如字体的大小和颜色等等。如:\r\n\r\n ```xml\r\n <style name=\"default\">\r\n <normal text_color=\"black\" />\r\n </style>\r\n ```\r\n\r\n > 更多用法请参考:[theme default](\r\n https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L138)\r\n\r\n",
"name": "digit_clock_t",
"parent": "widget_t",
"annotation": {
Expand Down Expand Up @@ -20685,7 +20685,7 @@
}
],
"header": "time_clock/time_clock.h",
"desc": " 时钟控件。\r\n",
"desc": " 模拟时钟控件。\r\n\r\n time\\_clock\\_t是[widget\\_t](widget_t.md)的子类控件,widget\\_t的函数均适用于time\\_clock\\_t控件。\r\n\r\n 在xml中使用\"time\\_clock\"标签创建开关控件。如:\r\n\r\n ```xml\r\n <time_clock x=\"c\" y=\"m\" w=\"300\" h=\"300\" bg_image=\"clock_bg\" image=\"clock\"\r\n hour_image=\"clock_hour\" minute_image=\"clock_minute\" second_image=\"clock_second\"/>\r\n ```\r\n\r\n > 更多用法请参考:[time\\_clock.xml](\r\n https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/time_clock.xml)\r\n\r\n 在c代码中使用函数time\\_clock\\_create创建开关控件。如:\r\n\r\n ```c\r\n widget_t* tc = time_clock_create(win, 10, 10, 240, 240);\r\n time_clock_set_image(tc, \"clock\");\r\n time_clock_set_bg_image(tc, \"clock_bg\");\r\n time_clock_set_hour_image(tc, \"clock_hour\");\r\n time_clock_set_minute_image(tc, \"clock_minute\");\r\n time_clock_set_second_image(tc, \"clock_second\");\r\n ```\r\n\r\n > 完整示例请参考:[time_clock demo](\r\n https://github.com/zlgopen/awtk-c-demos/blob/master/demos/time_clock.c)\r\n \r\n time\\_clock一般不需要设置style。\r\n \r\n",
"name": "time_clock_t",
"parent": "widget_t",
"annotation": {
Expand Down Expand Up @@ -27949,7 +27949,7 @@
}
],
"header": "widgets/label.h",
"desc": "\r\n 文本控件。用于显示一行或多行文本。\r\n\r\n 文本控件不会根据文本的长度自动换行,只有文本内容包含换行符时才会换行。\r\n\r\n 如需自动换行请使用[rich\\_text\\_t](rich_text_t.md)控件。\r\n\r\n label\\_t是[widget\\_t](widget_t.md)的子类控件,widget\\_t的函数均适用于label\\_t控件。\r\n\r\n 在xml中使用\"label\"标签创建文本控件。如:\r\n\r\n ```xml\r\n <label style=\"center\" text=\"center\"/>\r\n ```\r\n\r\n > 更多用法请参考:\r\n [label.xml](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/label.xml)\r\n\r\n 在c代码中使用函数label\\_create创建文本控件。如:\r\n\r\n ```c\r\n widget_t* label = label_create(win, 10, 10, 128, 30);\r\n widget_set_text(label, L\"hello awtk!\");\r\n ```\r\n\r\n > 创建之后,需要用widget\\_set\\_text或widget\\_set\\_text\\_utf8设置文本内容。\r\n\r\n > 完整示例请参考:\r\n [label demo](https://github.com/zlgopen/awtk-c-demos/blob/master/demos/label.c)\r\n\r\n 可用通过style来设置控件的显示风格,如字体的大小和颜色等等。如:\r\n\r\n ```xml\r\n <style name=\"left\">\r\n <normal text_color=\"red\" text_align_h=\"left\" border_color=\"#a0a0a0\" margin=\"4\" />\r\n </style>\r\n ```\r\n\r\n > 更多用法请参考:\r\n [theme\r\n default](https://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L144)\r\n\r\n",
"desc": "\r\n 文本控件。用于显示一行或多行文本。\r\n\r\n 文本控件不会根据文本的长度自动换行,只有文本内容包含换行符时才会换行。\r\n\r\n 如需自动换行请使用[rich\\_text\\_t](rich_text_t.md)控件。\r\n\r\n label\\_t是[widget\\_t](widget_t.md)的子类控件,widget\\_t的函数均适用于label\\_t控件。\r\n\r\n 在xml中使用\"label\"标签创建文本控件。如:\r\n\r\n ```xml\r\n <label style=\"center\" text=\"center\"/>\r\n ```\r\n\r\n > 更多用法请参考:[label.xml](\r\nhttps://github.com/zlgopen/awtk/blob/master/demos/assets/raw/ui/label.xml)\r\n\r\n 在c代码中使用函数label\\_create创建文本控件。如:\r\n\r\n ```c\r\n widget_t* label = label_create(win, 10, 10, 128, 30);\r\n widget_set_text(label, L\"hello awtk!\");\r\n ```\r\n\r\n > 创建之后,需要用widget\\_set\\_text或widget\\_set\\_text\\_utf8设置文本内容。\r\n\r\n > 完整示例请参考:[label demo](\r\nhttps://github.com/zlgopen/awtk-c-demos/blob/master/demos/label.c)\r\n\r\n 可用通过style来设置控件的显示风格,如字体的大小和颜色等等。如:\r\n\r\n ```xml\r\n <style name=\"left\">\r\n <normal text_color=\"red\" text_align_h=\"left\" border_color=\"#a0a0a0\" margin=\"4\" />\r\n </style>\r\n ```\r\n\r\n > 更多用法请参考:\r\n [theme default](\r\nhttps://github.com/zlgopen/awtk/blob/master/demos/assets/raw/styles/default.xml#L144)\r\n\r\n",
"name": "label_t",
"parent": "widget_t",
"annotation": {
Expand Down

0 comments on commit 9ce664c

Please sign in to comment.