class QHelpFilterEngine#

该 QHelpFilterEngine 类提供了帮助内容的筛选视图。更多信息…

概要#

方法#

def __init__()
def activeFilter()
def availableComponents()
def availableVersions()
定义 filterData()
定义 filters()
定义 indices()
定义 namespaceToComponent()
定义 namespaceToVersion()
定义 namespacesForFilter()
定义 removeFilter()
定义 setActiveFilter()
定义 setFilterData()

信号#

定义 filterActivated()

注意

本文档可能包含自动从C++翻译到Python的代码片段。我们始终欢迎对片段翻译的贡献。如果您发现翻译问题，也可以通过在https:/bugreports.qt.io/projects/PYSIDE创建工单的方式告诉我们。

详细说明#

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

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

过滤器引擎允许通过setFilterData()方法添加新过滤器以及更改现有过滤器的数据。可以通过removeFilter()方法删除现有过滤器。

在注册的过滤器中，可以将其中一个标记为活动过滤器。活动过滤器将由关联的帮助引擎用于返回许多不同功能的过滤结果，例如内容、索引或搜索结果。如果没有标记活动过滤器，帮助引擎将返回可用结果的全列表。

活动过滤器由activeFilter()返回，并且可以通过setActiveFilter()进行修改。

另请参阅

QHelpEngineCore

__init__(helpEngine)#

参数:: helpEngine – QHelpEngineCore

activeFilter()#

返回类型:: str

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

另请参阅

setActiveFilter()

availableComponents()#

返回类型:: 字符串列表

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

availableVersions()#

返回类型:: 版本列表QVersionNumber

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

filterActivated(newFilter)#

参数:: newFilter – str

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

另请参阅

setActiveFilter()

filterData(filterName)#

参数:: filterName – str
返回类型:: QHelpFilterData

返回与filterName相关联的过滤器详细信息。

另请参阅

setFilterData()

filters()#

返回类型:: 字符串列表

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

indices()#

返回类型:: 字符串列表

返回一个排序后的可用索引列表。返回列表的内容取决于活动过滤器，因此仅返回已为活动过滤器注册的索引。

indices(filterName)

参数:: filterName – str
返回类型:: 字符串列表

返回一个排序后的有效索引列表，通过filterName过滤。返回列表的内容取决于传递的过滤器，因此仅返回已为此过滤器注册的索引。如果您想获取未过滤的所有索引，请将空字符串作为filterName传递。

namespaceToComponent()#

返回类型:: 键为 .QString 类型、值为 QString 类型的字典。

返回所有可用命名空间及其关联组件的映射。

namespaceToVersion()#

返回类型:: 键为 .QString 类型、值为 QVersionNumber 类型的字典。

返回所有可用命名空间及其关联版本的映射。

namespacesForFilter(filterName)#

参数:: filterName – str
返回类型:: 字符串列表

返回与由 filterName 标识的过滤器匹配的所有已注册文档命名空间的列表。

removeFilter(filterName)#

参数:: filterName – str
返回类型:: bool

移除由 filterName 标识的过滤器。

如果移除过滤器成功，则返回 true，否则返回 false。

setActiveFilter(filterName)#

参数:: filterName – str
返回类型:: bool

将当前活动过滤器更改为 filterName。

如果更改过滤器成功，则返回 true，否则返回 false。

另请参阅

activeFilter()

setFilterData(filterName, filterData)#

参数:

filterName – str
filterData – QHelpFilterData

返回类型:

bool

将指定为 filterName 的过滤器的现有过滤器细节更改为 filterData。如果该过滤器不存在，则创建一个新过滤器。

如果设置过滤器成功，则返回 true，否则返回 false。

另请参阅

filterData()