QHelpFilterEngine Class
La classe QHelpFilterEngine fournit une vue filtrée du contenu de l'aide. Plus d'informations...
| En-tête : | #include <QHelpFilterEngine> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Help)target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake : | QT += help |
| Héritages : | QObject |
Fonctions publiques
| QString | activeFilter() const |
| QStringList | availableComponents() const |
| QList<QVersionNumber> | availableVersions() const |
| QHelpFilterData | filterData(const QString &filterName) const |
| QStringList | filters() const |
| QStringList | indices() const |
| QStringList | indices(const QString &filterName) const |
| QMap<QString, QString> | namespaceToComponent() const |
| QMap<QString, QVersionNumber> | namespaceToVersion() const |
| QStringList | namespacesForFilter(const QString &filterName) const |
| bool | removeFilter(const QString &filterName) |
| bool | setActiveFilter(const QString &filterName) |
| bool | setFilterData(const QString &filterName, const QHelpFilterData &filterData) |
Signaux
| void | filterActivated(const QString &newFilter) |
Description détaillée
Le moteur de filtrage permet de gérer les filtres associés à une instance QHelpEngineCore. Le moteur d'aide crée en interne une instance du moteur de filtrage, à laquelle on peut accéder en appelant QHelpEngineCore::filterEngine(). Par conséquent, le constructeur public de cette classe est désactivé.
Les filtres sont identifiés par une chaîne de nom de filtre. Les détails des filtres sont décrits par la classe QHelpFilterData.
Le moteur de filtrage permet d'ajouter de nouveaux filtres et de modifier les données des filtres existants grâce à la méthode setFilterData(). Un filtre existant peut être supprimé par la méthode removeFilter().
Parmi les filtres enregistrés, l'un d'entre eux peut être marqué comme actif. Le filtre actif sera utilisé par le moteur d'aide associé pour renvoyer les résultats filtrés de nombreuses fonctions différentes, telles que le contenu, l'index ou les résultats de la recherche. Si aucun filtre n'est marqué comme actif, le moteur d'aide renvoie la liste complète des résultats disponibles.
Le filtre actif est renvoyé par activeFilter() et peut être modifié par setActiveFilter().
Voir également QHelpEngineCore.
Documentation sur les fonctions membres
QString QHelpFilterEngine::activeFilter() const
Renvoie le nom du filtre actuellement actif.
Voir aussi setActiveFilter().
QStringList QHelpFilterEngine::availableComponents() const
Renvoie la liste de tous les composants disponibles définis dans tous les fichiers de documentation enregistrés.
QList<QVersionNumber> QHelpFilterEngine::availableVersions() const
Renvoie la liste de toutes les versions disponibles définies dans tous les fichiers de documentation enregistrés.
[signal] void QHelpFilterEngine::filterActivated(const QString &newFilter)
Ce signal est émis lorsque le filtre actif est défini. newFilter spécifie le nom du filtre.
Voir aussi setActiveFilter().
QHelpFilterData QHelpFilterEngine::filterData(const QString &filterName) const
Renvoie les détails du filtre associé à filterName.
Voir aussi setFilterData().
QStringList QHelpFilterEngine::filters() const
Renvoie la liste de tous les noms de filtres définis dans le moteur de filtrage.
QStringList QHelpFilterEngine::indices() const
Renvoie une liste triée des indices disponibles. Le contenu de la liste renvoyée dépend du filtre actif et, par conséquent, seuls les index enregistrés pour le filtre actif seront renvoyés.
QStringList QHelpFilterEngine::indices(const QString &filterName) const
Renvoie une liste triée des indices disponibles, filtrée par filterName. Le contenu de la liste renvoyée dépend du filtre passé, et donc seuls les index enregistrés pour ce filtre seront renvoyés. Si vous souhaitez obtenir tous les index disponibles sans filtre, transmettez une chaîne vide à filterName.
QMap<QString, QString> QHelpFilterEngine::namespaceToComponent() const
Renvoie la carte de tous les espaces de noms disponibles en tant que clés, ainsi que leurs composants associés en tant que valeurs.
QMap<QString, QVersionNumber> QHelpFilterEngine::namespaceToVersion() const
Renvoie la carte de tous les espaces de noms disponibles en tant que clés, ainsi que leurs versions associées en tant que valeurs.
QStringList QHelpFilterEngine::namespacesForFilter(const QString &filterName) const
Renvoie la liste de tous les espaces de noms de la documentation enregistrée qui correspondent au filtre identifié par filterName.
bool QHelpFilterEngine::removeFilter(const QString &filterName)
Supprime le filtre identifié par filterName.
Renvoie true si la suppression du filtre a réussi, sinon renvoie false.
bool QHelpFilterEngine::setActiveFilter(const QString &filterName)
Change le filtre actif en filterName.
Renvoie true si le changement de filtre a réussi, sinon renvoie false.
Voir aussi activeFilter().
bool QHelpFilterEngine::setFilterData(const QString &filterName, const QHelpFilterData &filterData)
Modifie les détails du filtre identifié par filterName en filterData. Si le filtre n'existe pas, un nouveau filtre est créé.
Renvoie true si la définition du filtre a réussi, sinon renvoie false.
Voir aussi filterData().
© 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.
