update docs

This commit is contained in:
xianjimli 2020-06-26 17:45:03 +08:00
parent 852e45f0fc
commit 9b4d674d3a
52 changed files with 143 additions and 94 deletions

View File

@ -157,6 +157,7 @@
![input\_method\_overview](images/input_method_overview.png)
* [input\_type](manual/input_type_t.md) 输入类型(用于控制软键盘和输入格式)
* [input\_method](manual/input_method_t.md) 输入法接口。
* [input\_method\_default](manual/input_method_default_t.md) 输入法缺省实现。
* [input\_method\_sdl](manual/input_method_sdl_t.md) 输入法SDL实现。

View File

@ -1,6 +1,7 @@
## MIME\_TYPE
### 概述
MIME_TYPE。### 常量
MIME_TYPE。
### 常量
<p id="MIME_TYPE_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## align\_h\_t
### 概述
水平对齐的常量定义。### 常量
水平对齐的常量定义。
### 常量
<p id="align_h_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## align\_v\_t
### 概述
垂直对齐的常量定义。### 常量
垂直对齐的常量定义。
### 常量
<p id="align_v_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## app\_type\_t
### 概述
应用程序类型。### 常量
应用程序类型。
### 常量
<p id="app_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## arg\_desc\_flags\_t
### 概述
参数描述范围常量定义。### 常量
参数描述范围常量定义。
### 常量
<p id="arg_desc_flags_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## asset\_data\_type\_t
### 概述
数据资源类型定义。### 常量
数据资源类型定义。
### 常量
<p id="asset_data_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## asset\_font\_type\_t
### 概述
字体资源类型定义。### 常量
字体资源类型定义。
### 常量
<p id="asset_font_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## asset\_image\_type\_t
### 概述
图片资源类型定义。### 常量
图片资源类型定义。
### 常量
<p id="asset_image_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## asset\_script\_type\_t
### 概述
脚本资源类型定义。### 常量
脚本资源类型定义。
### 常量
<p id="asset_script_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## asset\_type\_t
### 概述
资源类型常量定义。### 常量
资源类型常量定义。
### 常量
<p id="asset_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## asset\_ui\_type\_t
### 概述
UI资源类型定义。### 常量
UI资源类型定义。
### 常量
<p id="asset_ui_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## bitmap\_flag\_t
### 概述
位图标志常量定义。### 常量
位图标志常量定义。
### 常量
<p id="bitmap_flag_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## bitmap\_format\_t
### 概述
位图格式常量定义。### 常量
位图格式常量定义。
### 常量
<p id="bitmap_format_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## border\_type\_t
### 概述
控件边框类型。### 常量
控件边框类型。
### 常量
<p id="border_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## clip\_board\_data\_type\_t
### 概述
剪切板数据类型定义。### 常量
剪切板数据类型定义。
### 常量
<p id="clip_board_data_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## conf\_node\_type\_t
### 概述
节点类型。### 常量
节点类型。
### 常量
<p id="conf_node_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## conf\_node\_value\_t
### 概述
节点值得类型。### 常量
节点值得类型。
### 常量
<p id="conf_node_value_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## data\_discard\_policy\_t
### 概述
缓存不够时丢弃数据的策略。### 常量
缓存不够时丢弃数据的策略。
### 常量
<p id="data_discard_policy_t_consts">
| 名称 | 说明 |

View File

@ -1,7 +1,8 @@
## dialog\_highlighter\_type\_t
### 概述
@type string
内置的对话框高亮策略。### 常量
内置的对话框高亮策略。
### 常量
<p id="dialog_highlighter_type_t_consts">
| 名称 | 说明 |

View File

@ -2,7 +2,8 @@
### 概述
对话框退出码。
> 一般用作dialog_quit函数的参数。### 常量
> 一般用作dialog_quit函数的参数。
### 常量
<p id="dialog_quit_code_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## easing\_type\_t
### 概述
缓动作动画常量定义。### 常量
缓动作动画常量定义。
### 常量
<p id="easing_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## event\_type\_t
### 概述
类型常量定义。### 常量
类型常量定义。
### 常量
<p id="event_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## glyph\_format\_t
### 概述
字模格式常量定义。### 常量
字模格式常量定义。
### 常量
<p id="glyph_format_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## icon\_at\_type\_t
### 概述
图标所在的位置。### 常量
图标所在的位置。
### 常量
<p id="icon_at_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## image\_draw\_type\_t
### 概述
图片绘制方法常量定义。### 常量
图片绘制方法常量定义。
### 常量
<p id="image_draw_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## indicator\_default\_paint\_t
### 概述
指示器默认绘制的类型。### 常量
指示器默认绘制的类型。
### 常量
<p id="indicator_default_paint_t_consts">
| 名称 | 说明 |

View File

@ -1,22 +1,23 @@
## input\_type\_t
### 概述
输入类型常量定义。### 常量
输入类型常量定义。
### 常量
<p id="input_type_t_consts">
| 名称 | 说明 |
| -------- | ------- |
| INPUT\_TEXT | 文本。 |
| INPUT\_INT | 整数。 |
| INPUT\_UINT | 非负整数。 |
| INPUT\_HEX | 16进制整数。 |
| INPUT\_FLOAT | 浮点数。 |
| INPUT\_UFLOAT | 非负浮点数。 |
| INPUT\_EMAIL | 邮件地址。 |
| INPUT\_PASSWORD | 密码。 |
| INPUT\_PHONE | 电话号码。 |
| INPUT\_IPV4 | IP Addr V4。如192.168.1.1 |
| INPUT\_DATE | 日期。如2020/02/20。 |
| INPUT\_TIME | 时间(时分)。如12:00。 |
| INPUT\_TIME\_FULL | 时间(时分秒)。如12:00:00。 |
| INPUT\_CUSTOM | 使用自定义的软键盘(如计算器等应用不希望弹出系统软键盘)。 |
| INPUT\_CUSTOM\_PASSWORD | 使用自定义的密码软键盘。 |
| INPUT\_TEXT | 文本。字符串属性值text |
| INPUT\_INT | 整数。字符串属性值int |
| INPUT\_UINT | 非负整数。字符串属性值uint |
| INPUT\_HEX | 16进制整数。字符串属性值hex |
| INPUT\_FLOAT | 浮点数。字符串属性值float |
| INPUT\_UFLOAT | 非负浮点数。字符串属性值ufloat |
| INPUT\_EMAIL | 邮件地址。字符串属性值email |
| INPUT\_PASSWORD | 密码。字符串属性值password |
| INPUT\_PHONE | 电话号码。字符串属性值phone |
| INPUT\_IPV4 | IP Addr V4(如192.168.1.1)。字符串属性值ipv4 |
| INPUT\_DATE | 日期(如2020/02/20)。字符串属性值date |
| INPUT\_TIME | 时间(时分12:00)。字符串属性值time |
| INPUT\_TIME\_FULL | 时间(时分秒12:00:00)。字符串属性值time\_full |
| INPUT\_CUSTOM | 使用自定义的软键盘(如计算器等应用不希望弹出系统软键盘)。字符串属性值custom |
| INPUT\_CUSTOM\_PASSWORD | 使用自定义的密码软键盘。字符串属性值custom\_password |

View File

@ -1,6 +1,7 @@
## key\_code\_t
### 概述
key code。### 常量
key code。
### 常量
<p id="key_code_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## lcd\_draw\_mode\_t
### 概述
LCD绘制模式常量定义。### 常量
LCD绘制模式常量定义。
### 常量
<p id="lcd_draw_mode_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## lcd\_orientation\_t
### 概述
LCD旋转角度。### 常量
LCD旋转角度。
### 常量
<p id="lcd_orientation_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## lcd\_type\_t
### 概述
LCD类型常量定义。### 常量
LCD类型常量定义。
### 常量
<p id="lcd_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## log\_level\_t
### 概述
LOG的级别。### 常量
LOG的级别。
### 常量
<p id="log_level_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## object\_cmd\_t
### 概述
对象常见命令定义### 常量
对象常见命令定义
### 常量
<p id="object_cmd_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## prop\_desc\_flags\_t
### 概述
属性描述范围常量定义。### 常量
属性描述范围常量定义。
### 常量
<p id="prop_desc_flags_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## ret\_t
### 概述
函数返回值常量定义。### 常量
函数返回值常量定义。
### 常量
<p id="ret_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## style\_id\_t
### 概述
style常量定义。### 常量
style常量定义。
### 常量
<p id="style_id_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## value\_desc\_type\_t
### 概述
属性描述类型常量定义。### 常量
属性描述类型常量定义。
### 常量
<p id="value_desc_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## value\_format\_type\_t
### 概述
属性描述格式常量定义。### 常量
属性描述格式常量定义。
### 常量
<p id="value_format_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## value\_type\_t
### 概述
类型常量定义。### 常量
类型常量定义。
### 常量
<p id="value_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## vgcanvas\_line\_cap\_t
### 概述
线帽类型。### 常量
线帽类型。
### 常量
<p id="vgcanvas_line_cap_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## vgcanvas\_line\_join\_t
### 概述
线条连接类型。### 常量
线条连接类型。
### 常量
<p id="vgcanvas_line_join_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## widget\_cursor\_t
### 概述
控件鼠标光标常量定义。### 常量
控件鼠标光标常量定义。
### 常量
<p id="widget_cursor_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## widget\_prop\_t
### 概述
控件的属性。### 常量
控件的属性。
### 常量
<p id="widget_prop_t_consts">
| 名称 | 说明 |

View File

@ -2,7 +2,8 @@
### 概述
控件状态常量定义。
这里指定常用的状态值,扩展控件可以在自己的头文件中定义私有的状态。### 常量
这里指定常用的状态值,扩展控件可以在自己的头文件中定义私有的状态。
### 常量
<p id="widget_state_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## widget\_type\_t
### 概述
控件的类型。### 常量
控件的类型。
### 常量
<p id="widget_type_t_consts">
| 名称 | 说明 |

View File

@ -1,7 +1,8 @@
## window\_animator\_type\_t
### 概述
@type string
内置窗口动画常量定义。### 常量
内置窗口动画常量定义。
### 常量
<p id="window_animator_type_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## window\_closable\_t
### 概述
窗口的closable常量定义。### 常量
窗口的closable常量定义。
### 常量
<p id="window_closable_t_consts">
| 名称 | 说明 |

View File

@ -1,6 +1,7 @@
## window\_stage\_t
### 概述
窗口的生命周期常量定义。### 常量
窗口的生命周期常量定义。
### 常量
<p id="window_stage_t_consts">
| 名称 | 说明 |

View File

@ -40,77 +40,77 @@ typedef ret_t (*input_method_destroy_t)(input_method_t* im);
typedef enum _input_type_t {
/**
* @const INPUT_TEXT
*
* text
*/
INPUT_TEXT = 0,
/**
* @const INPUT_INT
*
* int
*/
INPUT_INT,
/**
* @const INPUT_UINT
*
* uint
*/
INPUT_UINT,
/**
* @const INPUT_HEX
* 16
* 16hex
*/
INPUT_HEX,
/**
* @const INPUT_FLOAT
*
* float
*/
INPUT_FLOAT,
/**
* @const INPUT_UFLOAT
*
* ufloat
*/
INPUT_UFLOAT,
/**
* @const INPUT_EMAIL
*
* email
*/
INPUT_EMAIL,
/**
* @const INPUT_PASSWORD
*
* password
*/
INPUT_PASSWORD,
/**
* @const INPUT_PHONE
*
* phone
*/
INPUT_PHONE,
/**
* @const INPUT_IPV4
* IP Addr V4192.168.1.1
* IP Addr V4(192.168.1.1)ipv4
*/
INPUT_IPV4,
/**
* @const INPUT_DATE
* 2020/02/20
* (2020/02/20)date
*/
INPUT_DATE,
/**
* @const INPUT_TIME
* ()12:00
* (12:00)time
*/
INPUT_TIME,
/**
* @const INPUT_TIME_FULL
* ()12:00:00
* (12:00:00)time_full
*/
INPUT_TIME_FULL,
/**
* @const INPUT_CUSTOM
* 使()
* 使()custom
*/
INPUT_CUSTOM,
/**
* @const INPUT_CUSTOM_PASSWORD
* 使
* 使custom_password
*/
INPUT_CUSTOM_PASSWORD
} input_type_t;

View File

@ -334,7 +334,7 @@ class ApiGenerator {
let result = '';
if (cls.consts && cls.consts.length) {
result += `### 常量\n`
result += `\n### 常量\n`
result += genAnchor(cls.name, {
name: 'consts'
}) + '\n\n';

View File

@ -7325,63 +7325,63 @@
"desc": "输入类型常量定义。",
"consts": [
{
"desc": "文本。",
"desc": "文本。字符串属性值text",
"name": "INPUT_TEXT"
},
{
"desc": "整数。",
"desc": "整数。字符串属性值int",
"name": "INPUT_INT"
},
{
"desc": "非负整数。",
"desc": "非负整数。字符串属性值uint",
"name": "INPUT_UINT"
},
{
"desc": "16进制整数。",
"desc": "16进制整数。字符串属性值hex",
"name": "INPUT_HEX"
},
{
"desc": "浮点数。",
"desc": "浮点数。字符串属性值float",
"name": "INPUT_FLOAT"
},
{
"desc": "非负浮点数。",
"desc": "非负浮点数。字符串属性值ufloat",
"name": "INPUT_UFLOAT"
},
{
"desc": "邮件地址。",
"desc": "邮件地址。字符串属性值email",
"name": "INPUT_EMAIL"
},
{
"desc": "密码。",
"desc": "密码。字符串属性值password",
"name": "INPUT_PASSWORD"
},
{
"desc": "电话号码。",
"desc": "电话号码。字符串属性值phone",
"name": "INPUT_PHONE"
},
{
"desc": "IP Addr V4。如192.168.1.1",
"desc": "IP Addr V4(如192.168.1.1)。字符串属性值ipv4",
"name": "INPUT_IPV4"
},
{
"desc": "日期。如2020/02/20。",
"desc": "日期(如2020/02/20)。字符串属性值date",
"name": "INPUT_DATE"
},
{
"desc": "时间(时分)。如12:00。",
"desc": "时间(时分12:00)。字符串属性值time",
"name": "INPUT_TIME"
},
{
"desc": "时间(时分秒)。如12:00:00。",
"desc": "时间(时分秒12:00:00)。字符串属性值time_full",
"name": "INPUT_TIME_FULL"
},
{
"desc": "使用自定义的软键盘(如计算器等应用不希望弹出系统软键盘)。",
"desc": "使用自定义的软键盘(如计算器等应用不希望弹出系统软键盘)。字符串属性值custom",
"name": "INPUT_CUSTOM"
},
{
"desc": "使用自定义的密码软键盘。",
"desc": "使用自定义的密码软键盘。字符串属性值custom_password",
"name": "INPUT_CUSTOM_PASSWORD"
}
],