class QHelpSearchEngine#

QHelpSearchEngine 类提供了访问可重复使用的widgets的权限，用于集成全文搜索以及索引和搜索文档。《更多》…

摘要#

方法#

def __init__()
def hitCount()
def hits()
def hitsCount()
定义 query()
定义 queryWidget()
定义 resultWidget()
定义 searchInput()
定义 searchResultCount()
定义 searchResults()

槽#

定义 cancelIndexing()
定义 cancelSearching()
定义 reindexDocumentation()
定义 scheduleIndexDocumentation()
定义 search()

注意

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

详细描述#

在可以使用搜索引擎之前，必须至少实例化一个 QHelpEngineCore 对象，并将其传递给搜索引擎的构造函数。这是必需的，因为搜索引擎需要连接到帮助引擎的 setupFinished() 信号以了解何时可以开始索引文档。

在开始索引过程后，将发出信号 indexingStarted()，在索引过程结束时将发出信号 indexingFinished()。要停止索引，可以调用 cancelIndexing()。

当索引过程完成后，可以使用搜索函数通过索引搜索给定术语。当搜索输入传递给搜索引擎时，将发出信号 searchingStarted()。当搜索完成后，将发出信号 searchingFinished()。可以通过调用 cancelSearching() 来停止搜索过程。

如果搜索成功，将调用 searchingFinished() 并携带搜索结果数量，以从搜索引擎中检索搜索结果。使用带有范围参数的函数 searchResults() 返回指定范围内的 QHelpSearchResult 对象列表。结果包括文档标题和URL，以及包含最佳匹配搜索输入的文档片段。

要显示指定搜索结果，可以使用 QHelpSearchResultWidget 或根据需要构建自己的一个，注意 QHelpSearchResultWidget 不能直接实例化，您必须从使用的搜索引擎中检索组件，因为所有连接都会由组件本身为您建立。

__init__(helpEngine[, parent=None])#

参数：

helpEngine – QHelpEngineCore
parent – QObject

使用指定的 parent 构建一个新的搜索引擎。搜索引擎使用指定的 helpEngine 访问需要索引的文档。QHelpEngine 的 setupFinished() 信号自动连接到 QHelpSearchEngine 的索引功能，以便在新信号发出后索引新的文档。

cancelIndexing()#

停止索引过程。

cancelSearching()#

停止搜索过程。

hitCount()#

返回类型：: int

注意

此函数已弃用。

请使用 searchResultCount 替代。

hits(start, end)#

参数：

start – int
end – int

返回类型：

std.pair QString, QString 的列表

注意

此函数已弃用。

请使用 searchResults 替代。

hitsCount()#

返回类型：: int

注意

此函数已弃用。

请使用 searchResultCount 替代。

indexingFinished()#

索引过程完成后发出此信号。

indexingStarted()#

索引过程开始时发出此信号。

query()#

返回类型：: QHelpSearchQuery 列表

注意

此函数已弃用。

请使用 searchInput 替代。

queryWidget()#

返回类型：: QHelpSearchQueryWidget

返回一个用作输入小部件的部件。根据您的搜索引擎配置，您将得到一个不同的小部件，具有更多或更少的子部件。

reindexDocumentation()#

强制搜索引擎重新索引所有文档文件。

resultWidget()#

返回类型：: QHelpSearchResultWidget

返回一个可以存储和显示搜索结果的控件。

scheduleIndexDocumentation()#

search(queryList)#

参数：: queryList – .list of QHelpSearchQuery

注意

此函数已弃用。

请使用 search(const QString & searchInput ) 替代。

search(searchInput)

参数：: searchInput – str

使用给定的搜索词 searchInput 开始搜索过程。

该词可以由多个单词组成。默认情况下，搜索引擎返回包含所有指定单词的文档列表。该词可以包含 AND、OR 和 NOT 的任何组合的逻辑运算符。运算符必须全部大写，否则将被视为搜索词的一部分。

如果使用双引号将单词分组，搜索引擎将搜索完全匹配的引号短语。

有关文本查询语法的更多信息，请参阅 SQLite FTS5 扩展。

searchInput()#

返回类型：: str

返回最后搜索的短语。

searchResultCount()#

返回类型：: int

返回搜索引擎找到的结果数量。

searchResults(start, end)#

参数：

start – int
end – int

返回类型：

.list of QHelpSearchResult

返回从索引 start 到 end 的搜索结果列表。

searchingFinished(searchResultCount)#

参数：: searchResultCount – int

当搜索过程完成时，发出此信号。搜索结果数量存储在 searchResultCount 中。

searchingStarted()#

当搜索过程开始时，发出此信号。