QHelpSearchEngineCore Class
La classe QHelpSearchEngineCore permet d'accéder à l'index et à la recherche dans la documentation. En savoir plus...
| En-tête : | #include <QHelpSearchEngineCore> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake : | QT += help |
| Depuis : | Qt 6.8 |
| Hérite de : | QObject |
Fonctions publiques
| QHelpSearchEngineCore(QHelpEngineCore *helpEngine, QObject *parent = nullptr) | |
| virtual | ~QHelpSearchEngineCore() override |
| QString | searchInput() const |
| int | searchResultCount() const |
| QList<QHelpSearchResult> | searchResults(int start, int end) const |
Slots publics
| void | cancelIndexing() |
| void | cancelSearching() |
| void | reindexDocumentation() |
| void | search(const QString &searchInput) |
Signaux
| void | indexingFinished() |
| void | indexingStarted() |
| void | searchingFinished() |
| void | searchingStarted() |
Description détaillée
Avant de pouvoir utiliser le moteur de recherche, il faut instancier au moins un objet ` QHelpEngineCore `, qui doit être transmis au constructeur du moteur de recherche. Cette étape est nécessaire car le moteur de recherche doit être connecté au signal `setupFinished()` des moteurs d’aide afin de savoir quand il peut commencer à indexer la documentation.
Une fois le processus d’indexation lancé, le signal ` indexingStarted()` est émis ; à la fin de ce processus, c’est le signal ` indexingFinished()` qui est émis. Pour interrompre l’indexation, il est possible d’appeler la fonction ` cancelIndexing()`.
Une fois le processus d’indexation terminé, le moteur de recherche peut être utilisé pour rechercher un terme donné dans l’index à l’aide de la fonction search(). Lorsque la requête de recherche est transmise au moteur de recherche, le signal searchingStarted() est émis. À la fin de la recherche, le signal searchingFinished() est émis. Le processus de recherche peut être interrompu en appelant cancelSearching().
Si la recherche aboutit, la fonction ` searchingFinished()` est appelée avec le nombre de résultats afin de récupérer ces derniers depuis le moteur de recherche. L’appel de la fonction ` searchResults()` avec une plage renvoie une liste d’objets ` QHelpSearchResult ` compris dans cette plage. Les résultats comprennent le titre et l’URL du document, ainsi qu’un extrait du document contenant la correspondance la plus pertinente par rapport à la requête de recherche.
Documentation des fonctions membres
[explicit] QHelpSearchEngineCore::QHelpSearchEngineCore(QHelpEngineCore *helpEngine, QObject *parent = nullptr)
Crée un nouveau moteur de recherche à partir de l'parent fourni. Le moteur de recherche utilise l'helpEngine fourni pour accéder à la documentation à indexer. Le signal `setupFinished()` de l'QHelpEngineCore est automatiquement connecté à la fonction d'indexation du `QHelpSearchEngineCore`, de sorte que la nouvelle documentation soit indexée dès que ce signal est émis.
[override virtual noexcept] QHelpSearchEngineCore::~QHelpSearchEngineCore()
Détruit le moteur de recherche.
[slot] void QHelpSearchEngineCore::cancelIndexing()
Arrête le processus d'indexation.
[slot] void QHelpSearchEngineCore::cancelSearching()
Arrête le processus de recherche.
[signal] void QHelpSearchEngineCore::indexingFinished()
Ce signal est émis lorsque le processus d'indexation est terminé.
[signal] void QHelpSearchEngineCore::indexingStarted()
Ce signal est émis lorsque le processus d'indexation est lancé.
[slot] void QHelpSearchEngineCore::reindexDocumentation()
Force le moteur de recherche à réindexer tous les fichiers de documentation.
[slot] void QHelpSearchEngineCore::search(const QString &searchInput)
Lance le processus de recherche à l'aide de l'expression de recherche indiquée searchInput.
L'expression peut comporter plusieurs mots. Par défaut, le moteur de recherche renvoie la liste des documents contenant tous les mots spécifiés. L'expression peut contenir n'importe quelle combinaison des opérateurs logiques AND, OR et NOT. L'opérateur doit être écrit entièrement en majuscules, sinon il sera considéré comme faisant partie de l'expression de recherche.
Si des guillemets doubles sont utilisés pour regrouper les mots, le moteur de recherche recherchera une correspondance exacte de l'expression entre guillemets.
Pour plus d’informations sur la syntaxe des requêtes textuelles, consultez l’extension SQLite FTS5.
QString QHelpSearchEngineCore::searchInput() const
Renvoie la dernière expression recherchée.
int QHelpSearchEngineCore::searchResultCount() const
Renvoie le nombre de résultats trouvés par le moteur de recherche.
QList<QHelpSearchResult> QHelpSearchEngineCore::searchResults(int start, int end) const
Renvoie une liste des résultats de recherche compris entre l'index spécifié par ` start ` et l'index spécifié par ` end`.
[signal] void QHelpSearchEngineCore::searchingFinished()
Ce signal est émis lorsque le processus de recherche est terminé.
[signal] void QHelpSearchEngineCore::searchingStarted()
Ce signal est émis lorsque le processus de recherche est lancé.
© 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.
