class QHelpIndexModel#

QHelpIndexModel类提供了一个模型,该模型为视图提供索引关键字。 更多信息

Inheritance diagram of PySide6.QtHelp.QHelpIndexModel

概述#

方法#

信号#

注意

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

详细描述#

createIndex(customFilterName)#
参数:

customFilterName – str

通过查询帮助系统以关键字的形式为指定的 customFilterName 创建一个新的索引。

filter(filter[, wildcard=""])#
参数:
  • filter – str

  • wildcard – str

返回类型:

QModelIndex

对索引进行筛选并返回最佳匹配关键字的模型索引。首先,只保留包含 filter 的关键字在模型索引列表中。如果 wildcard 不为空,则只保留匹配的关键字。其次,确定最佳匹配并返回其索引模型。在指定通配符表达式时,使用 filter 字符串来搜索最佳匹配。

helpEngine()#
返回类型:

QHelpEngineCore

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

indexCreated()#

当索引创建完成后,会发送此信号。

indexCreationStarted()#

当开始创建新索引时,会发送此信号。从此时起,当前索引在 indexCreated() 信号发送之前无效。

另请参阅

isCreatingIndex()

isCreatingIndex()#
返回类型:

bool

如果索引当前正在构建,则返回 true,否则返回 false。