Класс QHelpSearchEngine

Класс QHelpSearchEngine предоставляет доступ к компонентам, которые можно использовать повторно для интеграции полнотекстового поиска, а также для индексирования и поиска документации. Подробнее...

Этот класс был представлен в Qt 4.4.

• Список всех членов, включая унаследованные
• Устаревшие члены

Открытые функции

Открытые слоты

Сигналы

Подробное описание

Прежде чем можно использовать движок поиска, необходимо создать по меньшей мере объект QHelpEngineCore, который необходимо передать в конструктор движка поиска. Это необходимо, так как движку поиска необходимо подключиться к сигналу setupFinished() движка справки, чтобы узнать, когда можно начать индексирование документации.

После запуска процесса индексирования излучается сигнал indexingStarted(), а по завершении процесса индексирования излучается indexingFinished(). Чтобы остановить индексирование, можно вызвать cancelIndexing().

После завершения процесса индексирования движок поиска можно использовать для поиска по индексу заданного термина, используя функцию search(). Когда входные данные поиска передаются движку поиска, излучается сигнал searchingStarted(). Когда поиск завершается, излучается сигнал searchingFinished(). Процесс поиска можно остановить, вызвав cancelSearching().

Если поиск успешен, вызывается searchingFinished() с количеством результатов поиска, чтобы извлечь результаты поиска из движка поиска. Вызов функции searchResults() с диапазоном возвращает список объектов QHelpSearchResult в указанном диапазоне. Результаты включают заголовок документа и URL-адрес, а также фрагмент документа, содержащий наилучшее соответствие входным данным поиска.

Для отображения результатов поиска используйте QHelpSearchResultWidget или создайте свой собственный, если вам нужна более расширенная функциональность. Обратите внимание, что QHelpSearchResultWidget нельзя создавать напрямую; вы должны получить компонент из используемого движка поиска, так как все подключения будут созданы для вас самим компонентом.

Документация по функциям членов

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

Создает новый движок поиска с заданным parent. Движок поиска использует заданный helpEngine для доступа к документации, которая должна быть проиндексирована. Сигнал setupFinished() QHelpEngine автоматически подключается к функции индексирования QHelpSearchEngine, так что новая документация будет проиндексирована после излучения сигнала.

[slot] void QHelpSearchEngine::cancelIndexing()

Останавливает процесс индексирования.

[slot] void QHelpSearchEngine::cancelSearching()

Останавливает процесс поиска.

[signal] void QHelpSearchEngine::indexingFinished()

Этот сигнал излучается, когда процесс индексирования завершен.

[signal] void QHelpSearchEngine::indexingStarted()

Этот сигнал излучается, когда начат процесс индексирования.

[slot] void QHelpSearchEngine::reindexDocumentation()

Принудительно заставляет движок поиска переиндексировать все файлы документации.

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

Запускает процесс поиска, используя заданный поисковый запрос searchInput.

Запрос может состоять из нескольких слов. По умолчанию движок поиска возвращает список документов, содержащих все указанные слова. Запрос может содержать любые комбинации логических операторов AND, OR и NOT. Оператор должен быть написан заглавными буквами, в противном случае он будет считаться частью поискового запроса.

Если для группировки слов используются двойные кавычки, движок поиска будет искать точное совпадение цитируемого фрагмента.

Дополнительную информацию о синтаксисе текстовых запросов см. в SQLite FTS5 Extension.

Эта функция была представлена в Qt 5.9.

[signal] void QHelpSearchEngine::searchingFinished(int searchResultCount)

Этот сигнал излучается, когда процесс поиска завершен. Количество результатов поиска хранится в searchResultCount.

[signal] void QHelpSearchEngine::searchingStarted()

Этот сигнал излучается, когда начат процесс поиска.

[virtual] QHelpSearchEngine::~QHelpSearchEngine()

Уничтожает движок поиска.

QHelpSearchQueryWidget *QHelpSearchEngine::queryWidget()

Возвращает компонент, используемый в качестве компонента ввода. В зависимости от вашей конфигурации движка поиска вы получите разный компонент с большим или меньшим количеством подкомпонентов.

QHelpSearchResultWidget *QHelpSearchEngine::resultWidget()

Возвращает компонент, который может содержать и отображать результаты поиска.

QString QHelpSearchEngine::searchInput() const

Возвращает запрос, по которому был произведен последний поиск.

Эта функция была представлена в Qt 5.9.

int QHelpSearchEngine::searchResultCount() const

Возвращает количество результатов, найденных движком поиска.

Эта функция была представлена в Qt 5.9.

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

Возвращает список результатов поиска в диапазоне от индекса, указанного параметром start, до индекса, указанного параметром end.

Эта функция была представлена в Qt 5.9.