QHelpSearchEngine Class
La clase QHelpSearchEngine proporciona acceso a widgets reutilizables para integrar la búsqueda de texto completo, así como para indexar y buscar documentación. Más...
| Cabecera: | #include <QHelpSearchEngine> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Help)target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake: | QT += help |
| Hereda: | 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 buscador, hay que instanciar al menos un objeto QHelpEngineCore que hay que pasar al constructor del buscador. Esto es necesario ya que el motor de búsqueda necesita estar conectado a la señal setupFinished() de los motores de ayuda para saber cuándo puede empezar a indexar la documentación.
Después de iniciar el proceso de indexación se emite la señal indexingStarted() y al final del proceso de indexación se emite la señal indexingFinished(). Para detener la indexación se puede llamar a cancelIndexing().
Una vez finalizado el proceso de indexación, se puede utilizar el motor de búsqueda para buscar en el índice un término determinado mediante la función search(). Cuando se pasa la entrada de búsqueda al motor de búsqueda, se emite la señal searchingStarted(). Cuando finaliza 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 de la búsqueda para obtener los resultados del motor de búsqueda. La llamada a la función searchResults() con un rango devuelve una lista de objetos QHelpSearchResult dentro del 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 entrada de búsqueda.
Para mostrar los resultados de la búsqueda, utilice QHelpSearchResultWidget o cree uno propio si necesita una funcionalidad más avanzada. Tenga en cuenta que el QHelpSearchResultWidget no puede ser instanciado directamente, debe recuperar el widget del motor de búsqueda en uso ya que todas las conexiones serán establecidas para usted por el propio widget.
Documentación de las funciones miembro
[explicit] QHelpSearchEngine::QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent = nullptr)
Crea un nuevo motor de búsqueda con la dirección parent. El motor de búsqueda utiliza el helpEngine dado para acceder a la documentación que necesita ser indexada. La señal setupFinished() de QHelpEngine se conecta automáticamente a la función de indexación de QHelpSearchEngine, de modo que la nueva documentación se indexará después de que se emita 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 usar como widget de entrada. Dependiendo de la configuración de tu buscador obtendrás un widget diferente con más o menos subwidgets.
[slot] void QHelpSearchEngine::reindexDocumentation()
Obliga al motor de búsqueda a reindexar todos los archivos de documentación.
QHelpSearchResultWidget *QHelpSearchEngine::resultWidget()
Devuelve un widget que puede contener 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 dada 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 entrecomillada.
Para más información sobre la sintaxis de la consulta de texto, véase Extensión FTS5 de SQLite.
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); }); QString QHelpSearchEngine::searchInput() const
Devuelve la frase que se buscó por última vez.
int QHelpSearchEngine::searchResultCount() const
Devuelve el número de resultados que ha encontrado el buscador.
QList<QHelpSearchResult> QHelpSearchEngine::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 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.
