awtk/docs/README.md

# 文档
### 0. 参考手册

* [参考手册](manual.md)
* [参考手册 (chm)](https://github.com/zlgopen/awtk-docs/tree/master/AWTK-API%E6%89%8B%E5%86%8C)
* [开发实践](https://github.com/zlgopen/awtk-docs/blob/master/AWTK%E5%BC%80%E5%8F%91%E5%AE%9E%E8%B7%B5)

### 1. 使用文档
* [避坑指南](trap_list.md)
* [AWTK 控件的布局参数介绍](layout.md)
* [AWTK 界面描述文件介绍](ui_desc.md)
* [AWTK 中的图片显示方式](image_draw_type.md)
* [AWTK 中的矢量图绘图函数](vgcanvas.md)
* [AWTK 中的事件处理函数](event_listener.md)
* [AWTK 中的国际化之字符串翻译](locale.md)
* [AWTK 中的窗体样式](theme.md)
* [AWTK 中的 system\_bar 使用方法](system_bar.md)
* [AWTK 中的资源管理器](assets_manager.md)
* [AWTK 中的窗口动画](window_animator.md)
* [AWTK 中的控件动画](widget_animator.md)
* [LCD 旋转（横屏与竖屏）](lcd_rotation.md)
* [AWTK 中的输入法](input_method.md)
* [AWTK 硬件资源需求评估](hardware_req.md)
* [AWTK 中的一些惯例](conventions.md)
* [对话框高亮策略](dialog_highlight.md)
* [控件焦点相关问题](widget_focus.md)
* [AWTK 中的颜色格式](color_format.md)
* [AWTK 输入事件处理流程](input_event_flow.md)
* [内存耗尽处理流程](out_of_memory.md)
* [实时切换主题](theme_switch.md)
* [键值映射](map_key.md)
* [应用程序的入口函数](awtk_main.md)
* [资源打包](assets_zip.md)
* [LCD 密度与图片的对应关系](../design/default/images/README.md)
* [slide_view/pages 各个页面缺省的焦点控件](pages_slide_view_default_focused_child_for_each_page.md)
* [输入事件记录与重放](event_recorder_player.md)
* [API 注释格式](api_doc.md)
* [自定义控件规范](custom_widget_rules.md)
* [动态库与静态库](shared_static.md)
* [窗口之间如何通信](https://github.com/zlgopen/awtk-inter-win-communication)
* [为 512K Flash 优化空间](how_to_optimize_for_512K_flash.md)
* [如何绘制旋转文字](how_to_draw_rotate_text.md)
* [如何修改 Windows 下应用程序的图标](how_set_app_icon.md)
* [项目描述文件 project.json 介绍](awtk_project_description_file.md)
* [利用 app_helper 编写 SConstruct](app_helper_usage.md)
* [自定义控件支持脚本绑定](binding_custom_widget.md)
* [编写跨平台的代码](cross_platform_programming.md)
* [应用程序的类型](app_type.md)
* [如何引用第三方库](how_to_use_3rd_libs.md)
* [在 windows 下使用 gcc 编译 AWTK](mingw.md)
* [AWTK 中的字符串编码](text_encoding.md)

### 2.HowTos
* [AWTK 调试技巧](debug_tips.md)
* [AWTK 优化技巧](optimation.md)
* [如何使用离线画布](how_to_use_canvas_offline.md)
* [如何加入中文输入法](chinese_ime.md) 
* [如何在 Visual Studio 中调试 AWTK](vs_debug.md)
* [如何在非 GUI 线程操作 GUI 控件](how_to_non_gui_thread_operate_widget.md)
* [如何启用鼠标指针](how_to_enable_mouse_cursor.md)
* [如何启用屏保](screen_saver.md)
* [如何设置字体的全局缩放比例](how_to_scale_font.md)
* [如何实现"back"键和"home"键](how_to_impl_back_and_home_key.md)
* [如何实现自定义的软键盘](how_to_impl_custom_soft_keyboard.md)
* [如何编译 Windows 32 位版本](how_to_build_windows_32bit_version.md)
* [如何支持单色 LCD](how_to_support_mono_lcd.md)
* [如何使用 mutable_image 控件](how_to_use_mutable_image.md)
* [如何让文本滚动起来](how_to_scroll_you_text.md)
* [如何在窗体样式文件中写控件布局参数](how_to_write_layout_params_in_style.md)
* [如何开启按键音](how_to_enable_key_touch_sound.md)
* [如何更新拼音输入法数据](how_to_update_gpinyin_data.md)
* [如何用 valgrind 查找内存相关问题](how_to_use_valgrind_detect_memory_bugs.md)
* [如何定制 combo_box 控件中按钮的风格和大小](how_to_customize_combo_boxox_button.md)
* [如何访问控件的属性](how_to_access_widget_props.md)
* [如何集成第三方库](how_to_use_3rd_libs.md)
* [如何使用对话框](how_to_use_dialog.md)
* [如何使用软键盘上的 action 按钮](how_to_use_action_text.md)
* [如何存取应用程序的配置信息](how_to_use_app_conf.md)
* [如何实现弹出菜单](how_to_impl_popup_menu.md)
* [如何用 edit 控件编辑日期](how_to_edit_date.md)
* [如何用 edit 控件编辑时间](how_to_edit_time.md)
* [如何用 edit 控件编辑 IP 地址](how_to_edit_ip_addr.md)
* [如何支持 unicode bidirectional algorithm](how_to_enable_bidi.md)
* [如何续期使用 AWTK Designer](how_to_renewal_awtk_designer.md)
* [如何将生成的可执行文件和资源打包](how_to_release_app.md)
* [如何使用多点触控手势算法](how_to_use_multi_gesture.md)
* [如何隐藏滚动条的上下按钮](how_to_hide_up_down_button_of_scrollbar.md)
* [如何使用 packed 图](how_to_use_packed_image.md)
* [如何根据实际分辨率自动调整窗口中子控件的位置大小](how_to_auto_scale_children.md)
* [如何修改 stb\_truetype 获取字模时申请的缓冲区大小](how_to_modify_stb_truetype_buffer_size.md)
* [如何让内存管理器支持管理多块不连续的内存](how_to_support_multi_mem_block.md)
* [如何使用keil的AC6工具链编译](how_to_build_with_keil_ac6.md)
* [如何支持极简键盘 (3 键键盘、5 键键盘和旋转按钮）](how_to_support_5keys_3keys.md)
* [如何在改变控件属性时附带动画](how_to_change_prop_with_animation.md)
* [LCD快速旋转](how_to_use_fast_lcd_portrait.md)
* [如何显示上下文菜单（俗称右键菜单）](how_to_show_context_menu.md)
* [如何启用编辑器的上下文菜单](how_to_enable_edit_context_menu.md)
* [如何设置下拉选择框 (combo box) 弹出窗口/列表项的样式](how_to_set_style_of_combo_box_item.md)
* [如何支持软键盘按钮预览](how_to_enable_keyboard_preview.md)
* [如何设置自定义键值](how_to_set_custom_keys.md)
* [如何自定义资源加载方式](how_to_set_custom_load_asset.md)
* [如何处理将文件拖入到窗口的事件](how_to_handle_drop_file_event.md)
* [如何将资源编译到应用程序并使用它们](how_to_compile_res_into_app_and_use_them.md)
* [如何为不同语言加载不同的字体文件](how_to_load_font_for_specific_language.md)
* [如何为指定的键设置长按时间](how_to_set_key_long_press_time.md)
* [如何使用 CMake 构建 AWTK 应用](how_to_use_cmake_to_build_awtk_app.md)
  
### 3. 内部原理
* [AWTK 脚本绑定原理](script_binding.md)
* [AWTK 内存分配器](mem_alloactor.md)
* [优化 freetype 解析矢量字体的显示效果](optimation_freetype_gray_font.md)
* [优化 stb\_truetype 在 mono 模式下的字体显示效果](optimation_stb_truetype_mono_font.md)

### 4. 移植文档
* [嵌入式平台移植注意事项](porting_common.md)
* [将 AWTK 移植到 STM32f103ze 裸系统](porting_to_stm32f103ze.md)
* [将 AWTK 移植到 STM32f429igtx 裸系统](porting_to_stm32f429igtx.md)
* [将 AWTK 移植到 AWorksOS 平台](porting_to_awtk_aworks_rt1052.md)
* [将 AWTK 移植到 TencentOS 平台](https://github.com/zlgopen/awtk-stm32f103ze-tencentos/blob/master/docs/tos-port.md)
* [将 AWTK 移植到 RT-Thread 平台](https://github.com/zlgopen/awtk-stm32f103ze-rtthread/blob/master/docs/rtt-port.md)
* [将 AWTK 移植到 LPC1867 裸系统（推荐）](https://github.com/zlgopen/awtk-lpc1768-raw/blob/master/docs/lpc1768_port.md)
* [将 AWTK 移植到 STM32H743(TencentOS) 平台（推荐）](https://github.com/zlgopen/awtk-stm32h743iitx-tencentos/blob/master/docs/stm32h743iitx_port.md)

### 5. 技术笔记
* [LCD 接口的几种实现方式](lcd.md)
* [FrameBuffer 的几种使用方式](framebuffer.md)

### 6. 其它
* [常见问题解答](faq.md)
* [修改 AWTK 的代码风格](code_style.md)
* [AWTK 是如何保证代码质量的](qa.md)

### 7. 第三方文档

* [AWTK 编译与调试 环境搭建指南](https://github.com/hk-mars/Blog-Article/blob/master/IoT/AWTK%20%E7%BC%96%E8%AF%91%E4%B8%8E%E8%B0%83%E8%AF%95%20%E7%8E%AF%E5%A2%83%E6%90%AD%E5%BB%BA%E6%8C%87%E5%8D%97.md)