Класс QHelpSearchEngine

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

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

Открытые функции

• 32 открытых функции унаследованные от QObject

Открытые слоты

• 1 открытый слот унаследованный от QObject

Сигналы

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

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

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

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

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

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

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

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

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

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

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

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

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

QHelpSearchEngine::~QHelpSearchEngine()

Удаляет поисковый движок.

void QHelpSearchEngine::cancelIndexing()

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

void QHelpSearchEngine::cancelSearching()

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

void QHelpSearchEngine::indexingFinished()

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

void QHelpSearchEngine::indexingStarted()

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

QHelpSearchQueryWidget *QHelpSearchEngine::queryWidget()

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

void QHelpSearchEngine::reindexDocumentation()

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

QHelpSearchResultWidget *QHelpSearchEngine::resultWidget()

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

void QHelpSearchEngine::search(const QString &searchInput)

Запускает процесс поиска, используя указанную фразу поиска searchInput.

Фраза может состоять из нескольких слов. По умолчанию, поисковый движок возвращает список документов, содержащих все указанные слова. Фраза может содержать любые комбинации логических операторов И, ИЛИ и НЕ. Оператор должен быть написан заглавными буквами, в противном случае он будет рассматриваться как часть фразы поиска.

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

Дополнительную информацию о синтаксисе запроса текста см. в SQLite FTS5 Extension.

Функция была добавлена в Qt 5.9.

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.

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

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

[signal] void QHelpSearchEngine::searchingStarted()

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