Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions

[Prev: Introduction to the TQt Reference Documentation] [Home] [Next: TQt Assistant in More Detail]

The 1 Minute Guide to Using TQt Assistant

Under Windows, TQt Assistant is available as a menu option on the TQt menu. On Unix, run assistant from an xterm.

When you start up TQt Assistant, you will be presented with a standard main-window style application, with a menu bar and toolbar. Below these, on the left hand side is a navigation window called the Sidebar, and on the right, taking up most of the space, is the documentation window. By default, the TQt Reference Documentation's home page is shown in the documentation window.

TQt Assistant works in a similar way to a web browser. If you click underlined text (which signifies a cross-reference), the documentation window will present the relevant page. You can bookmark pages of particular interest and you can click the Previous and Next toolbar buttons to navigate within the pages you've visited.

Although TQt Assistant can be used just like a web browser to navigate through the TQt documentation set, TQt Assistant offers a powerful means of navigation that web browsers don't provide. TQt Assistant uses an intelligent algorithm to index all the pages in the documentation sets that it presents so that you can search for particular words and phrases.

To perform an index search, click the Index tab on the Sidebar (or click Ctrl+I). In the 'Look For' line edit enter a word, e.g. 'homedirpath'. As you type, words are found and highlighted in a list beneath the line edit. If the highlighted text matches what you're looking for, double click it, (or press Enter) and the documentation window will display the relevant page. You rarely have to type in the whole word before TQt Assistant finds a match. Note that for some words there may be more than one possible page that is relevant.

TQt Assistant also provides full text searching for finding specific words in the documentation. Documents with the highest occurrences of the word that you are looking for appear first, and every occurrence of the word within the documentation is highlighted.

TQt Assistant can be customized by creating profiles, a collection of documentation. Profiles can be created for your own use, or for an application you will distribute. With profiles, you can select which documentation you want the end user of your application to be able to view.

[Prev: Introduction to the TQt Reference Documentation] [Home] [Next: TQt Assistant in More Detail]