![]() |
Home · Overviews · Examples |
-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 toolwindows are dock windows, so you can drag them to the top, left, right or bottom of Qt Assistant's window, or you can drag it outside Qt Assistant to float it. If you check the Whole words only checkbox, the search will only consider whole words, i.e. 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 forward or backward from your current position in the page by clicking one of the direction radio buttons. To hide the find control, either click the Close button or hit the Esc key. To solve this issue, documentation filters were introduced. A filter is identified by its name and contains a list of filter attributes. An attribute is just a string and can be freely choosen. Attributes are defined by the documentation itself, this means that every documentation has usually one or more attributes. So, the Qt Assistant documentation defines e.g. 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. 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's equal to unfiltered. The list of documents found is ordered according to the number of occurrences of the search text they contain, therefore those with the highest number of occurrences appearing first. Simply click any document in the list to display it in the document window. If the documentation has changed, i.e. if documents have been added or removed, Qt Assistant will reindex.Documentation Window
The Documentation window offers a feature for viewing documentation by enabling you to create tabs 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 toolbar provides fast access to the most common actions.
The address toolbar provides a fast way to enter a specific url for a documentation file. By default, the address toolbar is not shown, so it has to be activated via View|Toolbars|Address Toolbar.
The filter toolbar allows you to apply a filter to the currently installed documentation. As the address toolbar, the filter toolbar is by default not visible and has to be activated via View|Toolbars|Filter Toolbar.Menus
The File Menu
The Edit Menu
The View Menu
The Go Menu
The Bookmarks Menu
Dialogs
The Print Dialog
This dialog is platform-specific. It gives access to various printer options and can be used to print the current page.The Preferences Dialog
The Fonts page allows you to change the font family and font sizes of the browser window displaying the documentation or the application itself.
The Filters page lets you create and remove documentation filters. To add a new filter, clikc the Add button, specify a filter name in the appearing dialog and click OK. The select the filter attributes in the list box at the right hand side. You can delete a filter by clicking the Remove button.
The Documentation page will provide you a way to install and remove compressed help files. Click the Install button and choose the path of the compressed help file (*.qch) you would like to install. To delete a help file select a documentation in the list and click Remove.Find Text Control
This control is used to find text in the current page. Enter the text you want to find in the find line edit. The search is incremental, meaning whenever you type one character in the find line edit the search process will be started. Filtering Help Contents
Qt Assistant allows you to install any kind of documentation as long as the documentation 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. That is in some way very convenient since only one version of Qt Assistant is needed. But at the same time it becomes more complicated when e.g. searching in the index because nearly every keyword is defined in Qt 4.4.0 as well as Qt 4.4.1. This means that Qt Assistant will always ask the user 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 Search. The search is not case sensitive, so 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 search for an exact phrase of words. Search for similar words will look like this:
All options can be combined to enhance your search options.
Copyright © 2008 Trolltech
Trademarks