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