|
Eneboo - Documentación para desarrolladores
|
|
Eneboo - Documentación para desarrolladores
|
The QAssistantClient class provides a means of using Qt Assistant as an application's help tool. Más...
#include <qassistantclient.h>
Slots públicos | |
| virtual void | openAssistant () |
| virtual void | closeAssistant () |
| virtual void | showPage (const QString &page) |
| virtual void | openAssistant () |
| virtual void | closeAssistant () |
| virtual void | showPage (const QString &page) |
Señales | |
| void | assistantOpened () |
| void | assistantClosed () |
| void | error (const QString &msg) |
| void | assistantOpened () |
| void | assistantClosed () |
| void | error (const QString &msg) |
Métodos públicos | |
| QAssistantClient (const QString &path, QObject *parent=0, const char *name=0) | |
| ~QAssistantClient () | |
| bool | isOpen () const |
| void | setArguments (const QStringList &args) |
| QAssistantClient (const QString &path, QObject *parent=0, const char *name=0) | |
| ~QAssistantClient () | |
| bool | isOpen () const |
| void | setArguments (const QStringList &args) |
Propiedades | |
| bool | open |
| Whether Qt Assistant is open. | |
The QAssistantClient class provides a means of using Qt Assistant as an application's help tool.
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.
| QAssistantClient::QAssistantClient | ( | const QString & | path, |
| QObject * | parent = 0, |
||
| const char * | name = 0 |
||
| ) |
Constructs an assistant client object. The path specifies the path to the Qt Assistant executable. If path is an empty string the system path ({PATH%} or $PATH) is used.
The assistant client object is a child of parent and is called name.
| QAssistantClient::~QAssistantClient | ( | ) |
Destroys the assistant client object and frees up all allocated resources.
| QAssistantClient::QAssistantClient | ( | const QString & | path, |
| QObject * | parent = 0, |
||
| const char * | name = 0 |
||
| ) |
| 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::assistantClosed | ( | ) | [signal] |
| void QAssistantClient::assistantOpened | ( | ) | [signal] |
This signal is emitted when Qt Assistant is open and the client-server communication is set up.
| void QAssistantClient::assistantOpened | ( | ) | [signal] |
| virtual void QAssistantClient::closeAssistant | ( | ) | [virtual, slot] |
| void QAssistantClient::closeAssistant | ( | ) | [virtual, slot] |
Use this function to close Qt Assistant.
| void QAssistantClient::error | ( | const QString & | msg | ) | [signal] |
| void QAssistantClient::error | ( | const QString & | msg | ) | [signal] |
| bool QAssistantClient::isOpen | ( | ) | const |
| bool QAssistantClient::isOpen | ( | ) | const |
| virtual void QAssistantClient::openAssistant | ( | ) | [virtual, slot] |
| void QAssistantClient::openAssistant | ( | ) | [virtual, slot] |
This function opens Qt Assistant and sets up the client-server communiction between the application and Qt Assistant. If it is already open, this function does nothing. If an error occurs, error() is emitted.
| void QAssistantClient::setArguments | ( | const QStringList & | args | ) |
| void QAssistantClient::setArguments | ( | const QStringList & | args | ) |
Sets the command line arguments used when Qt Assistant is started to args.
| virtual void QAssistantClient::showPage | ( | const QString & | page | ) | [virtual, slot] |
| void QAssistantClient::showPage | ( | const QString & | page | ) | [virtual, slot] |
Call this function to make Qt Assistant show a particular page. The page is a filename (e.g. myhelpfile.html). See "Adding
Documentation to Qt Assistant" in the Qt Assistant manual for further information.
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.
1.7.4
