Класс QHelpSearchEngine

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

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

Типы public

Функции public

• 31 функция public, унаследованная от QObject

Свойства public

• 1 свойство public, унаследованное от QObject

Сигналы

• 2 сигнала, унаследованные от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 11 статических public членов, унаследованных от QObject
• 9 защищенных функций, унаследованных от QObject

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

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

Прежде чем можно будет использовать движок поиска, необходимо создать по крайней мере объект QHelpEngineCore, который необходимо передать в конструктор движка поиска. Это необходимо, так как движку поиска необходимо подключиться к сигналу setupFinished() движка справки, чтобы знать, когда он может начать индексировать документацию.

После запуска процесса индексации испускается сигнал indexingStarted(), а по завершении процесса индексации — indexingFinished(). Чтобы остановить индексацию, можно вызвать cancelIndexing().

После завершения процесса индексации движок поиска может быть использован для поиска в своем индексе заданного термина. Для этого можно создать список QHelpSearchQuery самостоятельно или использовать QHelpSearchQueryWidget, который имеет встроенную функциональность для настройки списка запросов к поиску, которые передаются в функцию поиска движка search().

После передачи списка запросов движку поиска испускается сигнал searchingStarted(), а после завершения поиска — searchingFinished(). Процесс поиска можно остановить, вызвав cancelSearching().

Если поиск успешен, searchingFinished() будет вызван с количеством результатов поиска, которое можно использовать для получения результатов поиска из движка поиска. Вызов функции hits() с диапазоном результатов, которые вы хотите получить, вернет список требуемых SearchHits. В настоящее время они представляют собой пару строк, где значения пары — путь к файлу документации и заголовок страницы.

Для отображения полученных результатов используйте QHelpSearchResultWidget или создайте свой собственный, если вам нужна более расширенная функциональность. Обратите внимание, что QHelpSearchResultWidget нельзя создавать напрямую, вы должны получить виджет из используемого движка поиска, так как все подключения будут установлены за вас самим виджетом.

Документация типов членов

typedef QHelpSearchEngine::SearchHit

Тип typedef для QPair<QString, QString>. Значения этой пары — путь к файлу документации и заголовок страницы.

См. также hits().

Документация функций членов

QHelpSearchEngine::QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent = Q_NULLPTR)

Создает новый движок поиска с заданным parent. Движок поиска использует заданный helpEngine для доступа к документации, которую нужно проиндексировать. Сигнал setupFinished() QHelpEngine автоматически подключается к функции индексации QHelpSearchEngine, поэтому новая документация будет проиндексирована после испускания сигнала.

QHelpSearchEngine::~QHelpSearchEngine()

Уничтожает движок поиска.

[slot] void QHelpSearchEngine::cancelIndexing()

Останавливает процесс индексации.

[slot] void QHelpSearchEngine::cancelSearching()

Останавливает процесс поиска.

int QHelpSearchEngine::hitCount() const

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

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

QList<SearchHit> QHelpSearchEngine::hits(int start, int end) const

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

[signal] void QHelpSearchEngine::indexingFinished()

Этот сигнал испускается при завершении процесса индексации.

[signal] void QHelpSearchEngine::indexingStarted()

Этот сигнал испускается при запуске процесса индексации.

QList<QHelpSearchQuery> QHelpSearchEngine::query() const

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

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

QHelpSearchQueryWidget *QHelpSearchEngine::queryWidget()

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

[slot] void QHelpSearchEngine::reindexDocumentation()

Принудительно заставляет движок поиска переиндексировать все файлы документации.

QHelpSearchResultWidget *QHelpSearchEngine::resultWidget()

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

[slot] void QHelpSearchEngine::search(const QList<QHelpSearchQuery> &queryList)

Запускает процесс поиска, используя предоставленный список запросов queryList, созданный по имени поля поиска и значениям, которые нужно найти.

[signal] void QHelpSearchEngine::searchingFinished(int hits)

Этот сигнал испускается, когда процесс поиска завершен. Количество совпадений хранится в hits.

[signal] void QHelpSearchEngine::searchingStarted()

Этот сигнал испускается при начале процесса поиска.