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

Эта функция была представлена в 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.