Qt Assistant Guide rapide Personnalisation de Qt Assistant

Utilisation Qt Assistant

Capture d'écran de Qt Assistant montrant les widgets pour la documentation

Vous pouvez lire la documentation dans la fenêtre Documentation. Pour ouvrir une rubrique dans un nouvel onglet, cliquez dessus avec le bouton droit de la souris dans la fenêtre Contenu pour ouvrir un menu contextuel et sélectionnez Ouvrir le lien dans un nouvel onglet. Toutes les rubriques ouvertes sont répertoriées dans la fenêtre Pages ouvertes. Sélectionnez une rubrique pour l'afficher dans la fenêtre Documentation.

Si vous souhaitez que la fenêtre Documentation occupe le moins d'espace possible, vous pouvez facilement regrouper, déplacer ou masquer les fenêtres de la barre latérale. Pour regrouper les fenêtres, faites-les glisser l'une sur l'autre et relâchez la souris. Si une ou toutes les fenêtres de la barre latérale ne sont pas affichées, sélectionnez des raccourcis clavier pour les afficher. Vous pouvez afficher les raccourcis clavier dans le menu Affichage.

Les fenêtres latérales peuvent être ancrées dans la fenêtre principale ; vous pouvez donc les faire glisser en haut, à gauche, à droite ou en bas de la fenêtre principale, ou vous pouvez les faire glisser en dehors de Qt Assistant pour les faire flotter en tant que fenêtres indépendantes.

Pour modifier la famille et la taille des polices de la fenêtre du navigateur affichant la documentation ou l'application elle-même, sélectionnez Édition > Préférences > Polices.

Capture d'écran montrant le menu de préférences de Qt Assistant permettant de modifier les paramètres de police.

Pour augmenter ou réduire temporairement la taille de la police dans la fenêtre Documentation, sélectionnez Affichage > Zoom avant ou Zoom arrière. Pour réinitialiser la taille de la police, sélectionnez Affichage > Taille normale.

Pour naviguer entre les pages, sélectionnez Aller > Précédent ou Suivant. Vous accédez ainsi à la page précédente ou suivante de l'historique. Pour revenir à la page d'accueil, sélectionnez Aller > Accueil. Pour spécifier la page d'accueil, sélectionnez Édition > Préférences > Options.

Pour synchroniser la fenêtre Contenu avec la page actuellement affichée dans la fenêtre Documentation, sélectionnez Aller > Synchroniser avec la table des matières.

La barre d'outils d'adresse permet de saisir rapidement l'URL d'un fichier de documentation. Pour afficher la barre d'outils d'adresse, sélectionnez Affichage > Barres d'outils > Barre d'outils d'adresse.

Recherche à partir du contenu de la page

Pour rechercher du texte sur la page en cours, sélectionnez Édition > Rechercher dans le texte. Saisissez le terme recherché dans le champ. La recherche est incrémentielle, ce qui signifie que le résultat le plus pertinent s'affiche au fur et à mesure que vous saisissez des caractères dans le champ.

Si vous cochez la case Respecter la casse, la recherche tient compte de la casse du terme recherché. Par exemple, si vous recherchez spin, le résultat correspondra à spin mais pas à Spin.

Pour effectuer une recherche vers l'avant ou vers l'arrière à partir de votre position actuelle sur la page, cliquez sur Précédent ou Suivant.

Pour masquer le contrôle de recherche, cliquez sur Fermer ou appuyez sur Echap.

Recherche en texte intégral

Qt Assistant pour parcourir la documentation" src="images/assistant-search.png" title="Capture d'écran du menu de recherche de Qt Assistant pour parcourir la documentation"/>

Qt Assistant offre un puissant moteur de recherche plein texte. Vous pouvez rechercher certains mots ou textes dans la fenêtre de recherche. Saisissez le texte que vous souhaitez rechercher et appuyez sur Entrée ou cliquez sur Rechercher. La recherche n'est pas sensible à la casse. Par exemple, Foo, fOo et FOO sont tous traités de la même manière.

Vous pouvez créer des requêtes complexes en utilisant la syntaxe des requêtes FTS.

Voici des exemples de modèles de recherche courants :

deep - liste tous les documents qui contiennent le mot deep
deep* - liste tous les documents qui contiennent un mot commençant par profond
deep copy - liste tous les documents qui contiennent à la fois deep et copy
"deep copy" - liste tous les documents qui contiennent l'expression deep copy

La liste des documents trouvés est ordonnée en fonction du nombre d'occurrences du texte recherché qu'ils contiennent, ceux qui contiennent le plus grand nombre d'occurrences apparaissant en premier. Il suffit de cliquer sur un document de la liste pour l'afficher dans la fenêtre Documentation.

Si la documentation a changé - par exemple, si des documents ont été ajoutés ou supprimés - Qt Assistant les indexera à nouveau.

Filtrage du contenu de l'aide

Qt Assistant vous permet d'installer n'importe quel type de documentation à condition qu'elle soit organisée en fichiers d'aide compressés Qt Help (*.qch). Par exemple, vous pouvez consulter la documentation de référence de Qt pour plusieurs versions de Qt en même temps. À bien des égards, c'est très pratique puisqu'une seule version de Qt Assistant est nécessaire. Cependant, cela devient en même temps plus compliqué pour effectuer des tâches telles que la recherche dans l'index, car la plupart des mots-clés sont définis dans plus d'une version de Qt. Cela signifie que Qt Assistant demandera toujours à l'utilisateur de choisir celle qui doit être affichée.

Nous utilisons des filtres de documentation pour résoudre ce problème. Un filtre est identifié par son nom et contient une liste d'attributs de filtre. Un attribut n'est qu'une chaîne de caractères et peut être choisi librement. Les attributs sont définis par la documentation elle-même, ce qui signifie que chaque ensemble de documentation possède généralement un ou plusieurs attributs.

Par exemple, la documentation Qt Assistant définit les attributs assistant et tools, tandis que Qt Widgets Designer définit designer et tools. Le filtre permettant d'afficher tous les outils ne définirait alors que l'attribut tools, puisque cet attribut fait partie des deux ensembles de documentation. L'ajout de l'attribut assistant au filtre n'afficherait alors que la documentation Qt Assistant puisque la documentation Qt Widgets Designer ne contient pas cet attribut. Une liste d'attributs vide dans un filtre correspondra à toute la documentation. En d'autres termes, cela revient à demander une documentation non filtrée.

Pour créer et supprimer des filtres de documentation, sélectionnez Édition > Préférences > Filtres.

Capture d'écran montrant le menu de préférences du Qt Assistant permettant de filtrer les catégories à afficher.

Pour ajouter un nouveau filtre, cliquez sur Ajouter, indiquez un nom de filtre et cliquez sur OK. Sélectionnez ensuite les attributs du filtre dans le champ Attributs.

Pour supprimer un filtre, sélectionnez-le et cliquez sur Supprimer.

La barre d'outils du filtre vous permet d'appliquer un filtre à la documentation actuellement installée. Pour afficher la barre d'outils de filtrage, sélectionnez Affichage > Barres d'outils > Barre d'outils de filtrage.

Ajout de documentation

Pour installer et supprimer des fichiers d'aide compressés, sélectionnez Édition > Préférences > Documentation.

Capture d'écran montrant le menu de préférences de Qt Assistant pour ajouter ou supprimer à la liste de documentation.

Cliquez sur le bouton Installer et choisissez le chemin du fichier d'aide compressé (*.qch) que vous souhaitez installer. Pour supprimer un fichier d'aide, sélectionnez un jeu de documentation dans la liste et cliquez sur Supprimer.

Spécification de la page d'accueil

Pour spécifier la page d'accueil que Qt Assistant affiche lorsque vous cliquez sur le bouton Accueil, sélectionnez Édition > Préférences > Options.

Saisissez l'URL de la page d'accueil ou sélectionnez Page actuelle pour définir la page actuellement affichée comme page d'accueil. Pour laisser la page d'accueil vide, sélectionnez Page vierge. Sélectionnez Restaurer la valeur par défaut pour rétablir la page d'accueil par défaut.

Utilisation des options de ligne de commande

Qt Assistant gère les options de ligne de commande suivantes :

Option de ligne de commande	Brève description
-collectionFile <file.qhc> (fichier de collecte)	Utilise le fichier de collecte spécifié au lieu du fichier par défaut.
-showUrl <URL>	Affiche le document référencé par l'URL.
-enableRemoteControl	Permet à Qt Assistant d'être contrôlé à distance.
-show <widget>	Affiche la fenêtre latérale spécifiée, qui peut être "contents", "index", "bookmarks" ou "search".
-hide <widget>	Masque la fenêtre latérale spécifiée, qui peut être "contents", "index", "bookmarks" ou "search".
-activate <widget>	Active la fenêtre latérale spécifiée, qui peut être "contents", "index", "bookmarks" ou "search".
-enregistrer <doc.qch>	Enregistre le fichier d'aide compressé spécifié dans la collection d'aide donnée.
-unregister <doc.qch> (désenregistrer)	Désinscrit le fichier d'aide compressé spécifié du fichier de la collection donnée.
-remove-search-index	Supprime l'index du moteur de recherche d'aide. Cette option est utile si les fichiers d'index associés sont corrompus. Qt Assistant réindexera la documentation au prochain démarrage.
-rebuild-search-index	Reconstruit l'index du moteur de recherche d'aide. Notez que cette opération peut prendre un certain temps.
-setCurrentFilter <filtre>	Définit le filtre donné comme filtre actif.
-quiet	N'affiche aucun message d'erreur, d'avertissement ou de réussite.

Qt Assistant Guide rapide Personnalisation de Qt Assistant

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.