En esta página

QHelpFilterEngine Class

La clase QHelpFilterEngine ofrece una vista filtrada de los contenidos de la ayuda. Más información...

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

Funciones públicas

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)

Señales

void filterActivated(const QString &newFilter)

Descripción detallada

El motor de filtros permite gestionar los filtros asociados a una instancia de ` QHelpEngineCore `. El motor de ayuda crea internamente una instancia del motor de filtros, a la que se puede acceder llamando a ` QHelpEngineCore::filterEngine()`. Por lo tanto, el constructor público de esta clase está deshabilitado.

Los filtros se identifican mediante una cadena de texto que indica el nombre del filtro. Los detalles de los filtros se describen en la clase QHelpFilterData.

El motor de filtrado permite añadir nuevos filtros y modificar los datos de los filtros existentes mediante el método setFilterData(). Un filtro existente puede eliminarse mediante el método removeFilter().

De entre los filtros registrados, se puede marcar uno como activo. El motor de ayuda asociado utilizará el filtro activo para devolver resultados filtrados de muchas funciones diferentes, como contenido, índice o resultados de búsqueda. Si no hay ningún filtro marcado como activo, el motor de ayuda devuelve la lista completa de resultados disponible.

El filtro activo se devuelve mediante ` activeFilter()` y se puede cambiar mediante ` setActiveFilter()`.

Véase también QHelpEngineCore.

Documentación de funciones miembro

QString QHelpFilterEngine::activeFilter() const

Devuelve el nombre del filtro activo en ese momento.

Véase también ` setActiveFilter()`.

QStringList QHelpFilterEngine::availableComponents() const

Devuelve la lista de todos los componentes disponibles definidos en todos los archivos de documentación registrados.

QList<QVersionNumber> QHelpFilterEngine::availableVersions() const

Devuelve la lista de todas las versiones disponibles definidas en todos los archivos de documentación registrados.

[signal] void QHelpFilterEngine::filterActivated(const QString &newFilter)

Esta señal se emite cuando se establece el filtro activo. « newFilter » especifica el nombre del filtro.

Véase también setActiveFilter().

QHelpFilterData QHelpFilterEngine::filterData(const QString &filterName) const

Devuelve los detalles del filtro asociados a filterName.

Véase también setFilterData().

QStringList QHelpFilterEngine::filters() const

Devuelve la lista de todos los nombres de filtros definidos en el motor de filtrado.

QStringList QHelpFilterEngine::indices() const

Devuelve una lista ordenada de los índices disponibles. El contenido de la lista devuelta depende del filtro activo y, por lo tanto, solo se devolverán los índices registrados para dicho filtro.

QStringList QHelpFilterEngine::indices(const QString &filterName) const

Devuelve una lista ordenada de índices disponibles, filtrada por ` filterName`. El contenido de la lista devuelta depende del filtro pasado; por lo tanto, solo se devolverán los índices registrados para este filtro. Si deseas obtener todos los índices disponibles sin filtrar, pasa una cadena vacía como ` filterName`.

QMap<QString, QString> QHelpFilterEngine::namespaceToComponent() const

Devuelve el mapa de todos los espacios de nombres disponibles como claves, junto con sus componentes asociados como valores.

QMap<QString, QVersionNumber> QHelpFilterEngine::namespaceToVersion() const

Devuelve el mapa de todos los espacios de nombres disponibles como claves, junto con sus versiones asociadas como valores.

QStringList QHelpFilterEngine::namespacesForFilter(const QString &filterName) const

Devuelve la lista de todos los espacios de nombres de documentación registrados que coinciden con el filtro identificado por filterName.

bool QHelpFilterEngine::removeFilter(const QString &filterName)

Elimina el filtro identificado por filterName.

Devuelve true si la eliminación del filtro se ha realizado correctamente; en caso contrario, devuelve false.

bool QHelpFilterEngine::setActiveFilter(const QString &filterName)

Cambia el filtro actualmente activo a « filterName ».

Devuelve « true » si el cambio de filtro se ha realizado correctamente; en caso contrario, devuelve « false ».

Véase también activeFilter().

bool QHelpFilterEngine::setFilterData(const QString &filterName, const QHelpFilterData &filterData)

Modifica los detalles del filtro existente identificado por filterName para que pasen a ser filterData. Si el filtro no existe, se crea uno nuevo.

Devuelve true si la configuración del filtro se ha realizado correctamente; en caso contrario, devuelve false.

Véase también 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.