![]() |
Home · Examples |
[Qt Assistant Manual][Next: Using Qt Assistant as a Custom Help Viewer]
-collectionFile <file.qhc> | Uses the specified collection file instead of the default one. |
-showUrl URL | Shows the document referenced by URL. |
-enableRemoteControl | Enables Qt Assistant to be remotly controlled. |
-show <widget> | Shows the specified dockwidget which can be "contents", "index", "bookmarks" or "search". |
-hide <widget> | Hides the specified dockwidget which can be "contents", "index", "bookmarks" or "search. |
-activate <widget> | Activates the specified dockwidget which can be "contents", "index", "bookmarks" or "search. |
-register <doc.qch> | Registers the specified compressed help file in the given help collection. |
-unregister <doc.qch> | Unregisters the specified compressed help file from the given collection file. |
-quiet | Doesn't show any error, warning or success messages. |
The tool windows can be docked into the main window, so you can drag them to the top, left, right or bottom of Qt Assistant's window, or you can drag them outside Qt Assistant to float them as independent windows.Documentation Window
The Documentation window lets you create a tab for each documentation page that you view. Click the Add Tab button and a new tab will appear with the page name as the tab's caption. This makes it convenient to switch between pages when you are working with different documentation. You can delete a tab by clicking the Close Tab button located on the right side of the Documentation window.Toolbars
The main toolbar provides fast access to the most common actions.
Previous | Takes you to the previous page in the history. | Go|Previous | Alt+Left Arrow |
Next | Takes you to the next page in the history. | Go|Next | Alt+Right Arrow |
Home | Takes you to the home page (usually the first page shown when Qt Assistant is started). | Go|Home | Ctrl+Home. |
Sync with Table of Contents | Synchronizes the Contents tool window with the page currently shown in the Documentation window. | Go|Sync with Table of Contents | |
Copy | Copies any selected text to the clipboard. | Edit|Copy | Ctrl+C |
Opens the Print dialog. | File|Print | Ctrl+P | |
Find in Text | Opens the Find Text dialog. | Edit|Find in Text | Ctrl+F |
Zoom in | Increases the font size used to display text in the current tab. | View|Zoom in | Ctrl++ |
Zoom out | Decreases the font size used to display text in the current tab. | View|Zoom out | Ctrl+- |
Normal Size | Resets the font size to its normal size in the current tab. | View|Normal Size | Ctrl+0 |
If you check the Whole words only checkbox, the search will only consider whole words; for example, if you search for "spin" with this checkbox checked it will not match "spinbox", but will match "spin". If you check the Case sensitive checkbox then, for example, "spin" will match "spin" but not "Spin". You can search forwards or backwards from your current position in the page by clicking the Previous or Next buttons. To hide the find control, either click the Close button or hit the Esc key. We use documentation filters to solve this issue. A filter is identified by its name, and contains a list of filter attributes. An attribute is just a string and can be freely chosen. Attributes are defined by the documentation itself, this means that every documentation set usually has one or more attributes. For example, the Qt 4.4.0 Qt Assistant documentation defines the attributes assistant, tools and 4.4.0, Qt Designer defines designer, tools and 4.4.0. The filter to display all tools would then define only the attribute tools since this attribute is part of both documentation sets. Adding the attribute assistant to the filter would then only show Qt Assistant documentation since the Qt Designer documentation does not contain this attribute. Having an empty list of attributes in a filter will match all documentation; i.e., it is equivalent to requesting unfiltered documentation. The list of documents found is ordered according to the number of occurrences of the search text which they contain, with those containing the highest number of occurrences appearing first. Simply click any document in the list to display it in the Documentation window. If the documentation has changed — for example, if documents have been added or removed —Qt Assistant will index them again.Filtering Help Contents
Qt Assistant allows you to install any kind of documentation as long as it is organized in Qt compressed help files (*.qch). For example, it is possible to install the Qt reference documentation for Qt 4.4.0 and Qt 4.4.1 at the same time. In many respects, this is very convenient since only one version of Qt Assistant is needed. However, at the same time it becomes more complicated when performing tasks like searching the index because nearly every keyword is defined in Qt 4.4.0 as well as in Qt 4.4.1. This means that Qt Assistant will always ask the user to choose which one should be displayed. Full Text Searching
Qt Assistant provides a powerful full text search engine. To search for certain words or text, click the Search tab in the Documentation window. Then enter the text you want to look for and press Enter or click the Search button. The search is not case sensitive, so, for example, Foo, fOo and FOO are all treated as the same. The following are examples of common search patterns:
It is also possible to use the Advanced search to get more flexibility. You can specify some words so that hits containing these are excluded from the result, or you can search for an exact phrase. Searching for similar words will give results like these:
Options can be combined to improve the search results.
Copyright © 2008 Trolltech
Trademarks