QHelpSearchEngine 类

QHelpSearchEngine 类提供对可重复使用的小部件的访问，以集成全文搜索以及索引和搜索文档。更多...

头文件	#include <QHelpSearchEngine>
CMake	find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake	QT += help
继承	QObject

公有函数

	QHelpSearchEngine(QHelpEngineCore *帮助引擎, QObject *父 = nullptr)
虚拟	~QHelpSearchEngine()
QHelpSearchQueryWidget *	查询小部件()
QHelpSearchResultWidget *	结果小部件()
QString	searchInput() const
int	searchResultCount() const
QList<QHelpSearchResult>	searchResults(int 开始, int 结束) const

公有槽

void	cancelIndexing()
void	cancelSearching()
void	reindexDocumentation()
void	search(const QString &searchInput)

信号

void	indexingFinished()
void	indexingStarted()
void	searchingFinished(int searchResultCount)
void	searchingStarted()

详细描述

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

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

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

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

要显示给定的搜索结果，请使用QHelpSearchResultWidget 或者如果你需要更高级的功能，自行构建。请注意，QHelpSearchResultWidget 不能直接实例化，你必须从使用的搜索引擎中检索小部件，因为所有连接都由小部件自己为你建立。

成员函数文档

`[explicit]` QHelpSearchEngine::QHelpSearchEngine(QHelpEngineCore **helpEngine*, QObject **parent* = nullptr)

使用给定的 parent 构造一个新搜索引擎。搜索引擎使用给定的 helpEngine 来访问需要索引的文档。QHelpEngine的setupFinished()信号自动连接到QHelpSearchEngine的索引函数，因此信号发出后，将开始索引新文档。

`[virtual noexcept]` QHelpSearchEngine::~QHelpSearchEngine()

销毁搜索引擎。

`[slot]` void QHelpSearchEngine::cancelIndexing()

停止索引进程。

`[slot]` void QHelpSearchEngine::cancelSearching()

停止搜索进程。

`[signal]` void QHelpSearchEngine::indexingFinished()

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

`[signal]` void QHelpSearchEngine::indexingStarted()

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

QHelpSearchQueryWidget *QHelpSearchEngine::queryWidget()

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

`[slot]` void QHelpSearchEngine::reindexDocumentation()

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

QHelpSearchResultWidget *QHelpSearchEngine::resultWidget()

返回一个可以保存并显示搜索结果的小部件。

`[slot]` void QHelpSearchEngine::search(const QString &searchInput)

使用给定的搜索短语 searchInput 开始搜索进程。

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

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

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

QString QHelpSearchEngine::searchInput() const

返回最后一次搜索的短语。

int QHelpSearchEngine::searchResultCount() const

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

QList<QHelpSearchResult> QHelpSearchEngine::searchResults(int start, int end) const

返回从由start指定到由end指定的索引范围内的搜索结果列表。

`[信号]` void QHelpSearchEngine::searchingFinished(int searchResultCount)

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

`[信号]` void QHelpSearchEngine::searchingStarted()

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

QHelpSearchEngine 类

公有函数

公有槽

信号

详细描述

成员函数文档

[explicit] QHelpSearchEngine::QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent = nullptr)

[virtual noexcept] QHelpSearchEngine::~QHelpSearchEngine()

[slot] void QHelpSearchEngine::cancelIndexing()

[slot] void QHelpSearchEngine::cancelSearching()

[signal] void QHelpSearchEngine::indexingFinished()

[signal] void QHelpSearchEngine::indexingStarted()