Viadeo Twitter Google Bookmarks ! Facebook Digg del.icio.us MySpace Yahoo MyWeb Blinklist Netvouz Reddit Simpy StumbleUpon Bookmarks Windows Live Favorites 
Logo Documentation Qt ·  Page d'accueil  ·  Toutes les classes  ·  Classes principales  ·  Annotées  ·  Classes groupées  ·  Fonctions  · 

QAssistantClient Class Reference

The QAssistantClient class provides a means of using Qt Assistant as an application's help tool. More...

#include <qassistantclient.h>

Inherits QObject.

List of all member functions.

Public Members

Public Slots

Signals

Properties

  • bool open - whether Qt Assistant is open  (read only)

Detailed Description

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.


Member Function Documentation

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.

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]

Use this function to close Qt Assistant.

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]

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.

See also assistantOpened().

void QAssistantClient::setArguments ( const QStringList & args )

Sets the command line arguments used when Qt Assistant is started to args.

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, this function will open it.

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-2003 Trolltech. All Rights Reserved.

Publicité

Best Of

Actualités les plus lues

Semaine
Mois
Année
  1. « Quelque chose ne va vraiment pas avec les développeurs "modernes" », un développeur à "l'ancienne" critique la multiplication des bibliothèques 94
  2. Apercevoir la troisième dimension ou l'utilisation multithreadée d'OpenGL dans Qt, un article des Qt Quarterly traduit par Guillaume Belz 0
  3. Les développeurs ignorent-ils trop les failles découvertes dans leur code ? Prenez-vous en compte les remarques des autres ? 17
  4. Pourquoi les programmeurs sont-ils moins payés que les gestionnaires de programmes ? Manquent-ils de pouvoir de négociation ? 42
  5. Quelles nouveautés de C++11 Visual C++ doit-il rapidement intégrer ? Donnez-nous votre avis 10
  6. Adieu qmake, bienvenue qbs : Qt Building Suite, un outil déclaratif et extensible pour la compilation de projets Qt 17
  7. 2017 : un quinquennat pour une nouvelle version du C++ ? Possible, selon Herb Sutter 8
Page suivante

Le Qt Labs au hasard

Logo

Utiliser OpenCL avec Qt

Les Qt Labs sont les laboratoires des développeurs de Qt, où ils peuvent partager des impressions sur le framework, son utilisation, ce que pourrait être son futur. Lire l'article.

Communauté

Ressources

Liens utiles

Contact

  • Vous souhaitez rejoindre la rédaction ou proposer un tutoriel, une traduction, une question... ? Postez dans le forum Contribuez ou contactez-nous par MP ou par email (voir en bas de page).

Qt dans le magazine

Cette page est une traduction d'une page de la documentation de Qt, écrite par Nokia Corporation and/or its subsidiary(-ies). Les éventuels problèmes résultant d'une mauvaise traduction ne sont pas imputables à Nokia. Qt 3.2
Copyright © 2012 Developpez LLC. Tous droits réservés Developpez LLC. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents et images sans l'autorisation expresse de Developpez LLC. Sinon, vous encourez selon la loi jusqu'à 3 ans de prison et jusqu'à 300 000 E de dommages et intérêts. Cette page est déposée à la SACD.
Vous avez déniché une erreur ? Un bug ? Une redirection cassée ? Ou tout autre problème, quel qu'il soit ? Ou bien vous désirez participer à ce projet de traduction ? N'hésitez pas à nous contacter ou par MP !
 
 
 
 
Partenaires

Hébergement Web