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