PySide6.QtHelp.QHelp搜索引擎¶
- class QHelpSearchEngine¶
QHelpSearchEngine类提供了可重用的部件，用于集成全文搜索以及索引和搜索文档。更多…概要¶
方法¶
def
__init__()def
hitCount()def
hits()def
hitsCount()def
query()def
queryWidget()def
resultWidget()def
searchInput()def
searchResults()
插槽¶
def
cancelIndexing()def
search()
信号¶
注意
本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。
详细描述¶
在使用搜索引擎之前，必须至少实例化一个
QHelpEngineCore对象，并将其传递给搜索引擎的构造函数。这是必需的，因为搜索引擎需要连接到帮助引擎的setupFinished()信号，以了解何时可以开始索引文档。在启动索引过程后，信号
indexingStarted()被发出，在索引过程结束时，indexingFinished()被发出。要停止索引，可以调用cancelIndexing()。当索引过程完成后，可以使用搜索引擎通过search()函数在索引中搜索给定的术语。当搜索输入传递给搜索引擎时，会发出
searchingStarted()信号。当搜索完成时，会发出searchingFinished()信号。可以通过调用cancelSearching()来停止搜索过程。如果搜索成功，将调用
searchingFinished()并传入搜索结果计数以从搜索引擎获取搜索结果。使用范围调用searchResults()函数将返回该范围内的QHelpSearchResult对象列表。结果包括文档标题和URL，以及文档中包含搜索输入最佳匹配的片段。要显示给定的搜索结果，请使用
QHelpSearchResultWidget，或者如果您需要更高级的功能，可以构建自己的小部件。请注意，QHelpSearchResultWidget不能直接实例化，您必须从使用的搜索引擎中检索小部件，因为所有连接都将由小部件本身为您建立。- __init__(helpEngine[, parent=None])¶
- Parameters:
helpEngine –
QHelpEngineCoreparent –
QObject
使用给定的
parent构造一个新的搜索引擎。该搜索引擎使用给定的helpEngine来访问需要索引的文档。QHelpEngine的setupFinished()信号会自动连接到QHelpSearchEngine的索引函数，以便在信号发出后对新文档进行索引。- cancelIndexing()¶
停止索引过程。
- cancelSearching()¶
停止搜索过程。
- hitCount()¶
- Return type:
整数
注意
此函数已弃用。
请使用
searchResultCount()代替。- hits(start, end)¶
- Parameters:
start – int
end – 整数
- Return type:
.std.pairQString,QString 的列表
注意
此函数已弃用。
请使用
searchResults()代替。- hitsCount()¶
- Return type:
整数
注意
此函数已弃用。
请使用
searchResultCount()代替。- indexingFinished()¶
当索引过程完成时，会发出此信号。
- indexingStarted()¶
当索引过程开始时，会发出此信号。
- query()¶
- Return type:
注意
此函数已弃用。
请使用
searchInput()代替。- queryWidget()¶
- Return type:
返回一个用作输入小部件的部件。根据您的搜索引擎配置，您将获得一个具有或多或少子部件的不同部件。
- reindexDocumentation()¶
强制搜索引擎重新索引所有文档文件。
- resultWidget()¶
- Return type:
返回一个可以容纳并显示搜索结果的小部件。
- scheduleIndexDocumentation()¶
- search(queryList)¶
- Parameters:
queryList – QHelpSearchQuery 的列表
注意
此函数已弃用。
请使用 search(const QString &
searchInput) 代替。- search(searchInput)
- Parameters:
searchInput – str
使用给定的搜索短语
searchInput开始搜索过程。短语可能由多个单词组成。默认情况下，搜索引擎返回包含所有指定单词的文档列表。短语可以包含逻辑运算符AND、OR和NOT的任意组合。运算符必须全部大写，否则将被视为搜索短语的一部分。
如果使用双引号将单词分组，搜索引擎将搜索引号内短语的完全匹配。
有关文本查询语法的更多信息，请参阅SQLite FTS5 Extension。
- searchInput()¶
- Return type:
字符串
返回上次搜索的短语。
- searchResultCount()¶
- Return type:
整数
返回搜索引擎找到的结果数量。
- searchResults(start, end)¶
- Parameters:
start – int
end – 整数
- Return type:
返回从
start指定的索引到end指定的索引范围内的搜索结果列表。- searchingFinished(searchResultCount)¶
- Parameters:
searchResultCount – int
当搜索过程完成时，会发出此信号。搜索结果计数存储在
searchResultCount中。- searchingStarted()¶
当搜索过程开始时，会发出此信号。