在探讨Qt帮助框架之前,我们先了解一下Qt帮助文档,可以让大家更好的理解。
当你使用Qt时,你可能会发现Qt帮助文档是一个非常有用的资源。Qt帮助文档提供了关于Qt框架和其各种组件的详细信息,包括类和函数的文档、示例代码和教程等。本节简单介绍Qt助手。
Qt Assistant(Qt 助手)
Qt Assistant是一个帮助文档查看器,它是Qt框架的一部分,可以帮助开发人员更好地了解Qt框架和其各种组件。
首先我们来看一下Qt 助手(独立的那个):
Qt 助手界面与常见的网页浏览器功能非常类似,以下只介绍两个主要部分:
- 主菜单
菜单 | 说明 |
---|---|
文件 | 新建标签页、关闭标签页、页面设置以及打印等。 |
编辑 | 在当前打开页面复制文本或查找文本,以及Qt助手自身的首选项编辑。 |
查看 | 文档页面显示的放大缩小,显示各个功能窗口(内容、索引、书签、搜索、打开页列表)或工具栏(过滤器工具栏、地址工具栏、书签工具栏)。 |
前往 | 类似网页浏览器的主页、前进、后退,有区别的是同步目录菜单项,如果通过索引或搜索查找打开的帮助页,不知道该页面位于哪个目录树里和目录路径,可以点击同步目录,定位该帮助页在目录树里的路径。 |
书签 | 添加打开的页面到书签菜单栏或书签工具栏,管理书签等。 |
帮助 | 关于Qt助手版本信息。 |
- 导航窗口
子窗口 | 说明 |
---|---|
内容 | 显示Qt帮助文档的目录树,每一个文档树的根对应一个qch文件(Qt Compressed Help file),对于本教程安装的Qt开发环境,这些qch文件位于“Qt安装目录\Docs\Qt-5.15.2”文件夹里,这个文件夹不仅有一堆 *.qch 文件,还有一堆子文件夹,子文件夹名字与qch文件名字是对应的,子文件夹保存qch文件的快速索引数据。 |
索引 | qch文件里每篇帮助页都有快速索引,索引的内容一般有帮助页标题、Qt模块名、类名/名字空间、成员变量/属性、成员函数、枚举类型、宏定义等等,通过输入索引关键词,就可以快速找到相关的文档页面。这些快速索引数据保存位置就是刚才讲的“Qt安装目录\Docs\Qt-5.15.2”的子文件里。 |
书签 | 可以按快捷键Ctrl+D,保存当前页为书签,书签保存位置分两类,一类是在书签菜单栏的菜单项显示,另一类是在书签工具栏里显示。可以右击菜单栏或工具栏空白处,在右键菜单选择显示书签工具栏。 |
搜索 | 这个是对所有Qt文档页面进行全文搜索,对于快速索引找不到的关键词,可以在全文检索子窗口里查找。 |
Qt助手就介绍到这,查找你想知道的类、模块等,自己搜索即可,不做赘述了~