En esta página

QHelpSearchEngine Class

La clase QHelpSearchEngine permite acceder a widgets reutilizables para integrar la búsqueda de texto completo, así como para indexar y buscar documentación. Más información...

Encabezado: #include <QHelpSearchEngine>
CMake: find_package(Qt6 REQUIRED COMPONENTS Help)
target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake: QT += help
Heredado de: QObject

Funciones públicas

QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent = nullptr)
virtual ~QHelpSearchEngine()
QHelpSearchQueryWidget *queryWidget()
QHelpSearchResultWidget *resultWidget()
QString searchInput() const
int searchResultCount() const
QList<QHelpSearchResult> searchResults(int start, int end) const

Ranuras públicas

void cancelIndexing()
void cancelSearching()
void reindexDocumentation()
void search(const QString &searchInput)

Señales

void indexingFinished()
void indexingStarted()
void searchingFinished(int searchResultCount)
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 conectarse a la señal `setupFinished()` de los motores de ayuda para saber cuándo puede empezar a indexar la documentación.

Tras iniciar 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 mismo que contiene la mejor coincidencia con la consulta de búsqueda.

Para mostrar los resultados de búsqueda obtenidos, utiliza el QHelpSearchResultWidget o crea uno propio si necesitas una funcionalidad más avanzada. Ten en cuenta que el QHelpSearchResultWidget no se puede instanciar directamente; debes recuperar el widget del motor de búsqueda que estés utilizando, ya que el propio widget se encargará de establecer todas las conexiones por ti.

Documentación de las funciones miembro

[explicit] QHelpSearchEngine::QHelpSearchEngine(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() del QHelpEngine se conecta automáticamente a la función de indexación del QHelpSearchEngine, de modo que la nueva documentación se indexará una vez emitida la señal.

[virtual noexcept] QHelpSearchEngine::~QHelpSearchEngine()

Destruye el motor de búsqueda.

[slot] void QHelpSearchEngine::cancelIndexing()

Detiene el proceso de indexación.

[slot] void QHelpSearchEngine::cancelSearching()

Detiene el proceso de búsqueda.

[signal] void QHelpSearchEngine::indexingFinished()

Esta señal se emite cuando finaliza el proceso de indexación.

[signal] void QHelpSearchEngine::indexingStarted()

Esta señal se emite cuando se inicia el proceso de indexación.

QHelpSearchQueryWidget *QHelpSearchEngine::queryWidget()

Devuelve un widget para utilizarlo como widget de entrada. Dependiendo de la configuración de tu motor de búsqueda, obtendrás un widget diferente con más o menos subwidgets.

[slot] void QHelpSearchEngine::reindexDocumentation()

Obliga al motor de búsqueda a volver a indexar todos los archivos de documentación.

QHelpSearchResultWidget *QHelpSearchEngine::resultWidget()

Devuelve un widget capaz de almacenar y mostrar los resultados de la búsqueda.

[slot] void QHelpSearchEngine::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 SQLite FTS5.

Nota: Esta ranura está sobrecargada. Para conectarse a esta ranura:

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        helpSearchEngine, qOverload(&QHelpSearchEngine::search));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        helpSearchEngine, [receiver = helpSearchEngine](const QString &searchInput) { receiver->search(searchInput); });
Para ver más ejemplos y métodos, consulta «Conexión a ranuras sobrecargadas».

QString QHelpSearchEngine::searchInput() const

Devuelve la última frase buscada.

int QHelpSearchEngine::searchResultCount() const

Devuelve el número de resultados que ha encontrado el motor de búsqueda.

QList<QHelpSearchResult> QHelpSearchEngine::searchResults(int start, int end) const

Devuelve una lista de resultados de búsqueda dentro del rango comprendido entre el índice especificado por start y el índice especificado por end.

[signal] void QHelpSearchEngine::searchingFinished(int searchResultCount)

Esta señal se emite cuando finaliza el proceso de búsqueda. El recuento de resultados de la búsqueda se almacena en searchResultCount.

[signal] void QHelpSearchEngine::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.