## 5.2 使用 Qt Assistant 獲取在線文檔與幫助 ### 5.2.1 簡介 對于大多數復雜的程序來說，在線文檔和幫助是必不可少的。 Qt 通過 Qt 助手－一個 幫助文件和文檔的在線閱讀器，來滿足這一需求。 簡單的說，Qt Assistant 就是瀏覽 Qt 參考文檔的工具，它具有強大的查詢和索引功能，使用時能夠比 Web 瀏覽器更加快速和容 易。而且它可定制，并且可隨用戶自己的應用程序一起發布，從而形成用戶自己的幫助系 統。 開發人員可以將 Qt Assistant 部署為自有應用程序和文檔集的幫助瀏覽器。使用 QAssistantClient 類，可以集成 Qt Assistant。Qt Assistant 使用 QTextEdit 來顯示 Qt 的 HTML 參考文檔；如有必要，開發人員也可以使用此類來直接實現自己的幫助瀏覽 器。QTextEdit 支持 HTML 4.0 的子集，它與 Qt 提供的富文本（RichText）類一起使用 時，也可以用來顯示其他格式的文檔。 ### 5.2.2 Qt 的參考文檔 Qt 的參考文檔包括大約 3,100 頁 HTML 文檔，描述 了 Qt 的所有類和工具，并概述 了 Qt 編程的各個方面，所以對于任何一名 Qt 開發人員來說，它都是一個基本工具。 通常 任何一本 Qt 書籍都不能完全覆蓋到 Qt 中所有的類和函數，同時也無法提供全部的細節。 所以如果想盡可能的從 Qt 獲益，那么就應當盡可能的達到對 Qt 參考文檔了如指掌的程 度。 在 Qt 的 doc/html 目錄下可以找到 HTML 格式的參考文檔，并且可以使用任何一種 Web 瀏覽器來閱讀它。也可以使用 Qt 的幫助瀏覽器 Qt Assistant，它具有強大的查詢和索引功 能，使用時能夠比 Web 瀏覽器更加快速和容易。 另外，可以從 http://doc.trolltech.com 中獲取 Qt 的當前版和一些早期版本的在線參考文檔。這個網站也選摘了 Qt 季刊（Qt Quarterly）中的一些文章。Qt 季刊是 Qt 程序 員的時事通訊，會發給所有獲得 Qt 商業許可協議的人員。 ### 5.2.3 使用 Qt Assistant 1.運行 Qt Assistant 要運行 Qt Assistant，在 Windows 下，如果是采用 Qt SDK 方式安裝的 Qt 庫，那么你 在程序組里面是找不到 Qt Assistant 的快捷方式的，它被整合到了 Qt Creator 里面，你 可以在運行 Qt Creator 時，按下 F1 鍵，即可調出 Qt Assistant，或者可以去 Qt 的安裝目 錄下面找到 Qt Assistant 的執行文件，雙擊運行或者干脆為它在桌面上設置一個快捷方 式；如果使用框架方式安裝 Qt 庫的話，可以在程序組里面找到它的快捷方式，點擊后即可 運行；在 X11 下，可在命令行終端中輸入 assistant 命令；在 Mac OS X Finder 中，只需 雙擊 assistant 即可。 注意，上述指的是一般的情況，比如各個 Linux 發行版對 Qt Assistant 的命名也有所 不同，甚至有時路徑也不完全一樣。下面是個具體例子： 如果你是自己編譯源代碼安裝的 Qt，而且沒有配置快捷方式的話，可以啟動命令行， 進入你的 Qt 安裝目錄，以筆者的 Red Flag 6.0 為例，依次鍵入下列命令。 ``` $ cd /usr/bin $ ./assistant-qt4 ``` 一般的，Qt Assistant 運行起來的效果如圖 5-18 所示  圖 5-18 Qt4 Assistant 2\.使用方法 其實讀者朋友如果用過 Windows 上微軟出品的 MSDN 的話，就會發現 Qt4 Assistant 的 界面布局與 MSDN 十分相似，操作方法也是大同小異，很容易上手。 (1) 界面布局 圖示出了 Qt Assistant 的界面布局結構，它通常分為 3 個部分，最上面是主窗口，左 側下面是內容索引窗口，右側下面是主瀏覽區。 主瀏覽區 圖 5-19 Qt4 Assistant 界面功能分布 (2) 菜單和工具欄 表 5-7 示出了 Qt Assistant 主要菜單項的功用。 表 5-7 Qt Assistant 菜單項 | 菜單 | 說明 | | --- | --- | | 文件 | 提供文檔設置、打印等相關操作操作命令 | | 編輯 | 提供首選項設置、復制文本、查找等操作命令 | | 查看 | 提供工具欄、各個標簽頁的顯隱設置，顯示比例設置等操作命令 | | 前往 | 提供登錄 Qt 主頁以及在 Qt Assistant 各個頁面間導航等操作命令 | | 書簽 | 提供添加書簽操作命令 | | 幫助 | 提供幫助命令 | 表 5-8 示出了導航工具欄的功用。 表 5-8 Qt Assistant 導航工具欄 | 名稱和圖標 | 功能 | | --- | --- | |  | 后退 | |  | 前進 | |  | 登錄 Qt 主頁 | |  | 同步目錄 | 表 5-9 示出了文件和編輯工具欄的功用。 表 5-9 Qt Assistant 文件和編輯工具欄 | 名稱和圖標 | 功能 | | --- | --- | |  | 復制選中的文本 | |  | 打印 | |  | 在文本中查找 | 表 5-10 示出了查看工具欄的功用。 表 5-10 Qt Assistant 查看工具欄 | 名稱和圖標 | 功能 | | --- | --- | |  | 放大 | |  | 縮小 | |  | 正常大小 | (3) 使用內容索引窗口 默認情況下，內容索引窗口分為 3 個標簽頁，分別是“內容”、“索引”和“書簽”，如圖 5-20 所示。其中最常用的是前兩個。  圖 5-20 內容索引窗口 內容標簽頁分成了 5 個大類，分別對應到 Qt Assistant 操作、Qt Designer 操作、Qt Linguist 操作、QMake 使用、Qt 參考文檔和例子這幾項內容。 如果你能確定你在使用和開發中遇到的問題屬于哪種類別的時候，使用 “內容”標簽 頁是合適和方便的，你只需點擊選取某個大類，然后在展開的樹形列表中選中某一個具體類 別，雙擊即可在右面的“主瀏覽區”內閱讀詳細的內容，如圖 5-21 所示的是你想查看如何 使用 qmake 工具的情形。  圖 5-21 使用內容標簽頁 可以看到，在主瀏覽區的內容也是分層次管理起來的，讀者可以根據需要進行操作。 (4) 使用“索引”標簽頁 “索引”標簽頁是使用頻率很高的，因為好多時候我們并不能準確定位出現的問題是屬于哪一類的情況，這時候，使用 “索引”標簽頁，如圖 5-22 所示，在“查找”編輯框內輸入你的問題或是問題概述或是包含的幾個字母都可以， Qt Assistant 將列出所有符合你 的需求的類別，選中你覺得合適的類別，雙擊它即可在右面的主瀏覽區內查閱相關內容。 比如我們想瀏覽 Qt Demo 的情況，在編輯框內輸入 qtde，這時 Qt Assistant 已經智能 的顯示出了相關的索引結果，然后我們選中 qtdemo，雙擊它，就可以在右面的主瀏覽區內 查看了。  圖 5-22 使用索引標簽頁 (5) 使用“標簽”標簽頁 “標簽”標簽頁也是經常會用到的，當你某次查詢時覺得某條資料很有用，希望下次 再來使用，就可以使用“標簽”。一個書簽頁的情形如圖 5-23 所示。  圖 5-23 使用“標簽”標簽頁 注意在窗口的左下角有一個藍色的【添加】按鈕和一個紅色的【移除】按鈕，它們就 是用作添加和刪除書簽的，你可能還注意到在右邊的主瀏覽區內有一個 【搜索】標簽頁，下 面就結合這兩者的使用說一下如何添加和移除標簽 。 第 1 步，在右邊的主瀏覽區內的“搜索”編輯欄內輸入你想輸入的字符，比如輸入 qt，那么主瀏覽區將會把與 qt 相關的所有條目羅列出來，如圖 5-24 所示  圖 5-24 輸入關鍵詞進行搜索 第 2 步，你需要選中一個條目（圖中藍色的是條目），比如條目中的第 2 項，如圖 5- 25 所示，系統將跳轉到相應的頁面  圖 5-25 選中一個條目，跳轉到相應界面 第 3 步，點擊【添加】按鈕，Qt Assistant 將彈出“添加書簽”對話框，請使用者添 加書簽，如圖 5-26 所示。 高級配置按鈕 圖 5-26 添加書簽對話框 如果沒有特別要求，就可以在對話框上點擊 【確定】按鈕，添加書簽，如圖 5-27 所示。  圖 5-27 添加書簽后的情形 如果還需要進一步定制書簽，那就這樣做： 第 1 步，點擊【添加書簽】對話框上點擊那個帶加號形狀的按鈕， 對話框將伸展開來，顯示進一步的配置選項，如圖 5-28 所示。  圖 5-28 定制書簽第 1 步－點擊＋號按鈕 第 2 步，點擊【新建文件夾】按鈕，這時默認建立了一個名為“新建文件夾”的標簽類別，這個過程分別如圖 5-29 和圖 5-30 所示。  圖 5-29 定制書簽第 2 步－點擊【新建文件夾】按鈕  圖 5-30 建立好的書簽文件夾 第 3 步，在你新建立的文件夾上點擊鼠標右鍵，彈出配置菜單，你可以選擇 【刪除文 件夾】或是【重命名文件夾】，如圖 5-31 所示  圖 5-31 第 3 步－配置文件夾 第 4 步，選擇【重命名文件夾】后，輸入你想定義的文件夾名稱，如圖 5-32 所 示。  圖 5-32 重命名文件夾 第 5 步，點擊【確定】按鈕，Qt Assistant 將為你建立一個標簽，如圖 5-33 所 示。  圖 5-33 建立好的標簽頁 第 6 步，依據標簽進行檢索。在左側建立好的標簽頁上雙擊， Qt Assistant 將跳轉到 對應的頁面，如圖 5-34 所示。  圖 5-34 依據標簽進行檢索 第 7 步，刪除標簽頁。選中建立好的標簽，然后點擊 【刪除】按鈕，即可刪除標簽； 也可以選中建立好的文件夾，然后點擊 【刪除按鈕】，系統會出現提示信息，選擇【是】按 鈕即可刪除整個文件夾下的所有標簽，如圖 5-35 所示。  圖 5-35 刪除文件夾下的書簽 至此，關于 Qt Assistant 的使用方法就講解完了。Qt Assistant 在編程實踐中經常會 用到，必須熟練掌握。