Класс QHelpSearchEngine

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

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

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

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

Сигналы

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

Перед использованием поискового движка необходимо создать хотя бы объект 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, since 5.9] 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()

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

[since 5.9] QString QHelpSearchEngine::searchInput() const

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

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

[since 5.9] int QHelpSearchEngine::searchResultCount() const

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

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

[since 5.9] QList<QHelpSearchResult> QHelpSearchEngine::searchResults(int start, int end) const

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

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