update docs

zlgopen · Oct 19, 2019 · 086e1ae · 086e1ae
1 parent 164844a
commit 086e1ae
Show file tree

Hide file tree

Showing 362 changed files with 3,992 additions and 2,170 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -29,6 +29,7 @@
 * [AWTK输入事件处理流程](input_event_flow.md)
 * [内存耗尽处理流程](out_of_memory.md)
 * [如何开启按键音](how_to_enable_key_touch_sound.md)
+* [实时切换主题](theme_switch.md)
 
 ### 2.HowTos
 * [AWTK 调试技巧](debug_tips.md)

diff --git a/docs/assets_dir_changed.md b/docs/assets_dir_changed.md
@@ -0,0 +1,39 @@
+# 资源目录变更通知
+
+为了支持多个主题在运行时实时切换，我们对目录结构做了一些调整： 在资源目录下增加主题子目录。
+
+如：
+
+* 旧的目录结果如下：
+
+```
+assets
+  inc
+  raw
+```
+
+* 新的目录结果如下：
+
+```
+assets
+  default
+    inc
+    raw
+```
+
+资源更新脚本也需要做相应改动：
+
+旧的 scripts/update\_res.py
+
+```
+common.init(AWTK_ROOT, ASSETS_ROOT, ASSET_C);
+common.updateRes()
+```
+
+新的 scripts/update\_res.py
+
+```
+common.init(AWTK_ROOT, ASSETS_ROOT, 'default', ASSET_C);
+common.updateRes()
+```
+
diff --git a/docs/changes.md b/docs/changes.md
@@ -1,7 +1,12 @@
 # 最新动态
 
+* 2019/10/19
+  * 完善主题切换功能。
+  * 增加文档[资源目录变更通知](docs/assets_dir_changed.md)
+  * 增加文档[主题实时切换](docs/theme_switch.md)
+
 * 2019/10/18
-  * 增加动态切换主题的功能(实验阶段)。
+  * 增加主题切换功能。
 
 * 2019/10/17
   * 修改文档中的错误（感谢俊杰提供补丁）。

diff --git a/docs/manual/arg_desc_flags_t.md b/docs/manual/arg_desc_flags_t.md
@@ -1,6 +1,7 @@
 ## arg\_desc\_flags\_t
 ### 概述
  参数描述范围常量定义。
+
 ### 常量
 <p id="arg_desc_flags_t_consts">
 

diff --git a/docs/manual/asset_data_type_t.md b/docs/manual/asset_data_type_t.md
@@ -1,6 +1,7 @@
 ## asset\_data\_type\_t
 ### 概述
  数据资源类型定义。
+
 ### 常量
 <p id="asset_data_type_t_consts">
 

diff --git a/docs/manual/asset_font_type_t.md b/docs/manual/asset_font_type_t.md
@@ -1,6 +1,7 @@
 ## asset\_font\_type\_t
 ### 概述
  字体资源类型定义。
+
 ### 常量
 <p id="asset_font_type_t_consts">
 

diff --git a/docs/manual/asset_image_type_t.md b/docs/manual/asset_image_type_t.md
@@ -1,6 +1,7 @@
 ## asset\_image\_type\_t
 ### 概述
  图片资源类型定义。
+
 ### 常量
 <p id="asset_image_type_t_consts">
 

diff --git a/docs/manual/asset_info_t.md b/docs/manual/asset_info_t.md
@@ -2,6 +2,7 @@
 ### 概述
  单个资源的描述信息。
 
+
 ----------------------------------
 ### 属性
 <p id="asset_info_t_properties">
@@ -19,6 +20,7 @@
 > <p id="asset_info_t_is_in_rom"> 资源是否在ROM中。
 
 
+
 * 类型：uint8\_t
 
 | 特性 | 是否支持 |
@@ -31,6 +33,7 @@
 > <p id="asset_info_t_name"> 名称。
 
 
+
 * 类型：char*
 
 | 特性 | 是否支持 |
@@ -44,6 +47,7 @@
  is\_in\_rom == FALSE时才有效。
 
 
+
 * 类型：uint32\_t
 
 | 特性 | 是否支持 |
@@ -56,6 +60,7 @@
 > <p id="asset_info_t_size"> 大小。
 
 
+
 * 类型：uint32\_t
 
 | 特性 | 是否支持 |
@@ -68,6 +73,7 @@
 > <p id="asset_info_t_subtype"> 子类型。
 
 
+
 * 类型：uint8\_t
 
 | 特性 | 是否支持 |
@@ -80,6 +86,7 @@
 > <p id="asset_info_t_type"> 类型。
 
 
+
 * 类型：uint16\_t
 
 | 特性 | 是否支持 |

diff --git a/docs/manual/asset_script_type_t.md b/docs/manual/asset_script_type_t.md
@@ -1,6 +1,7 @@
 ## asset\_script\_type\_t
 ### 概述
  脚本资源类型定义。
+
 ### 常量
 <p id="asset_script_type_t_consts">
 

diff --git a/docs/manual/asset_type_t.md b/docs/manual/asset_type_t.md
@@ -1,6 +1,7 @@
 ## asset\_type\_t
 ### 概述
  资源类型常量定义。
+
 ### 常量
 <p id="asset_type_t_consts">
 

diff --git a/docs/manual/asset_ui_type_t.md b/docs/manual/asset_ui_type_t.md
@@ -1,6 +1,7 @@
 ## asset\_ui\_type\_t
 ### 概述
  UI资源类型定义。
+
 ### 常量
 <p id="asset_ui_type_t_consts">
 

diff --git a/docs/manual/assets_manager_t.md b/docs/manual/assets_manager_t.md
@@ -31,6 +31,7 @@
  ```
 
 
+
 ----------------------------------
 ### 函数
 <p id="assets_manager_t_methods">
@@ -39,6 +40,7 @@
 | -------- | ------------ | 
 | <a href="#assets_manager_t_assets_manager">assets\_manager</a> | 获取缺省资源管理器。 |
 | <a href="#assets_manager_t_assets_manager_add">assets\_manager\_add</a> | 向资源管理器中增加一个资源。 |
+| <a href="#assets_manager_t_assets_manager_clear_all">assets\_manager\_clear\_all</a> | 清除全部缓存的资源。 |
 | <a href="#assets_manager_t_assets_manager_clear_cache">assets\_manager\_clear\_cache</a> | 清除指定类型的缓存。 |
 | <a href="#assets_manager_t_assets_manager_create">assets\_manager\_create</a> | 创建资源管理器。 |
 | <a href="#assets_manager_t_assets_manager_deinit">assets\_manager\_deinit</a> | 释放全部资源。 |
@@ -52,6 +54,7 @@
 | <a href="#assets_manager_t_assets_manager_set_locale_info">assets\_manager\_set\_locale\_info</a> | 设置locale_info对象。 |
 | <a href="#assets_manager_t_assets_manager_set_res_root">assets\_manager\_set\_res\_root</a> | 设置资源所在的目录(其下目录结构请参考demos)。 |
 | <a href="#assets_manager_t_assets_manager_set_system_info">assets\_manager\_set\_system\_info</a> | 设置system_info对象。 |
+| <a href="#assets_manager_t_assets_manager_set_theme">assets\_manager\_set\_theme</a> | 设置当前的主题。 |
 | <a href="#assets_manager_t_assets_manager_unref">assets\_manager\_unref</a> | 释放指定的资源。 |
 #### assets\_manager 函数
 -----------------------
@@ -62,6 +65,7 @@
 
 
 
+
 * 函数原型：
 
 ```
@@ -82,6 +86,7 @@ assets_manager_t* assets_manager ();
 
 
 
+
 * 函数原型：
 
 ```
@@ -95,6 +100,28 @@ ret_t assets_manager_add (assets_manager_t* am, asset_info_t info);
 | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
 | am | assets\_manager\_t* | asset manager对象。 |
 | info | asset\_info\_t | 待增加的资源。 |
+#### assets\_manager\_clear\_all 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="assets_manager_t_assets_manager_clear_all"> 清除全部缓存的资源。
+
+
+
+
+* 函数原型：
+
+```
+ret_t assets_manager_clear_all (assets_manager_t* am);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| am | assets\_manager\_t* | asset manager对象。 |
 #### assets\_manager\_clear\_cache 函数
 -----------------------
 
@@ -104,6 +131,7 @@ ret_t assets_manager_add (assets_manager_t* am, asset_info_t info);
 
 
 
+
 * 函数原型：
 
 ```
@@ -126,6 +154,7 @@ ret_t assets_manager_clear_cache (assets_manager_t* am, asset_type_t type);
 
 
 
+
 * 函数原型：
 
 ```
@@ -147,6 +176,7 @@ assets_manager_t* assets_manager_create (uint32_t init_nr);
 
 
 
+
 * 函数原型：
 
 ```
@@ -168,6 +198,7 @@ ret_t assets_manager_deinit (assets_manager_t* am);
 
 
 
+
 * 函数原型：
 
 ```
@@ -189,6 +220,7 @@ ret_t assets_manager_destroy (assets_manager_t* am);
 
 
 
+
 * 函数原型：
 
 ```
@@ -212,6 +244,7 @@ asset_info_t* assets_manager_find_in_cache (assets_manager_t* am, asset_type_t t
 
 
 
+
 * 函数原型：
 
 ```
@@ -234,6 +267,7 @@ assets_manager_t* assets_manager_init (assets_manager_t* am, uint32_t init_nr);
 
 
 
+
 * 函数原型：
 
 ```
@@ -257,6 +291,7 @@ asset_info_t* assets_manager_load (assets_manager_t* am, asset_type_t type, char
 
 
 
+
 * 函数原型：
 
 ```
@@ -280,6 +315,7 @@ ret_t assets_manager_preload (assets_manager_t* am, asset_type_t type, char* nam
 
 
 
+
 * 函数原型：
 
 ```
@@ -303,6 +339,7 @@ asset_info_t* assets_manager_ref (assets_manager_t* am, asset_type_t type, char*
 
 
 
+
 * 函数原型：
 
 ```
@@ -324,6 +361,7 @@ ret_t assets_manager_set (assets_manager_t* am);
 
 
 
+
 * 函数原型：
 
 ```
@@ -346,6 +384,7 @@ ret_t assets_manager_set_locale_info (assets_manager_t* am, locale_info_t* local
 
 
 
+
 * 函数原型：
 
 ```
@@ -368,6 +407,7 @@ ret_t assets_manager_set_res_root (assets_manager_t* am, const char* res_root);
 
 
 
+
 * 函数原型：
 
 ```
@@ -381,6 +421,30 @@ ret_t assets_manager_set_system_info (assets_manager_t* am, system_info_t* syste
 | 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
 | am | assets\_manager\_t* | asset manager对象。 |
 | system\_info | system\_info\_t* | system\_info对象。。 |
+#### assets\_manager\_set\_theme 函数
+-----------------------
+
+* 函数功能：
+
+> <p id="assets_manager_t_assets_manager_set_theme"> 设置当前的主题。
+
+
+
+
+
+* 函数原型：
+
+```
+ret_t assets_manager_set_theme (assets_manager_t* am, const char* theme);
+```
+
+* 参数说明：
+
+| 参数 | 类型 | 说明 |
+| -------- | ----- | --------- |
+| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
+| am | assets\_manager\_t* | asset manager对象。 |
+| theme | const char* | 主题名称。 |
 #### assets\_manager\_unref 函数
 -----------------------
 
@@ -390,6 +454,7 @@ ret_t assets_manager_set_system_info (assets_manager_t* am, system_info_t* syste
 
 
 
+
 * 函数原型：
 
 ```

diff --git a/docs/manual/bitmap_flag_t.md b/docs/manual/bitmap_flag_t.md
@@ -1,6 +1,7 @@
 ## bitmap\_flag\_t
 ### 概述
  位图标志常量定义。
+
 ### 常量
 <p id="bitmap_flag_t_consts">