QHelpFilterEngine Class
La classe QHelpFilterEngine offre une vue filtrée du contenu de l'aide. En savoir plus...
| En-tête : | #include <QHelpFilterEngine> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake : | QT += help |
| Hérite de : | 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 la gestion des filtres associés à une instance de ` QHelpEngineCore `. Le moteur d’aide crée en interne une instance du moteur de filtrage, accessible via l’appel à ` QHelpEngineCore::filterEngine()`. Par conséquent, le constructeur public de cette classe est désactivé.
Les filtres sont identifiés par une chaîne de caractères représentant leur nom. Les détails relatifs aux 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 via la méthode setFilterData(). Un filtre existant peut être supprimé via la méthode removeFilter().
Parmi les filtres enregistrés, un seul 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 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 la méthode activeFilter() et peut être modifié par la méthode 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 l'ensemble des fichiers de documentation enregistrés.
QList<QVersionNumber> QHelpFilterEngine::availableVersions() const
Renvoie la liste de toutes les versions disponibles définies dans l'ensemble des fichiers de documentation enregistrés.
[signal] void QHelpFilterEngine::filterActivated(const QString &newFilter)
Ce signal est émis lorsque le filtre actif est défini. La variable « newFilter » spécifie le nom du filtre.
Voir également setActiveFilter().
QHelpFilterData QHelpFilterEngine::filterData(const QString &filterName) const
Renvoie les détails du filtre associés à filterName.
Voir également 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 ; par conséquent, seuls les indices enregistrés pour ce filtre seront renvoyés.
QStringList QHelpFilterEngine::indices(const QString &filterName) const
Renvoie une liste triée des indices disponibles, filtrée selon filterName. Le contenu de la liste renvoyée dépend du filtre passé ; par conséquent, seuls les indices enregistrés pour ce filtre seront renvoyés. Si vous souhaitez obtenir tous les indices disponibles sans filtrage, passez une chaîne vide comme filterName.
QMap<QString, QString> QHelpFilterEngine::namespaceToComponent() const
Renvoie une carte contenant tous les espaces de noms disponibles en tant que clés, ainsi que les composants qui leur sont associés en tant que valeurs.
QMap<QString, QVersionNumber> QHelpFilterEngine::namespaceToVersion() const
Renvoie une carte contenant tous les espaces de noms disponibles en tant que clés, ainsi que les versions associées en tant que valeurs.
QStringList QHelpFilterEngine::namespacesForFilter(const QString &filterName) const
Renvoie la liste de tous les espaces de noms de documentation enregistrés 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)
Modifie le filtre actuellement actif pour le remplacer par filterName.
Renvoie ` true ` si la modification du 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 existant identifié par filterName pour les remplacer par filterData. Si le filtre n'existe pas, un nouveau filtre est créé.
Renvoie ` true ` si la configuration du filtre a réussi, sinon renvoie ` false`.
Voir également 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.
