How to use this Example

There are three ways to get help in this example:

• Press F1. Depending where your mouse position is you get either the help for the item under the mouse cursor or the general help for this example.
• Press the right mouse button to invoke a context menu, then click 'Help'. The displayed help page is choose as described above.
• Use the buttons to control Qt Assistant directly. For a further explanation see below.

Open Assistant Button

Click this button to open Qt Assistant. If it is already open nothing will happen. The displayed page is the one that was last displayed.

Close Assistant Button

Click this button to close Qt Assistant. If it is not running nothing will happen.

Run Qt Assistant customized for HelpDemo

Check this item in order to run Qt Assistant as a customized help tool for the HelpDemo example. Checking or unchecking has no effect if Qt Assistant is already running. To apply changes you have to restart Qt Assistant. Please see the HelpDemo::setAssistantArguments() function to see how Qt Assistant can be started in customized mode.

Hide Sidebar on Startup

Check this item to run Qt Assistant with the sidebar hidden. Checking or unchecking has no effect if Qt Assistant is already running. To apply changes you have to restart Qt Assistant.

Filename

Enter the file name of a help page you want to get displayed here. The path can be specified as an absolute or relative path.

Display Button

Click this button in order to get the help page which is specified in the file name line edit displayed. If Qt Assistant is currently not open, it will be opened automatically.

Close Button

Click this button to quit this example application.