devbox
我家小花儿
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Qt的Assistant制作自定义的软件帮助界面(记录)_qt assistant 自定义

作者：我家小花儿 | 2024-02-19 13:45:29

赞

踩

qt assistant 自定义

      首先，需要编写好需要展示的html文档，作为Assistant显示的帮助文档，未提高效率，选择用VSCode配合Live server插件，编写html文档。（VSCode配合Live Server真好用~_~）

                                    

目录结构如下所示：

 CSS目录中存放html文件的css样式，Documents存放html文档，pictures存放html中引用的图片：

book1.html

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     <title>Document</title>
  8.     <link rel="stylesheet" href="../CSS/book1.css">
  9. </head>
  10. <body>
  11.     <div class="outer">
  12.         <div class="header-area">
  13.             <div class="picture-area">
  14.                 <img src="../pictures/book1.jpg" alt="">
  15.             </div>
  16.             <div class="book-name">
  17.                 <p>红岩</p>
  18.             </div>
  19.         </div>
  20.         <div class="info-table">
  21.             <table border="1" cellspacing="3" cellpading="5">
  22.                 <caption>书籍.红岩</caption>
  23.                 <thead>
  24.                     <tr align="center" valign="center">
  25.                         <th>书名</th>
  26.                         <th>作者</th>
  27.                         <th>出版时间</th>
  28.                         <th>价格</th>
  29.                         <th>好评度</th>
  30.                     </tr>
  31.                 </thead>
  32.                <tbody>
  33.                    <tr align="center" valign="center">
  34.                         <td>Hongyan</td>
  35.                         <td>Lisan</td>
  36.                         <td>1994.6.6</td>
  37.                         <td>￥10</td>
  38.                         <td>90%</td>
  39.                    </tr>
  40.                    <tr align="center" valign="center">
  41.                         <td>红岩</td>
  42.                         <td>张三</td>
  43.                         <td>1994年</td>
  44.                         <td>$6</td>
  45.                         <td>94%</td>
  46.                    </tr>
  47.                </tbody>
  48.             </table>
  49.         </div>
  50.         <div class="summary-area">
  51.             <p>
  52.                 文字是人类用符号记录表达信息以传之久远的方式和工具。现代文字大多是记录语言的工具。
  53.                 人类往往先有口头的语言后产生书面文字，很多小语种，有语言但没有文字。文字的不同体现了国家和民族的书面表达的方式和思维不同。
  54.                 文字使人类进入有历史记录的文明社会。
  55.             </p>
  56.         </div>
  57.     </div>
  58. </body>
  59. </html>

 简单的样式book1.css

  1. div.summary-area
  2. {
  3.     width: 40%;
  4.     height: 120px;
  5.     background-color: antiquewhite;
  6.     align-content: center;
  7. }
  8.  
  9. div.summary-area p
  10. {
  11.     font-size: 15px;
  12. }
  13.  
  14. div.outer
  15. {
  16.     width: 65%;
  17.     margin-top: 40px;
  18. }
  19.  
  20. div.header-area
  21. {
  22.     margin-left: 35px;
  23.     line-height: 65px;
  24.     display: flex;
  25. }
  26.  
  27. div.book-name
  28. {
  29.     vertical-align: center;
  30.     line-height: 65px;
  31. }
  32.  
  33. div.book-name p 
  34. {
  35.     font-weight: bold;
  36.     font-size: 20px;
  37. }
  38.  
  39. div.info-table table
  40. {
  41.     margin-left: 25px;
  42. }
  43.

           按照重复的样式新建5个相同的html文件，后期为突出目录结构使用，同时，新建一个简单的index.html作为首页使用:

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7.     <title>首页</title>
  8.     <link rel="stylesheet" href="../CSS/index.css">
  9. </head>
  10. <body>
  11.     <div class="outer">
  12.         <div class="img-area">
  13.             <img src="../pictures/index.jpg" alt="">
  14.         </div>
  15.  
  16.         <div class="text-area">
  17.             <p>Welcome to the homepage</p>
  18.         </div>
  19.     </div>
  20. </body>
  21. </html>

index.css样式文件：

  1. div.img-area img
  2. {
  3.     height: 150px;
  4.     width: 165px;
  5.     margin-left: 26px;
  6. }
  7.  
  8. div.outer
  9. {
  10.     margin-top: 30px;
  11.     margin-left: 50px;
  12. }
  13.  
  14. div.text-area
  15. {
  16.     margin-top: 10px;
  17.     height: 40px;
  18. }
  19.  
  20. div.text-area p
  21. {
  22.     line-height: 40px;
  23.     font-weight: bold;
  24. }

在编写好基本的html文件之后，需要进行Qt Assistant的相关文件的编写。

其中需要编写两个重要的文件，分别是.qhp文件以及.qhcp文件，分别介绍这两个文件的作用：

1. qhp文件，qhp指Qt Help Project的缩写，格式为xml格式（注意在编写xml文件的时候，一定要保持文件的格式正确），其主要的作用是负责组织Assistant中       需要用到的文档(即前面编写的html文件)，其格式如下所示：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <QtHelpProject version="1.0">
  3. 	<namespace>ApplicationHelp</namespace>
  4. 	<virtualFolder>doc</virtualFolder>
  5. 	<filterSection>
  6. 		<toc>
  7. 			<section title="Simple Application Help" ref="Documents/index.html">
  8. 				<section title="第一章 介绍">
  9. 					<section title="Book1 Detail" ref="Documents/book1.html"/>
  10. 					<section title="Book2 Detail" ref="Documents/book2.html"/>
  11. 				</section>
  12. 				<section title="第二章 书籍">
  13. 					<section title="Book3 Apply" ref="Documents/book3.html"/>
  14. 					<section title="book4 Apply" ref="Documents/book4.html"/>
  15. 				</section>
  16. 				<section title="第三章 应用">
  17. 					<section title="Book5" ref="Documents/book5.html"/>
  18. 					<section title="Book4" ref="Documents/book4.html"/>
  19. 				</section>
  20. 			</section>
  21. 		</toc>
  22. 		<keywords>
  23. 			<keyword name="index" ref="Documents/index.html"/>
  24. 			<keyword name="book1" ref="Documents/book1.html"/>
  25. 			<keyword name="book2" ref="Documents/book2.html"/>
  26. 			<keyword name="book3" ref="Documents/book3.html"/>
  27. 			<keyword name="book4" ref="Documents/book4.html"/>
  28. 			<keyword name="book5" ref="Documents/book5.html"/>
  29. 		</keywords>
  30. 		<files>
  31. 			<file>Documents/*.html</file>
  32. 			<file>CSS/*.css</file>
  33. 			<file>pictures/*.jpg</file>
  34. 		</files>
  35. 	</filterSection>
  36. </QtHelpProject>
  37.  
  38.

（1）encoding指编码，如果需要使用中文，需指定为GB2312，如果只有英文，可指定为UTF-8格式的编码。

（2）namespace指qhp文件的命名空间，qhp文件的命名空间必须是唯一的，这个命名空间在Assistant中会作为页面URL的第一部分。

（3）virtualFolder指定虚拟文件夹，此文件夹并不需要创建，只用来区分文件。

（4）filterSection指过滤器。过滤器部分包含了所有的目录，索引和文件列表，可以通过设置过滤器属性，实现在Assistant中指定文档是否显示。

（5）toc指 table of contents,表示目录表，在toc中创建了所有文档的目录，标题，以及文档对应的路径。

（6）keywords用于指定所有搜索的关键字以及指定的文件。在Assistant中进行搜索的时候，会显示相应的页面。

（7）files中包含了Assistant需要引用的所有的文件，图片，可使用通配符来表示。

在编写好qhp文件之后，需要对qhp文件转化为qch文件，才能被Assistant识别。qch是指Qt Compressed Help，为二进制格式的文件，是Assistant能够识别的最小单元。可通过命令

 qhelpgenerator src.qhp -o dest.qch

来生成qch文件，在生成qch文件之后，需要进行注册才能够在Assistant中进行文档的浏览。注册的方法有两种：

第一种：命令行方法 assistant -register dest.qch来进行注册。

第二种：在Assistant中，编辑-->首选项-->文档标签页-->添加/移除

通过上述方法，已经能够在Assistant中显示已经注册的文档。

如果需要在Assistant中仅仅显示我们自己编写的文档，则需要进行一些定制化的操作。

如果需要定制客户化的Assistant,则需要编写qhcp文件，qhcp指Qt help collect project的缩写，文件的格式是xml文档，起主要作用是将二进制文件qch组织成一个collect.

qhcp文件的格式如下所示：

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <QHelpCollectionProject version="1.0">
  3. 	<assistant>
  4. 		<title>Application Help</title>
  5. 		<startPage>qthelp://ApplicationHelp/doc/Documents/index.html</startPage>
  6. 		<homePage>qthelp://ApplicationHelp/doc/Documents/index.html</homePage>
  7. 		<applicationIcon>pictures/icon.jpg</applicationIcon>
  8. 		<enableFilterFunctionality>false</enableFilterFunctionality>
  9. 		<enableDocumentationManager>false</enableDocumentationManager>
  10. 		<enableAddressBar visible="true">true</enableAddressBar>
  11. 		<cacheDirectory>cache/data</cacheDirectory>
  12. 		<aboutMenuText>
  13. 			<text>About</text>
  14. 		</aboutMenuText>
  15. 		<aboutDialog>
  16. 			<file>Documents/about.txt</file>
  17. 			<icon>pictures/about.jpg</icon>
  18. 		</aboutDialog>
  19. 	</assistant>
  20. 	<docFiles>
  21. 		<generate>
  22. 			<file>
  23. 				<input>ApplicationInst.qhp</input>
  24. 				<output>ApplicationInst.qch</output>
  25. 			</file>
  26. 		</generate>
  27. 		<register>
  28. 			<file>ApplicationInst.qch</file>
  29. 		</register>
  30. 	</docFiles>
  31. </QHelpCollectionProject>
  32.

(1)assistant标签中的内容是对Assistant进行一些定制化的操作，包括外观与功能，如标题，图标，缓存目录，主页，起始页，about菜单文本/对话框内容/图标。

(2)cacheDirectory表示缓存目录，在Assistant中进行全文检索时会将缓存文件放在指定的缓存目录中。

(3) startPage/homePage分别是设置Assistant的起始页和home页，这里用到Assistant页面的URL，URL的构成格式为:

qthelp://namespace(qhp文件中指定的)/doc(qhp文件中指定的虚拟文件夹)/*html

（4）Assistant可以添加或者删除文档来为多个应用程序提供帮助文档，主要依赖靠文档管理器document mamager,地址栏adress bar, 过滤器filter functionality来实现，这些功能暂时用不到，因此先关闭。

（5）About用于设置跟“关于”菜单以及对话框相关的内容，包括菜单文本，帮助对话框显示内容，图标等信息。

（6）docFiles完成文件的转换以及注册功能。

编写好qhcp文件之后，通过qcollectgenerator将qhcp文件转化为qhc文件，qhcp文件也为二进制文件，在启动assistant的时候，需要指定当前的qch文件，实现文档的注册。

在Qt中通过代码方式调用Assistant:

  1. void ICMainWindow::slotShowInstructionBook()
  2. {
  3. 	// 此处自定义一个说明文档，借助Qt中的assistant
  4. 	if (!m_processor)
  5. 	{
  6. 		m_processor = new QProcess();
  7. 	}
  8.  
  9. #ifdef WIN32
  10. 	// windows版本
  11. 	QString appDir = QCoreApplication::applicationDirPath();
  12. 	appDir.replace("\\", "/");
  13. 	appDir = appDir.left(appDir.indexOf("x64/Debug"));
  14. 	appDir = appDir.endsWith("/") ? appDir : appDir.append("/");
  15.  
  16. 	QString cmd = appDir + "QtApp/qcollectiongenerator.exe";
  17.  
  18. 	QStringList args;
  19. 	args << appDir + "doc/ApplicationInst.qhcp";
  20.  
  21. 	if (m_processor->state() == QProcess::Running)
  22. 	{
  23. 		m_processor->waitForFinished();
  24. 	}
  25.  
  26. 	m_processor->start(cmd, args);
  27. 	m_processor->waitForFinished();
  28.  
  29. 	QString cmdAssistant = appDir + "QtApp/assistant.exe";
  30. 	args.clear();
  31.  
  32. 	QString docPath = appDir + "doc/ApplicationInst.qhc";
  33. 	QFile docfile(docPath);
  34. 	if (!docfile.exists())
  35. 		return;
  36.  
  37. 	QString url("qthelp://ApplicationHelp/doc/Documents/index.html");
  38.  
  39. 	args << "-enableRemoteControl"; 
  40. 	args << "-collectionFile";
  41. 	args << docPath;
  42. 	args << "-showUrl";
  43. 	args << url;
  44. 	//args << "-hide" << "search";
  45. 	//args << "-hide" << "bookmarks";
  46.  
  47. 	if (m_processor->state() == QProcess::Running)
  48. 	{
  49. 		QMessageBox::warning(this, tr("Warning"), tr("The Process is running, please wait for finished"));
  50. 		return;
  51. 	}
  52.  
  53. 	m_processor->start(cmdAssistant, args);
  54. 	
  55. 	if (!m_processor->waitForStarted(5000))
  56. 	{
  57. 		return;
  58. 	}
  59. 	
  60. #elif
  61. 	// linux版本
  62. #endif
  63. 	
  64. }

调用效果如下所示：

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/我家小花儿/article/detail/115038
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号