Класс 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.