Spec-Zone.ru › Qt 6.0

Класс QHelpIndexModel

Класс QHelpIndexModel предоставляет модель, которая предоставляет ключевые слова индексов для представлений. Подробнее...

Заголовок: #include <QHelpIndexModel>
CMake: find_package(Qt6 COMPONENTS Help REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake: QT += help
Наследует: QStringListModel
  • Список всех членов, включая унаследованные

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

void createIndex(const QString &customFilterName)
QModelIndex filter(const QString &filter, const QString &wildcard = QString())
QHelpEngineCore * helpEngine() const
bool isCreatingIndex() const

Сигналы

void indexCreated()
void indexCreationStarted()

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

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

[signal] void QHelpIndexModel::indexCreated()

Этот сигнал испускается, когда индекс был создан.

[signal] void QHelpIndexModel::indexCreationStarted()

Этот сигнал испускается, когда началось создание нового индекса. Текущий индекс становится недопустимым с этого момента до момента испускания сигнала indexCreated().

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

void QHelpIndexModel::createIndex(const QString &customFilterName)

Создаёт новый индекс, запрашивая у системы справки ключевые слова для указанного customFilterName.

QModelIndex QHelpIndexModel::filter(const QString &filter, const QString &wildcard = QString())

Фильтрует индексы и возвращает индекс модели для наилучшего совпадения с ключевым словом. На первом шаге в списке индексов модели остаются только ключевые слова, содержащие filter. Аналогично, если wildcard не пусто, в списке индексов модели остаются только совпавшие ключевые слова. На втором шаге определяется наилучшее совпадение и возвращается его индекс модели. При указании выражения с подстановкой символ filter используется для поиска наилучшего совпадения.

[since 5.15] QHelpEngineCore *QHelpIndexModel::helpEngine() const

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

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

bool QHelpIndexModel::isCreatingIndex() const

Возвращает true, если индекс в настоящее время строится, иначе false.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.0/qhelpindexmodel.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API