Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xianjimli committed Jan 2, 2019
1 parent 3c26c50 commit 68b6ad1
Show file tree
Hide file tree
Showing 37 changed files with 262 additions and 261 deletions.
1 change: 1 addition & 0 deletions docs/changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* 2019/01/02
* 整理API文档:input\_method/input\_method\_default/input\_method\_sdl/input\_method\_null
* 整理API文档:input\_engine/input\_engine\_pinyin/input\_engine\_null
* 更新stm32相关工程。

* 2018/12/31
* 整理API文档:ui\_loader/ui\_builder/ui\_xml\_writer/ui\_binary\_writer/ui\_builder\_default
Expand Down
4 changes: 2 additions & 2 deletions docs/manual/button_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,5 +152,5 @@ ret_t button_set_repeat (widget_t* widget, int32_t repeat);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
4 changes: 2 additions & 2 deletions docs/manual/check_button_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,5 +133,5 @@ ret_t check_button_set_value (widget_t* widget, bool_t value);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
4 changes: 2 additions & 2 deletions docs/manual/color_picker_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,5 @@ ret_t color_picker_set_color (widget_t* widget, const char* color);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
8 changes: 4 additions & 4 deletions docs/manual/color_tile_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,8 @@ ret_t color_tile_set_value (widget_t* widget, color_t color);
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget\_get\_prop读取 | 是 |
| 支通过widget\_set\_prop修改 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
#### border\_color 属性
-----------------------
> <p id="color_tile_t_border_color"> 边框颜色。
Expand All @@ -188,5 +188,5 @@ ret_t color_tile_set_value (widget_t* widget, color_t color);
| 可脚本化 | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget\_get\_prop读取 | 是 |
| 支通过widget\_set\_prop修改 | 是 |
| 可通过widget\_get\_prop读取 | 是 |
| 可通过widget\_set\_prop修改 | 是 |
8 changes: 4 additions & 4 deletions docs/manual/combo_box_item_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,8 @@ ret_t combo_box_item_set_value (widget_t* widget, int32_t value);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### value 属性
-----------------------
> <p id="combo_box_item_t_value"> 值。
Expand All @@ -151,5 +151,5 @@ ret_t combo_box_item_set_value (widget_t* widget, int32_t value);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
16 changes: 8 additions & 8 deletions docs/manual/combo_box_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,8 +362,8 @@ ret_t combo_box_set_selected_index (widget_t* widget, uint32_t index);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### options 属性
-----------------------
> <p id="combo_box_t_options"> 设置可选项(冒号分隔值和文本,分号分隔选项,如:1:red;2:green;3:blue)。
Expand All @@ -379,8 +379,8 @@ ret_t combo_box_set_selected_index (widget_t* widget, uint32_t index);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### selected\_index 属性
-----------------------
> <p id="combo_box_t_selected_index"> 当前选中的选项。
Expand All @@ -396,8 +396,8 @@ ret_t combo_box_set_selected_index (widget_t* widget, uint32_t index);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### value 属性
-----------------------
> <p id="combo_box_t_value"> 值。
Expand All @@ -413,5 +413,5 @@ ret_t combo_box_set_selected_index (widget_t* widget, uint32_t index);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
4 changes: 2 additions & 2 deletions docs/manual/digit_clock_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,5 +118,5 @@ ret_t digit_clock_set_format (widget_t* widget, const char* format);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
16 changes: 8 additions & 8 deletions docs/manual/dragger_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ widget_t* dragger_set_range (widget_t* widget, xy_t x_min, xy_t y_min, xy_t x_ma
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### x\_min 属性
-----------------------
> <p id="dragger_t_x_min"> x坐标的最小值。
Expand All @@ -123,8 +123,8 @@ widget_t* dragger_set_range (widget_t* widget, xy_t x_min, xy_t y_min, xy_t x_ma
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### y\_max 属性
-----------------------
> <p id="dragger_t_y_max"> y坐标的最大值。
Expand All @@ -140,8 +140,8 @@ widget_t* dragger_set_range (widget_t* widget, xy_t x_min, xy_t y_min, xy_t x_ma
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### y\_min 属性
-----------------------
> <p id="dragger_t_y_min"> y坐标的最小值。
Expand All @@ -157,5 +157,5 @@ widget_t* dragger_set_range (widget_t* widget, xy_t x_min, xy_t y_min, xy_t x_ma
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
48 changes: 24 additions & 24 deletions docs/manual/edit_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -425,8 +425,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### bottom\_margin 属性
-----------------------
> <p id="edit_t_bottom_margin"> 下边距。
Expand All @@ -442,8 +442,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### input\_type 属性
-----------------------
> <p id="edit_t_input_type"> 输入类型。
Expand All @@ -459,8 +459,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可持久化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### left\_margin 属性
-----------------------
> <p id="edit_t_left_margin"> 左边距。
Expand All @@ -476,8 +476,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### max 属性
-----------------------
> <p id="edit_t_max"> 最大值或最大长度。
Expand All @@ -492,8 +492,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可持久化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### min 属性
-----------------------
> <p id="edit_t_min"> 最小值或最小长度。
Expand All @@ -508,8 +508,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可持久化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### password\_visible 属性
-----------------------
> <p id="edit_t_password_visible"> 密码是否可见。
Expand All @@ -525,8 +525,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### readonly 属性
-----------------------
> <p id="edit_t_readonly"> 编辑器是否为只读。
Expand All @@ -542,8 +542,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### right\_margin 属性
-----------------------
> <p id="edit_t_right_margin"> 右边距。
Expand All @@ -559,8 +559,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### step 属性
-----------------------
> <p id="edit_t_step"> 步长。
Expand All @@ -576,8 +576,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可持久化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### tips 属性
-----------------------
> <p id="edit_t_tips"> 输入提示。
Expand All @@ -593,8 +593,8 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### top\_margin 属性
-----------------------
> <p id="edit_t_top_margin"> 上边距。
Expand All @@ -610,5 +610,5 @@ ret_t edit_set_text_limit (widget_t* widget, uint32_t min, uint32_t max);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
8 changes: 4 additions & 4 deletions docs/manual/guage_pointer_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### image 属性
-----------------------
> <p id="guage_pointer_t_image"> 指针图片。图片须垂直向上,图片的中心点为旋转方向。
Expand All @@ -141,5 +141,5 @@ ret_t guage_pointer_set_image (widget_t* widget, const char* image);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
8 changes: 4 additions & 4 deletions docs/manual/guage_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ ret_t guage_set_image (widget_t* widget, char* name);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### image 属性
-----------------------
> <p id="guage_t_image"> 背景图片。
Expand All @@ -141,5 +141,5 @@ ret_t guage_set_image (widget_t* widget, char* name);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
24 changes: 12 additions & 12 deletions docs/manual/image_animation_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,8 +286,8 @@ ret_t image_animation_stop (widget_t* widget);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### delay 属性
-----------------------
> <p id="image_animation_t_delay"> 自动播放时延迟播放的时间(毫秒)。
Expand All @@ -303,8 +303,8 @@ ret_t image_animation_stop (widget_t* widget);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### image 属性
-----------------------
> <p id="image_animation_t_image"> 图片名称的前缀。
Expand All @@ -320,8 +320,8 @@ ret_t image_animation_stop (widget_t* widget);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### interval 属性
-----------------------
> <p id="image_animation_t_interval"> 每张图片播放的时间(毫秒)。
Expand All @@ -337,8 +337,8 @@ ret_t image_animation_stop (widget_t* widget);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### loop 属性
-----------------------
> <p id="image_animation_t_loop"> 是否循环播放。
Expand All @@ -354,8 +354,8 @@ ret_t image_animation_stop (widget_t* widget);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
#### sequence 属性
-----------------------
> <p id="image_animation_t_sequence"> 播放的序列,字符可选值为:0-9,a-z,A-Z。
Expand All @@ -371,5 +371,5 @@ ret_t image_animation_stop (widget_t* widget);
| 可脚本化 ||
| 可在IDE中设置 ||
| 可在XML中设置 ||
| 支通过widget\_get\_prop读取 ||
| 支通过widget\_set\_prop修改 ||
| 可通过widget\_get\_prop读取 ||
| 可通过widget\_set\_prop修改 ||
Loading

0 comments on commit 68b6ad1

Please sign in to comment.