Back to Qt.io
Contact Us Blog Download Qt

QHelpSearchEngineCore Class

QHelpSearchEngineCore 类提供对索引和搜索文档的访问。更多

Header： #include <QHelpSearchEngineCore>
CMake： find_package(Qt6 REQUIRED COMPONENTS Help)
target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake： QT += help
自Qt 6.8
继承： QObject

公共函数

QHelpSearchEngineCore(QHelpEngineCore *helpEngine, QObject *parent = nullptr)
virtual ~QHelpSearchEngineCore() override
QString searchInput() const
int searchResultCount() const
QList<QHelpSearchResult> searchResults(int start, int end) const

公共插槽

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

信号

void indexingFinished()
void indexingStarted()
void searchingFinished()
void searchingStarted()

详细说明

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

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

索引过程结束后，搜索引擎可以使用search() 函数在索引中搜索给定的术语。搜索输入传递给搜索引擎时，会发出searchingStarted() 信号。搜索结束后，将发出searchingFinished() 信号。搜索过程可以通过调用cancelSearching() 停止。

如果搜索成功，则会调用searchingFinished() 并输入搜索结果计数，以便从搜索引擎获取搜索结果。使用范围调用searchResults() 函数将返回范围内QHelpSearchResult 对象的列表。搜索结果包括文档标题和 URL，以及与搜索输入最匹配的文档片段。

成员函数文档

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

使用给定的parent 构建一个新的搜索引擎。搜索引擎使用给定的helpEngine 访问需要索引的文档。QHelpEngineCore 的 setupFinished() 信号会自动连接到 QHelpSearchEngineCore 的索引函数，因此新文档将在信号发出后被索引。

[override virtual noexcept] QHelpSearchEngineCore::~QHelpSearchEngineCore()

销毁搜索引擎。

[slot] void QHelpSearchEngineCore::cancelIndexing()

停止索引进程。

[slot] void QHelpSearchEngineCore::cancelSearching()

停止搜索过程。

[signal] void QHelpSearchEngineCore::indexingFinished()

索引过程完成时发出该信号。

[signal] void QHelpSearchEngineCore::indexingStarted()

该信号在索引进程启动时发出。

[slot] void QHelpSearchEngineCore::reindexDocumentation()

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

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

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

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

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

QString QHelpSearchEngineCore::searchInput() const

返回上次搜索的短语。

int QHelpSearchEngineCore::searchResultCount() const

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

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

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

[signal] void QHelpSearchEngineCore::searchingFinished()

当搜索过程完成时会发出该信号。

[signal] void QHelpSearchEngineCore::searchingStarted()

搜索进程启动时发出该信号。

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.