QHelpFilterEngine 类

QHelpFilterEngine 类提供了帮助内容的筛选视图。更多...

头文件	#include <QHelpFilterEngine>
CMake	find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake	QT += help
继承	QObject

包括继承成员在内的所有成员列表

公共函数

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)

信号

void	filterActivated(const QString &newFilter)

详细描述

筛选引擎允许管理与一个 QHelpEngineCore 实例关联的筛选器。帮助引擎在内部创建一个筛选引擎的实例，可以通过调用 QHelpEngineCore::filterEngine()() 来访问它。因此，本类的公共构造函数已被禁用。

筛选器通过筛选器名称字符串进行标识。筛选器详细信息由 QHelpFilterData 类描述。

筛选引擎允许通过 setFilterData() 方法添加新的筛选器并更改现有筛选器的数据。可以通过 removeFilter() 方法移除现有筛选器。

可以从注册的筛选器中标记一个作为活动的一个。活动筛选器将被关联的帮助引擎用于返回许多不同函数的筛选结果，例如内容、索引或搜索结果。如果没有标记活动筛选器，帮助引擎将返回所有可用的完整结果列表。

当前的活动过滤器可通过activeFilter()函数返回，且可通过setActiveFilter()函数进行修改。

另请参阅QHelpEngineCore。

成员函数文档

QString QHelpFilterEngine::activeFilter() const

返回当前活动过滤器的名称。

另请参阅setActiveFilter。

QStringList QHelpFilterEngine::availableComponents() const

返回所有注册文档文件中定义的所有可用组件的列表。

QList<QVersionNumber> QHelpFilterEngine::availableVersions() const

返回所有注册文档文件中定义的所有可用版本的列表。

`[信号]` void QHelpFilterEngine::filterActivated(const QString &newFilter)

当设置活动过滤器时发出此信号。newFilter指定的过滤器名称。

另请参阅setActiveFilter。

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

返回与filterName关联的过滤器详情。

另请参阅setFilterData。

QStringList QHelpFilterEngine::filters() const

返回在过滤器引擎中定义的所有过滤器名称的列表。

QStringList QHelpFilterEngine::indices() const

返回可用索引的排序列表。返回列表的内容取决于活动过滤器，因此只返回注册给活动过滤器的索引。

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

返回由filterName过滤的可用索引的排序列表。返回列表的内容取决于传递的过滤器，因此只返回为此过滤器注册的索引。如果您想获取所有未过滤的可用索引，请传递空字符串作为filterName。

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

返回所有可用名称空间（作为键）及其相关的组件（作为值）的映射。

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

返回所有可用名称空间（作为键）及其相关的版本（作为值）的映射。

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

返回所有已注册的文档命名空间列表，这些命名空间与 filterName 指定的筛选器匹配。

bool QHelpFilterEngine::removeFilter(const QString &filterName)

移除由 filterName 指定的筛选器。

如果移除筛选器成功，则返回 true，否则返回 false。

bool QHelpFilterEngine::setActiveFilter(const QString &filterName)

将当前活动的筛选器更改为 filterName。

如果更改筛选器成功，则返回 true，否则返回 false。

另请参阅 activeFilter()。

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

更改由 filterName 指定的筛选器的现有筛选器详细信息到 filterData。如果筛选器不存在，将创建一个新筛选器。

如果设置筛选器成功，则返回 true，否则返回 false。

另请参阅 filterData()。