PySide6.QtHelp.QHelpFilterEngine¶

class QHelpFilterEngine¶

QHelpFilterEngine 类提供了帮助内容的过滤视图。更多…

概要¶

方法¶

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

信号¶

def filterActivated()

注意

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

详细描述¶

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

过滤器通过一个过滤器名称字符串来识别。过滤器的详细信息由QHelpFilterData类描述。

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

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

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

另请参阅

QHelpEngineCore

__init__(helpEngine)¶

Parameters:: helpEngine – QHelpEngineCore

activeFilter()¶

Return type:: 字符串

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

另请参阅

setActiveFilter()

availableComponents()¶

Return type:: 字符串列表

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

availableVersions()¶

Return type:: QVersionNumber的列表

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

filterActivated(newFilter)¶

Parameters:: newFilter – str

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

另请参阅

setActiveFilter()

filterData(filterName)¶

Parameters:: filterName – str
Return type:: QHelpFilterData

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

另请参阅

setFilterData()

filters()¶

Return type:: 字符串列表

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

indices()¶

Return type:: 字符串列表

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

indices(filterName)

Parameters:: filterName – str
Return type:: 字符串列表

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

namespaceToComponent()¶

Return type:: 字典的键类型为 .QString，值类型为 QString。

返回所有可用命名空间的映射，其中键为命名空间，值为其关联的组件。

namespaceToVersion()¶

Return type:: 字典的键类型为 .QString，值类型为 QVersionNumber。

返回所有可用命名空间的映射，其中键为命名空间名称，值为其关联的版本。

namespacesForFilter(filterName)¶

Parameters:: filterName – str
Return type:: 字符串列表

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

removeFilter(filterName)¶

Parameters:: filterName – str
Return type:: 布尔

移除由 filterName 标识的过滤器。

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

setActiveFilter(filterName)¶

Parameters:: filterName – str
Return type:: 布尔

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

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

另请参阅

activeFilter()

setFilterData(filterName, filterData)¶

Parameters:

filterName – str
filterData – QHelpFilterData

Return type:

布尔

将标识为filterName的过滤器的现有过滤器详细信息更改为filterData。如果过滤器不存在，则会创建一个新的过滤器。

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

另请参阅

filterData()