===== Le module QtHelp =====

Le module QtHelp fournit des classes pour l'intégration d'une documentation en ligne dans des applications. 

==== Classes ====

| [[QHelpContentItem]] | Item à utiliser avec [[QHelpContentModel]] | 
| [[QHelpContentModel]] | Modèle qui fournit du contenu aux vues | 
| [[QHelpContentWidget]] | Vue en arbre pour afficher les items du modèle | 
| [[QHelpEngine]] | Accès aux contenus et index du moteur d'aide | 
| [[QHelpEngineCore]] | Les fonctionnalités au cœur du système d'aide | 
| [[QHelpIndexModel]] | Modèle qui fournit les mots-clés de l'index aux vues | 
| [[QHelpIndexWidget]] | Vue en liste affichant le [[QHelpIndexModel]] | 
| [[QHelpSearchEngine]] | Accès aux widgets réutilisables pour intégrer la recherche de texte comme l'indexation et la recherche dans la documentation | 
| [[QHelpSearchQuery]] | Contient le nom du champ et les termes de recherche associés | 
| [[QHelpSearchQueryWidget]] | Simple édition de ligne ou widget avancé pour permettre à l'utilisateur d'entrer des termes de recherche dans un masque d'entrée standardisé | 
| [[QHelpSearchResultWidget]] | Soit un widget arbre soit un navigateur de texte, cela dépendant du moteur de recherche utilisé pour afficher les résultats trouvés par la recherche | 

Pour inclure les définitions des classes du module, utilisez la directive suivante :

<code cpp-qt>
#include <QtHelp>
</code>

Pour créer un lien sur le module, ajoutez cette ligne à votre fichier [[qmake-manual#qmake|qmake]] ''.pro'' :

<code cpp-qt> CONFIG += help</code>

Ces classes font partie de [[opensourceedition|la versions open source de Qt]] et de [[commercialeditions|l'édition complète du framework Qt]] pour les utilisateurs commerciaux. 

=== Informations de licence ===

Le module QtHelp utilise la bibliothèque d'indexation CLucene pour fournir des capacités de recherche de texte à Qt Assistant et aux applications utilisant les fonctionnalités de QtHelp. 

Les utilisateurs de Qt Commercial Edition voulant distribuer des applications utilisant ces fonctionnalités doivent être au courant de leurs obligations vis-à-vis de la //GNU Lesser General Public Licence// (LGPL). 

Les développeurs utilisant l'édition Open Source peuvent choisir de redistribuer le module sous les conditions de la version appropriée de la GNU LGPL : la version 2.1 pour les applications et bibliothèques licenciées sous la GNU GPL 2 ou bien la version 3 pour les applications et bibliothèques licenciées sous la GNU GPL 3. 

> Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team. Changes are Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
> 
> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License or (at your option) any later version.
> 
> This library is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
> 
> You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Voir aussi [[qthelp-framework|le framework Qt Help]].

[ Précédent : [[qtuitools|le module QtUiTools]] ]
[ [[modules|Tous les modules de Qt]] ]
[ Suivant : [[qttest|le module QtTest]] ]

==== Remerciements ====

Merci à <!dourouc!> pour la traduction, ainsi qu'à <!johnlamericain!> et <!eusebe!> pour la relecture !