update docs and idl

2024-11-29 18:48:09 +08:00 · 2019-11-26 01:08:01 -08:00 · 2019-11-26 01:08:01 -08:00 · a6a985bb1a
commit a6a985bb1a
parent d2e7ae5f5c
21 changed files with 2161 additions and 784 deletions
--- a/docs/manual/dialog_quit_code_t.md
+++ b/docs/manual/dialog_quit_code_t.md
@ -0,0 +1,15 @@
+## dialog\_quit\_code\_t
+### 概述
+对话框退出码。
+> 一般用作dialog_quit函数的参数。
+### 常量
+<p id="dialog_quit_code_t_consts">
+
+| 名称 | 说明 | 
+| -------- | ------- | 
+| DIALOG\_QUIT\_NONE | 对话框被强行关闭或不关心关闭原因。 |
+| DIALOG\_QUIT\_OK | 点击“OK”按钮关闭。 |
+| DIALOG\_QUIT\_YES | 点击“YES”按钮关闭。 |
+| DIALOG\_QUIT\_CANCEL | 点击“CANCEL”按钮关闭。 |
+| DIALOG\_QUIT\_NO | 点击“NO”按钮关闭。 |
+| DIALOG\_QUIT\_OTHER | 点击其它按钮关闭。 |
--- a/docs/manual/dialog_t.md
+++ b/docs/manual/dialog_t.md
@ -352,7 +352,7 @@ ret_t dialog_quit (widget_t* widget, uint32_t code);
 | -------- | ----- | --------- |
 | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
 | widget | widget\_t* | dialog对象。 |
-| code | uint32\_t | 退出码，作为dialog\_modal的返回值。 |
+| code | uint32\_t | 退出码，作为dialog\_modal的返回值(参考：[dialog\_quit\_code\_t](dialog\_quit\_code\_t.md))。 |
 #### dialog\_set\_title 函数
 -----------------------

--- a/docs/manual/edit_t.md
+++ b/docs/manual/edit_t.md
@ -61,6 +61,7 @@ default](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/st
 | <a href="#edit_t_edit_set_int">edit\_set\_int</a> | 设置int类型的值。 |
 | <a href="#edit_t_edit_set_int_limit">edit\_set\_int\_limit</a> | 设置为整数输入及取值范围。 |
 | <a href="#edit_t_edit_set_is_valid_char">edit\_set\_is\_valid\_char</a> | 设置输入字符检查函数。 |
+| <a href="#edit_t_edit_set_open_im_when_focused">edit\_set\_open\_im\_when\_focused</a> | 设置编辑器是否在获得焦点时打开输入法。 |
 | <a href="#edit_t_edit_set_password_visible">edit\_set\_password\_visible</a> | 当编辑器输入类型为密码时，设置密码是否可见。 |
 | <a href="#edit_t_edit_set_readonly">edit\_set\_readonly</a> | 设置编辑器是否为只读。 |
 | <a href="#edit_t_edit_set_select_none_when_focused">edit\_set\_select\_none\_when\_focused</a> | 设置编辑器是否在获得焦点时不选中文本。 |
@ -76,6 +77,7 @@ default](https://github.com/zlgopen/awtk/blob/master/demos/assets/default/raw/st
 | <a href="#edit_t_left_margin">left\_margin</a> | uint8\_t | 左边距。 |
 | <a href="#edit_t_max">max</a> | double | 最大值或最大长度。 |
 | <a href="#edit_t_min">min</a> | double | 最小值或最小长度。 |
+| <a href="#edit_t_open_im_when_focused">open\_im\_when\_focused</a> | bool\_t | 获得焦点时打开输入法。 |
 | <a href="#edit_t_password_visible">password\_visible</a> | bool\_t | 密码是否可见。 |
 | <a href="#edit_t_readonly">readonly</a> | bool\_t | 编辑器是否为只读。 |
 | <a href="#edit_t_right_margin">right\_margin</a> | uint8\_t | 右边距。 |
@ -389,6 +391,27 @@ ret_t edit_set_is_valid_char (widget_t* widget, edit_is_valid_char_t is_valid_ch
 | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
 | widget | widget\_t* | widget对象。 |
 | is\_valid\_char | edit\_is\_valid\_char\_t | 检查输入字符是否有效的回调函数。 |
+#### edit\_set\_open\_im\_when\_focused 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="edit_t_edit_set_open_im_when_focused">设置编辑器是否在获得焦点时打开输入法。
+
+
+* 函数原型：
+
+```
+ret_t edit_set_open_im_when_focused (widget_t* widget, bool_t open_im_when_focused);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| widget | widget\_t* | widget对象。 |
+| open\_im\_when\_focused | bool\_t | 是否在获得焦点时打开输入法。 |
 #### edit\_set\_password\_visible 函数
 -----------------------

@ -560,6 +583,24 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);

 * 类型：double

+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 否 |
+| 可持久化   | 是 |
+| 可脚本化   | 是 |
+| 可在IDE中设置 | 是 |
+| 可在XML中设置 | 是 |
+| 可通过widget\_get\_prop读取 | 是 |
+| 可通过widget\_set\_prop修改 | 是 |
+#### open\_im\_when\_focused 属性
+-----------------------
+> <p id="edit_t_open_im_when_focused">获得焦点时打开输入法。
+> 主要用于没有指针设备的情况，否则每次切换焦点时都打开输入法。
+
+
+* 类型：bool\_t
+
 | 特性 | 是否支持 |
 | -------- | ----- |
 | 可直接读取 | 是 |
--- a/docs/manual/event_base_type_t.md
+++ b/docs/manual/event_base_type_t.md
@ -12,4 +12,5 @@
 | EVT\_ITEMS\_WILL\_CHANGE | 即将增加和删除集合中的项目(event\_t)。 |
 | EVT\_ITEMS\_CHANGED | 完成增加和删除集合中的项目(event\_t)。 |
 | EVT\_PROPS\_CHANGED | 对象的属性改变的事件名(props\_event\_t)。 |
+| EVT\_PROGRESS | 进度状态(progress\_event\_t)。 |
 | EVT\_DESTROY | 对象销毁事件名(event\_t)。 |
--- a/docs/manual/file_receiver_t.md
+++ b/docs/manual/file_receiver_t.md
@ -0,0 +1,78 @@
+## file\_receiver\_t
+### 概述
+文件接收方。
+> 可用注册EVT_PROGRESS事件，以获取传输的进度状态。
+
+----------------------------------
+### 函数
+<p id="file_receiver_t_methods">
+
+| 函数名称 | 说明 | 
+| -------- | ------------ | 
+| <a href="#file_receiver_t_file_receiver_create">file\_receiver\_create</a> | 创建receiver对象。 |
+| <a href="#file_receiver_t_file_receiver_destroy">file\_receiver\_destroy</a> | 销毁receiver对象。 |
+| <a href="#file_receiver_t_file_receiver_run">file\_receiver\_run</a> | 开始传输文件。 |
+#### file\_receiver\_create 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="file_receiver_t_file_receiver_create">创建receiver对象。
+
+
+* 函数原型：
+
+```
+file_receiver_t* file_receiver_create (uint32_t block_size, const char* productid);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | file\_receiver\_t* | 返回receiver对象。 |
+| block\_size | uint32\_t | 一次传输块的大小。 |
+| productid | const char* | 产品名称(有时可用于发送方发送不同的固件，暂时没用)。 |
+#### file\_receiver\_destroy 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="file_receiver_t_file_receiver_destroy">销毁receiver对象。
+
+
+* 函数原型：
+
+```
+ret_t file_receiver_destroy (file_receiver_t* receiver);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| receiver | file\_receiver\_t* | receiver对象。 |
+#### file\_receiver\_run 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="file_receiver_t_file_receiver_run">开始传输文件。
+
+
+* 函数原型：
+
+```
+ret_t file_receiver_run (file_receiver_t* receiver, tk_iostream_t* io, tk_ostream_t* target, const char* filename);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| receiver | file\_receiver\_t* | receiver对象。 |
+| io | tk\_iostream\_t* | 数据传输流。 |
+| target | tk\_ostream\_t* | 用于写入接收到的文件数据。 |
+| filename | const char* | 文件名(期望接收的文件名)。 |
--- a/docs/manual/file_sender_t.md
+++ b/docs/manual/file_sender_t.md
@ -0,0 +1,75 @@
+## file\_sender\_t
+### 概述
+文件发送方。
+> 可用注册EVT_PROGRESS事件，以获取传输的进度状态。
+
+----------------------------------
+### 函数
+<p id="file_sender_t_methods">
+
+| 函数名称 | 说明 | 
+| -------- | ------------ | 
+| <a href="#file_sender_t_file_sender_create">file\_sender\_create</a> | 创建sender对象。 |
+| <a href="#file_sender_t_file_sender_destroy">file\_sender\_destroy</a> | 销毁sender对象。 |
+| <a href="#file_sender_t_file_sender_run">file\_sender\_run</a> | 开始传输文件。 |
+#### file\_sender\_create 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="file_sender_t_file_sender_create">创建sender对象。
+
+
+* 函数原型：
+
+```
+file_sender_t* file_sender_create ();
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | file\_sender\_t* | 返回sender对象。 |
+#### file\_sender\_destroy 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="file_sender_t_file_sender_destroy">销毁sender对象。
+
+
+* 函数原型：
+
+```
+ret_t file_sender_destroy (file_sender_t* sender);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| sender | file\_sender\_t* | sender对象。 |
+#### file\_sender\_run 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="file_sender_t_file_sender_run">开始传输文件。
+
+
+* 函数原型：
+
+```
+ret_t file_sender_run (file_sender_t* sender, tk_iostream_t* io, const char* filename);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| sender | file\_sender\_t* | sender对象。 |
+| io | tk\_iostream\_t* | 数据传输流。 |
+| filename | const char* | 文件名。 |
--- a/docs/manual/file_transfer_ack_t.md
+++ b/docs/manual/file_transfer_ack_t.md
@ -0,0 +1,46 @@
+## file\_transfer\_ack\_t
+### 概述
+确认包(sender<-receiver)。
+
+----------------------------------
+### 属性
+<p id="file_transfer_ack_t_properties">
+
+| 属性名称 | 类型 | 说明 | 
+| -------- | ----- | ------------ | 
+| <a href="#file_transfer_ack_t_offset">offset</a> | uint32\_t | 确认收到的数据偏移量。 |
+| <a href="#file_transfer_ack_t_size">size</a> | uint32\_t | 确认收到的数据长度。 |
+| <a href="#file_transfer_ack_t_type">type</a> | uint32\_t | 包的类型。 |
+#### offset 属性
+-----------------------
+> <p id="file_transfer_ack_t_offset">确认收到的数据偏移量。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### size 属性
+-----------------------
+> <p id="file_transfer_ack_t_size">确认收到的数据长度。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### type 属性
+-----------------------
+> <p id="file_transfer_ack_t_type">包的类型。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
--- a/docs/manual/file_transfer_data_t.md
+++ b/docs/manual/file_transfer_data_t.md
@ -0,0 +1,58 @@
+## file\_transfer\_data\_t
+### 概述
+文件数据包(sender->receiver)。
+
+----------------------------------
+### 属性
+<p id="file_transfer_data_t_properties">
+
+| 属性名称 | 类型 | 说明 | 
+| -------- | ----- | ------------ | 
+| <a href="#file_transfer_data_t_crc">crc</a> | uint32\_t | 本次传输文件数据的CRC。 |
+| <a href="#file_transfer_data_t_offset">offset</a> | uint32\_t | 本次传输文件数据的偏移量。 |
+| <a href="#file_transfer_data_t_size">size</a> | uint32\_t | 本次传输文件数据的长度。 |
+| <a href="#file_transfer_data_t_type">type</a> | uint32\_t | 包的类型。 |
+#### crc 属性
+-----------------------
+> <p id="file_transfer_data_t_crc">本次传输文件数据的CRC。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### offset 属性
+-----------------------
+> <p id="file_transfer_data_t_offset">本次传输文件数据的偏移量。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### size 属性
+-----------------------
+> <p id="file_transfer_data_t_size">本次传输文件数据的长度。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### type 属性
+-----------------------
+> <p id="file_transfer_data_t_type">包的类型。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
--- a/docs/manual/file_transfer_meta_t.md
+++ b/docs/manual/file_transfer_meta_t.md
@ -0,0 +1,46 @@
+## file\_transfer\_meta\_t
+### 概述
+文件元数据包(sender->receiver)。
+
+----------------------------------
+### 属性
+<p id="file_transfer_meta_t_properties">
+
+| 属性名称 | 类型 | 说明 | 
+| -------- | ----- | ------------ | 
+| <a href="#file_transfer_meta_t_name">name</a> | char* | 即将传输文件的名称。 |
+| <a href="#file_transfer_meta_t_size">size</a> | uint32\_t | 即将传输文件的长度。 |
+| <a href="#file_transfer_meta_t_type">type</a> | uint32\_t | 包的类型。 |
+#### name 属性
+-----------------------
+> <p id="file_transfer_meta_t_name">即将传输文件的名称。
+
+
+* 类型：char*
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### size 属性
+-----------------------
+> <p id="file_transfer_meta_t_size">即将传输文件的长度。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### type 属性
+-----------------------
+> <p id="file_transfer_meta_t_type">包的类型。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
--- a/docs/manual/file_transfer_packet_type_t.md
+++ b/docs/manual/file_transfer_packet_type_t.md
@ -0,0 +1,13 @@
+## file\_transfer\_packet\_type\_t
+### 概述
+文件传输包的类型。
+### 常量
+<p id="file_transfer_packet_type_t_consts">
+
+| 名称 | 说明 | 
+| -------- | ------- | 
+| FILE\_TRANSFER\_PACKET\_META | 文件元数据包(sender->receiver)。 |
+| FILE\_TRANSFER\_PACKET\_DATA | 文件数据包(sender->receiver)。 |
+| FILE\_TRANSFER\_PACKET\_ACK | 文件数据确认包(sender<-receiver)。 |
+| FILE\_TRANSFER\_PACKET\_NACK | 文件数据错误确认包(sender<-receiver)。 |
+| FILE\_TRANSFER\_PACKET\_REQ | 请求开始传输包(sender<-receiver)。 |
--- a/docs/manual/file_transfer_req_t.md
+++ b/docs/manual/file_transfer_req_t.md
@ -0,0 +1,58 @@
+## file\_transfer\_req\_t
+### 概述
+请求开始传输包(sender<-receiver)。
+
+----------------------------------
+### 属性
+<p id="file_transfer_req_t_properties">
+
+| 属性名称 | 类型 | 说明 | 
+| -------- | ----- | ------------ | 
+| <a href="#file_transfer_req_t_block_size">block\_size</a> | uint32\_t | 一次传输包的大小。 |
+| <a href="#file_transfer_req_t_filename">filename</a> | char* | 请求传输的文件名。 |
+| <a href="#file_transfer_req_t_productid">productid</a> | char* | 请求方的产品ID(有时可用于发送方发送不同的固件，暂时没用) |
+| <a href="#file_transfer_req_t_type">type</a> | uint32\_t | 包的类型。 |
+#### block\_size 属性
+-----------------------
+> <p id="file_transfer_req_t_block_size">一次传输包的大小。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### filename 属性
+-----------------------
+> <p id="file_transfer_req_t_filename">请求传输的文件名。
+
+
+* 类型：char*
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### productid 属性
+-----------------------
+> <p id="file_transfer_req_t_productid">请求方的产品ID(有时可用于发送方发送不同的固件，暂时没用)
+
+
+* 类型：char*
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
+#### type 属性
+-----------------------
+> <p id="file_transfer_req_t_type">包的类型。
+
+
+* 类型：uint32\_t
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 是 |
--- a/docs/manual/images/progress_event_t_0.png
+++ b/docs/manual/images/progress_event_t_0.png
--- a/docs/manual/lcd_orientation_t.md
+++ b/docs/manual/lcd_orientation_t.md
@ -1,6 +1,6 @@
 ## lcd\_orientation\_t
 ### 概述
-LCD旋转角度(XXX:目前仅支持0度和90度，逆时针方向)。
+LCD旋转角度。
 ### 常量
 <p id="lcd_orientation_t_consts">

--- a/docs/manual/log_level_t.md
+++ b/docs/manual/log_level_t.md
@ -0,0 +1,12 @@
+## log\_level\_t
+### 概述
+LOG的级别。
+### 常量
+<p id="log_level_t_consts">
+
+| 名称 | 说明 | 
+| -------- | ------- | 
+| LOG\_LEVEL\_DEBUG | DEBUG |
+| LOG\_LEVEL\_INFO | INFO |
+| LOG\_LEVEL\_WARN | WARN |
+| LOG\_LEVEL\_ERROR | ERROR |
--- a/docs/manual/log_t.md
+++ b/docs/manual/log_t.md
@ -0,0 +1,151 @@
+## log\_t
+### 概述
+log。
+
+----------------------------------
+### 函数
+<p id="log_t_methods">
+
+| 函数名称 | 说明 | 
+| -------- | ------------ | 
+| <a href="#log_t_log_debug">log\_debug</a> | 输出调试信息。 |
+| <a href="#log_t_log_error">log\_error</a> | 输出错误信息。 |
+| <a href="#log_t_log_get_log_level">log\_get\_log\_level</a> | 获取log的级别。 |
+| <a href="#log_t_log_info">log\_info</a> | 输出参考信息。 |
+| <a href="#log_t_log_set_log_level">log\_set\_log\_level</a> | 设置log的级别。 |
+| <a href="#log_t_log_warn">log\_warn</a> | 输出警告信息。 |
+#### log\_debug 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="log_t_log_debug">输出调试信息。
+> 变参函数。
+```
+log_debug("debug message\n");
+```
+
+
+* 函数原型：
+
+```
+void log_debug (const char* format);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | void | 无返回值。 |
+| format | const char* | 格式或信息。 |
+#### log\_error 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="log_t_log_error">输出错误信息。
+> 变参函数。
+```
+log_error("error message\n");
+```
+
+
+* 函数原型：
+
+```
+void log_error (const char* format);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | void | 无返回值。 |
+| format | const char* | 格式或信息。 |
+#### log\_get\_log\_level 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="log_t_log_get_log_level">获取log的级别。
+
+
+* 函数原型：
+
+```
+log_level_t log_get_log_level ();
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | log\_level\_t | 返回log的级别。 |
+#### log\_info 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="log_t_log_info">输出参考信息。
+> 变参函数。
+```
+log_info("info message\n");
+```
+
+
+* 函数原型：
+
+```
+void log_info (const char* format);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | void | 无返回值。 |
+| format | const char* | 格式或信息。 |
+#### log\_set\_log\_level 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="log_t_log_set_log_level">设置log的级别。
+
+
+* 函数原型：
+
+```
+ret_t log_set_log_level (log_level_t log_level);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| log\_level | log\_level\_t | log的级别。 |
+#### log\_warn 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="log_t_log_warn">输出警告信息。
+> 变参函数。
+```
+log_warn("warn message\n");
+```
+
+
+* 函数原型：
+
+```
+void log_warn (const char* format);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | void | 无返回值。 |
+| format | const char* | 格式或信息。 |
--- a/docs/manual/progress_event_t.md
+++ b/docs/manual/progress_event_t.md
@ -0,0 +1,73 @@
+## progress\_event\_t
+### 概述
+![image](images/progress_event_t_0.png)
+
+进度变化事件。
+
+----------------------------------
+### 函数
+<p id="progress_event_t_methods">
+
+| 函数名称 | 说明 | 
+| -------- | ------------ | 
+| <a href="#progress_event_t_progress_event_cast">progress\_event\_cast</a> | 把event对象转progress_event_t对象，主要给脚本语言使用。 |
+| <a href="#progress_event_t_progress_event_init">progress\_event\_init</a> | 初始progress event。 |
+### 属性
+<p id="progress_event_t_properties">
+
+| 属性名称 | 类型 | 说明 | 
+| -------- | ----- | ------------ | 
+| <a href="#progress_event_t_percent">percent</a> | const char* | 进度百分比。 |
+#### progress\_event\_cast 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="progress_event_t_progress_event_cast">把event对象转progress_event_t对象，主要给脚本语言使用。
+
+
+* 函数原型：
+
+```
+progress_event_t* progress_event_cast (event_t* event);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | progress\_event\_t* | 返回event对象。 |
+| event | event\_t* | event对象。 |
+#### progress\_event\_init 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="progress_event_t_progress_event_init">初始progress event。
+
+
+* 函数原型：
+
+```
+event_t* progress_event_init (progress_event_t* event, uint32_t percent);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | event\_t* | 返回event对象。 |
+| event | progress\_event\_t* | event对象。 |
+| percent | uint32\_t | 进度。 |
+#### percent 属性
+-----------------------
+> <p id="progress_event_t_percent">进度百分比。
+
+
+* 类型：const char*
+
+| 特性 | 是否支持 |
+| -------- | ----- |
+| 可直接读取 | 是 |
+| 可直接修改 | 否 |
+| 可脚本化   | 是 |
--- a/docs/manual/prop_change_event_t.md
+++ b/docs/manual/prop_change_event_t.md
@ -11,6 +11,7 @@
 | 函数名称 | 说明 | 
 | -------- | ------------ | 
 | <a href="#prop_change_event_t_prop_change_event_cast">prop\_change\_event\_cast</a> | 把event对象转prop_change_event_t对象，主要给脚本语言使用。 |
+| <a href="#prop_change_event_t_prop_change_event_init">prop\_change\_event\_init</a> | 初始prop change event。 |
 ### 属性
 <p id="prop_change_event_t_properties">

@ -36,8 +37,29 @@ prop_change_event_t* prop_change_event_cast (event_t* event);

 | 参数 | 类型 | 说明 |
 | -------- | ----- | --------- |
-| 返回值 | prop\_change\_event\_t* | 对象。 |
+| 返回值 | prop\_change\_event\_t* | 返回event对象。 |
 | event | event\_t* | event对象。 |
+#### prop\_change\_event\_init 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="prop_change_event_t_prop_change_event_init">初始prop change event。
+
+
+* 函数原型：
+
+```
+event_t* prop_change_event_init (prop_change_event_t* event, uint32_t percent);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | event\_t* | 返回event对象。 |
+| event | prop\_change\_event\_t* | event对象。 |
+| percent | uint32\_t | 进度。 |
 #### name 属性
 -----------------------
 > <p id="prop_change_event_t_name">属性的名称。
--- a/docs/manual/str_t.md
+++ b/docs/manual/str_t.md
@ -19,6 +19,7 @@ str_reset(&s);
 | -------- | ------------ | 
 | <a href="#str_t_str_append">str\_append</a> | 追加字符串。 |
 | <a href="#str_t_str_append_char">str\_append\_char</a> | 追加一个字符。 |
+| <a href="#str_t_str_append_int">str\_append\_int</a> | 追加一个整数。 |
 | <a href="#str_t_str_append_with_len">str\_append\_with\_len</a> | 追加字符串。 |
 | <a href="#str_t_str_clear">str\_clear</a> | 清除字符串内容。 |
 | <a href="#str_t_str_decode_xml_entity">str\_decode\_xml\_entity</a> | 对XML基本的entity进行解码，目前仅支持&lt;&gt;&quota;&amp;。 |
@ -99,6 +100,27 @@ ret_t str_append_char (str_t* str, char c);
 | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
 | str | str\_t* | str对象。 |
 | c | char | 要追加的字符。 |
+#### str\_append\_int 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="str_t_str_append_int">追加一个整数。
+
+
+* 函数原型：
+
+```
+ret_t str_append_int (str_t* str, int32_t value);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| str | str\_t* | str对象。 |
+| value | int32\_t | 要追加的整数。 |
 #### str\_append\_with\_len 函数
 -----------------------

--- a/docs/manual/widget_prop_t.md
+++ b/docs/manual/widget_prop_t.md
@ -68,6 +68,7 @@
 | WIDGET\_PROP\_LOOP | 是否循环播放或循环播放的次数。 |
 | WIDGET\_PROP\_AUTO\_FIX | 是否启用自动更正功能。 |
 | WIDGET\_PROP\_SELECT\_NONE\_WHEN\_FOCUSED | 编辑器在获得焦点时是否不选中文本。 |
+| WIDGET\_PROP\_OPEN\_IM\_WHEN\_FOCUSED | 编辑器在获得焦点时是否打开输入法。 |
 | WIDGET\_PROP\_X\_MIN | X最小值。 |
 | WIDGET\_PROP\_X\_MAX | X最大值。 |
 | WIDGET\_PROP\_Y\_MIN | Y最小值。 |
--- a/docs/manual/window_manager_t.md
+++ b/docs/manual/window_manager_t.md
@ -50,6 +50,7 @@ widget_t* window_manager ();
 * 函数功能：

 > <p id="window_manager_t_window_manager_back">请求关闭顶层窗口。
+> 如果顶层窗口时模态对话框，用DIALOG\_QUIT\_NONE调用dialog\_quit。


 * 函数原型：
@ -70,7 +71,7 @@ ret_t window_manager_back (widget_t* widget);
 * 函数功能：

 > <p id="window_manager_t_window_manager_back_to_home">回到主窗口，关闭之上的全部窗口。
-> 由于dialog通常需要用户确认，顶层窗口为dialog时调用会失败。
+> 如果顶层窗口时模态对话框，用DIALOG\_QUIT\_NONE调用dialog\_quit。


 * 函数原型：
--- a/tools/idl_gen/idl.json
+++ b/tools/idl_gen/idl.json