Before discussing the Qt help framework, let's take a look at the Qt help documentation to give you a better understanding.
As you work with Qt, you may find the Qt help documentation to be a very useful resource. The Qt help documentation provides detailed information about the Qt framework and its various components, including class and function documentation, sample code, and tutorials. This section briefly introduces Qt Assistant.
Qt Assistant (Qt Assistant)
Qt Assistant is a help document viewer, which is part of the Qt framework, that helps developers better understand the Qt framework and its various components.
First let's look at the Qt helper (the standalone one):
The Qt Assistant interface is very similar to common web browser functions, and only two main parts are described below:
- main menu
| menu | illustrate |
|---|---|
| document | New tab page, close tab page, page setup, printing and more. |
| edit | Copy text or find text on the currently opened page, as well as edit the preferences of Qt Assistant itself. |
| Check | Zoom in and out of document page display, display of various functional windows (content, index, bookmarks, search, list of open pages) or toolbars (filter toolbar, address toolbar, bookmark toolbar). |
| go to | Similar to the home page, forward, and back of a web browser, the difference is the synchronization directory menu item. If you find the opened help page through the index or search, and you don’t know which directory tree and directory path the page is located in, you can click the synchronization directory to locate The path to this help page in the directory tree. |
| bookmark | Add open pages to bookmarks menu bar or bookmarks toolbar, manage bookmarks, etc. |
| help | Information about the Qt Assistant version. |
- navigation window
| child window | illustrate |
|---|---|
| content | Displays the directory tree of Qt help documents. The root of each document tree corresponds to a qch file (Qt Compressed Help file). For the Qt development environment installed in this tutorial, these qch files are located in "Qt installation directory\Docs\Qt-5.15.2 "In the folder, this folder not only has a bunch of *.qch files, but also a bunch of subfolders. The names of the subfolders correspond to the names of the qch files. The subfolders store the quick index data of the qch files. |
| index | Each help page in the qch file has a quick index. The content of the index generally includes the title of the help page, Qt module name, class name/name space, member variable/attribute, member function, enumeration type, macro definition, etc., by typing By indexing keywords, you can quickly find relevant document pages. The storage location of these quick index data is in the sub-file of "Qt installation directory\Docs\Qt-5.15.2" just mentioned. |
| bookmark | You can press the shortcut key Ctrl+D to save the current page as a bookmark. There are two types of bookmark saving locations, one is displayed in the menu item of the bookmark menu bar, and the other is displayed in the bookmark toolbar. You can right-click the blank space of the menu bar or toolbar, and select Show Bookmark Toolbar from the right-click menu. |
| search | This is a full-text search for all Qt document pages. For keywords that cannot be found in the quick index, you can search in the full-text search sub-window. |
This is the introduction of the Qt assistant. Find the classes, modules, etc. you want to know, and just search by yourself, so I won’t go into details~