Using TQt Assistant is simple: Create a TQAssistantClient instance, then call showPage() as often as necessary to show your help pages. When you call showPage(), TQt Assistant will be launched if it isn't already running.
The TQAssistantClient instance can open (openAssistant()) or close (closeAssistant()) TQt Assistant whenever required. If TQt Assistant is open, isOpen() returns TRUE.
One TQAssistantClient instance interacts with one TQt Assistant instance, so every time you call openAssistant(), showPage() or closeAssistant() they are applied to the particular TQt Assistant instance associated with the TQAssistantClient.
When you call openAssistant() the assistantOpened() signal is emitted. Similarly when closeAssistant() is called, assistantClosed() is emitted. In either case, if an error occurs, error() is emitted.
This class is not included in the TQt library itself. To use it you must link against \fClibtqassistantclient.a\fR (Unix) or \fCtqassistantclient.lib\fR (Windows), which is built into \fCINSTALL/lib\fR if you built the TQt tools (\fCINSTALL\fR is the directory where TQt is installed). If you use qmake, then you can simply add the following line to your pro file:
Constructs an assistant client object. The \fIpath\fR specifies the path to the TQt Assistant executable. If \fIpath\fR is an empty string the system path (\fC%PATH%\fR or \fC$PATH\fR) is used.
This signal is emitted when the connection to TQt Assistant is closed. This happens when the user exits TQt Assistant, or when an error in the server or client occurs, or if closeAssistant() is called.
This signal is emitted if TQt Assistant cannot be started or if an error occurs during the initialization of the connection between TQt Assistant and the calling application. The \fImsg\fR provides an explanation of the error.
This function opens TQt Assistant and sets up the client-server communiction between the application and TQt Assistant. If it is already open, this function does nothing. If an error occurs, error() is emitted.
Call this function to make TQt Assistant show a particular \fIpage\fR. The \fIpage\fR is a filename (e.g. \fCmyhelpfile.html\fR). See "Adding Documentation to TQt Assistant" in the TQt Assistant manual for further information.
If TQt Assistant hasn't been opened yet, this function will do nothing. You can use isOpen() to determine whether TQt Assistant is up and running, or you can connect to the asssistantOpened() signal.
