Qt帮助系统

Qt帮助系统

sf2gis@163.com

2015年1月30日

 

1 简要帮助：what’s this？

目标：在部件上显示简要的帮助信息文件。

原理：Qt的Widget包含一个属性whatsThis，可以显示指定的内容。

方法：

1.1 设置帮助信息

1)   编程指定帮助信息：setWhatsThis()。

2)   设计时指定帮助信息：在部件上右击-》改变 这是什么-》添加指定信息。

1.2 显示帮助信息

1)   shift+F1:部件获取焦点，shift+F1显示。

2)   帮助按钮显示帮助信息：

在菜单和工具栏上添加显示简要帮助按钮：QWhatsThis

    QAction*pAction = QWhatsThis::createAction (this);

   ui->mainToolBar->addAction(pAction);

   ui->menuBar->addAction(pAction);

点击后鼠标显示帮助图标：

点击部件显示帮助

1.3 QWhatsThis

目标：控制简要信息。

方法：全部使用静态方法。

生成QAction，用于显示帮助按钮:

    QAction*pAction = QWhatsThis::createAction (this);

2 系统帮助:Qt Help System

目标：程序中直接调用的帮助程序。帮助类似chm，可以显示文档结构、搜索、索引、书签等。

原理：

帮助功能：使用QAssistant程序，向其传递一个xml的关于帮助中所有属性的设置文档作为参数，来初始化程序的功能和外观。

帮助内容：使用qch文件来定义，也是一个xml，其中包含所有要显示的内容及对内容的相关使用参数设置。

方法：

2.1 设置帮助内容:QtHelp Project

原理：Qt的帮助内容通过QtHelpProject设置帮助程序中的内容（toc）和索引（keywords）。通过后缀为qhp的xml文件指定。

方法：

1)   生成帮助源数据：默认支持html文件，其它类型文件将调用外部程序打开。建议使用word文档编辑（里面可以加入任意类型的文件），然后生成html文件。

2)   生成帮助组织文件qhp：先copy帮助QtHelp中Qt Help Project示例文件，再进行编辑。

3)   生成二进制帮助文件qch：qt compressed help，二进制形式，所有帮助文件的压缩格式。使用qhelpgenerator生成。发布程序时可以使用此种类型文件。

格式：qhelpgeneratorqhp文件 –o qch文件

qhelpgeneratorhelp.qhp -o help.qch

4)   注册帮助文件&#