Класс 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.2/qhelpindexmodel.html