PySide6.QtHelp.QHelpIndexModel¶

class QHelpIndexModel¶

QHelpIndexModel 类提供了一个模型，用于向视图提供索引关键字。更多…

概要¶

方法¶

• def createIndex()

• def createIndexForCurrentFilter()

• def filter()

• def helpEngine()

• def isCreatingIndex()

信号¶

• def indexCreated()

• def indexCreationStarted()

注意

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

详细描述¶

createIndex(customFilterName)¶

Parameters:

customFilterName – str

通过查询帮助系统以获取指定自定义filter名称的关键字来创建新索引。

createIndexForCurrentFilter()¶

通过查询帮助系统以获取当前过滤器的关键字来创建新索引。

filter(filter[, wildcard={}])¶

Parameters:

• filter – str

• wildcard – str

Return type:

QModelIndex

过滤索引并返回最佳匹配关键词的模型索引。第一步，只有包含filter的关键词会保留在模型的索引列表中。类似地，如果wildcard不为空，则只有匹配的关键词会保留在索引列表中。第二步，确定最佳匹配并返回其索引模型。当指定通配符表达式时，filter字符串用于搜索最佳匹配。

helpEngine()¶

Return type:

QHelpEngineCore

返回管理此模型的关联帮助引擎。

indexCreated()¶

当索引被创建时，会发出此信号。

indexCreationStarted()¶

当开始创建新索引时，会发出此信号。从此时起，当前索引无效，直到发出信号 indexCreated()。

另请参阅

isCreatingIndex()

isCreatingIndex()¶

Return type:

布尔

如果索引当前已构建，则返回 true，否则返回 false。