QHelpSearchEngineCore Class
La clase QHelpSearchEngineCore permite acceder a la documentación para indexarla y buscarla. Más información...
| Encabezado: | #include <QHelpSearchEngineCore> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake: | QT += help |
| Desde: | Qt 6.8 |
| Heredado de: | QObject |
Funciones públicas
| QHelpSearchEngineCore(QHelpEngineCore *helpEngine, QObject *parent = nullptr) | |
| virtual | ~QHelpSearchEngineCore() override |
| QString | searchInput() const |
| int | searchResultCount() const |
| QList<QHelpSearchResult> | searchResults(int start, int end) const |
Slots públicos
| void | cancelIndexing() |
| void | cancelSearching() |
| void | reindexDocumentation() |
| void | search(const QString &searchInput) |
Señales
| void | indexingFinished() |
| void | indexingStarted() |
| void | searchingFinished() |
| void | searchingStarted() |
Descripción detallada
Antes de poder utilizar el motor de búsqueda, es necesario instanciar al menos un objeto ` QHelpEngineCore `, que debe pasarse al constructor del motor de búsqueda. Esto es necesario porque el motor de búsqueda debe estar conectado a la señal `setupFinished()` de los motores de ayuda para saber cuándo puede comenzar a indexar la documentación.
Una vez iniciado el proceso de indexación, se emite la señal ` indexingStarted()` y, al finalizar dicho proceso, se emite la señal ` indexingFinished()`. Para detener la indexación, se puede llamar a ` cancelIndexing()`.
Una vez finalizado el proceso de indexación, el motor de búsqueda puede utilizarse para buscar un término determinado en el índice mediante la función ` search()`. Cuando se envía la consulta de búsqueda al motor de búsqueda, se emite la señal ` searchingStarted()`. Al finalizar la búsqueda, se emite la señal ` searchingFinished()`. El proceso de búsqueda puede detenerse llamando a ` cancelSearching()`.
Si la búsqueda tiene éxito, se llama a ` searchingFinished()` con el recuento de resultados para obtener los resultados del motor de búsqueda. Al llamar a la función ` searchResults()` con un rango, se devuelve una lista de objetos ` QHelpSearchResult ` dentro de dicho rango. Los resultados consisten en el título y la URL del documento, así como un fragmento del documento que contiene la mejor coincidencia con la consulta de búsqueda.
Documentación de las funciones de miembro
[explicit] QHelpSearchEngineCore::QHelpSearchEngineCore(QHelpEngineCore *helpEngine, QObject *parent = nullptr)
Crea un nuevo motor de búsqueda con el parent proporcionado. El motor de búsqueda utiliza el helpEngine proporcionado para acceder a la documentación que debe indexarse. La señal setupFinished() de QHelpEngineCore se conecta automáticamente a la función de indexación de QHelpSearchEngineCore, de modo que la nueva documentación se indexará una vez que se emita la señal.
[override virtual noexcept] QHelpSearchEngineCore::~QHelpSearchEngineCore()
Destruye el motor de búsqueda.
[slot] void QHelpSearchEngineCore::cancelIndexing()
Detiene el proceso de indexación.
[slot] void QHelpSearchEngineCore::cancelSearching()
Detiene el proceso de búsqueda.
[signal] void QHelpSearchEngineCore::indexingFinished()
Esta señal se emite cuando finaliza el proceso de indexación.
[signal] void QHelpSearchEngineCore::indexingStarted()
Esta señal se emite cuando se inicia el proceso de indexación.
[slot] void QHelpSearchEngineCore::reindexDocumentation()
Obliga al motor de búsqueda a volver a indexar todos los archivos de documentación.
[slot] void QHelpSearchEngineCore::search(const QString &searchInput)
Inicia el proceso de búsqueda utilizando la frase de búsqueda indicada: « searchInput ».
La frase puede constar de varias palabras. Por defecto, el motor de búsqueda devuelve la lista de documentos que contienen todas las palabras especificadas. La frase puede contener cualquier combinación de los operadores lógicos AND, OR y NOT. El operador debe escribirse en mayúsculas; de lo contrario, se considerará parte de la frase de búsqueda.
Si se utilizan comillas dobles para agrupar las palabras, el motor de búsqueda buscará una coincidencia exacta de la frase entre comillas.
Para obtener más información sobre la sintaxis de las consultas de texto, consulta la extensión FTS5 de SQLite.
QString QHelpSearchEngineCore::searchInput() const
Devuelve la última frase buscada.
int QHelpSearchEngineCore::searchResultCount() const
Devuelve el número de resultados que ha encontrado el motor de búsqueda.
QList<QHelpSearchResult> QHelpSearchEngineCore::searchResults(int start, int end) const
Devuelve una lista de resultados de búsqueda dentro del intervalo comprendido entre el índice especificado por start y el índice especificado por end.
[signal] void QHelpSearchEngineCore::searchingFinished()
Esta señal se emite cuando finaliza el proceso de búsqueda.
[signal] void QHelpSearchEngineCore::searchingStarted()
Esta señal se emite cuando se inicia el proceso de búsqueda.
© 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.