QAssistantClient Class Reference

Detailed Description

Using Qt Assistant is simple: Create a QAssistantClient instance, then call showPage() as often as necessary to show your help pages. When you call showPage(), Qt Assistant will be launched if it isn't already running.

The QAssistantClient instance can open (openAssistant()) or close (closeAssistant()) Qt Assistant whenever required. If Qt Assistant is open, isOpen() returns TRUE.

One QAssistantClient instance interacts with one Qt Assistant instance, so every time you call openAssistant(), showPage() or closeAssistant() they are applied to the particular Qt Assistant instance associated with the QAssistantClient.

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 Qt library itself. To use it you must link against libqassistantclient.a (Unix) or qassistantclient.lib (Windows), which is built into INSTALL/lib if you built the Qt tools (INSTALL is the directory where Qt is installed). If you use qmake, then you can simply add the following line to your pro file:

        LIBS += -lqassistantclient
    

See also "Adding Documentation to Qt Assistant" in the Qt Assistant manual.

Member Function Documentation

QAssistantClient::QAssistantClient ( const QString & path, QObject * parent = 0, const char * name = 0 )

The assistant client object is a child of parent and is called name.

QAssistantClient::~QAssistantClient ()

void QAssistantClient::assistantClosed () [signal]

This signal is emitted when the connection to Qt Assistant is closed. This happens when the user exits Qt Assistant, or when an error in the server or client occurs, or if closeAssistant() is called.

void QAssistantClient::assistantOpened () [signal]

This signal is emitted when Qt Assistant is open and the client-server communication is set up.

void QAssistantClient::closeAssistant () [virtual slot]

See also assistantClosed().

void QAssistantClient::error ( const QString & msg ) [signal]

This signal is emitted if Qt Assistant cannot be started or if an error occurs during the initialization of the connection between Qt Assistant and the calling application. The msg provides an explanation of the error.

bool QAssistantClient::isOpen () const

Returns TRUE if Qt Assistant is open; otherwise returns FALSE. See the "open" property for details.

void QAssistantClient::openAssistant () [virtual slot]

See also assistantOpened().

void QAssistantClient::setArguments ( const QStringList & args )

void QAssistantClient::showPage ( const QString & page ) [virtual slot]

If Qt Assistant hasn't been opened yet, this function will do nothing. You can use isOpen() to determine whether Qt Assistant is up and running, or you can connect to the asssistantOpened() signal.

See also open and assistantOpened().

Example: helpsystem/mainwindow.cpp.

Property Documentation

bool open

This property holds whether Qt Assistant is open.

Get this property's value with isOpen().

This file is part of the Qt toolkit. Copyright © 1995-2005 Trolltech. All Rights Reserved.