QHelpIndexModel 类
QHelpIndexModel 类提供了一个模型,该模型为视图提供索引关键词。 更多...
| 头文件 | #include <QHelpIndexModel> | 
| CMake | find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help) | 
| qmake | QT += help | 
| 继承自 | QStringListModel | 
公共函数
| void | createIndex(const QString &customFilterName) | 
| QModelIndex | filter(const QString &filter, const QString &wildcard = QString()) | 
| QHelpEngineCore * | helpEngine() const | 
| bool | isCreatingIndex() const | 
信号
| void | indexCreated() | 
| void | indexCreationStarted() | 
成员函数文档
void QHelpIndexModel::createIndex(const QString &customFilterName)
通过查询帮助系统以指定 customFilterName 关键词创建一个新的索引。
QModelIndex QHelpIndexModel::filter(const QString &filter, const QString &wildcard = QString())
过滤索引并返回最佳匹配关键词的模型索引。首先,只保留包含 filter 的关键词在模型索引列表中。类似地,如果 wildcard 不为空,则只保留匹配的关键词。第二步,确定最佳匹配并返回其索引模型。指定通配符表达式时,使用 filter 字符串来搜索最佳匹配。
QHelpEngineCore *QHelpIndexModel::helpEngine() const
返回管理此模型的相关帮助引擎。
[signal] void QHelpIndexModel::indexCreated()
当索引创建时,发出此信号。
[signal] void QHelpIndexModel::indexCreationStarted()
此信号在创建新索引开始时发出。从此刻起,当前索引无效,直到发出信号indexCreated()。
另请参阅 isCreatingIndex。
bool QHelpIndexModel::isCreatingIndex() const
如果索引正在构建中,返回true,否则返回false。
© 2024 The Qt Company Ltd. 本文档中的贡献(文档)版权归各自所有者所有。本提供的文档是根据自由软件基金会发布的GNU自由文档许可版本1.3条款授权的。Qt及其相应标志是世界范围内芬兰和/或其他国家的商标。所有其他商标均归各自所有者所有。