Класс QHelpIndexModel
Класс QHelpIndexModel предоставляет модель, которая предоставляет ключевые слова индексов для представлений. Подробнее...
| Заголовок: | #include <QHelpIndexModel> |
| qmake: | QT += help |
| С момента: | Qt 4.4 |
| Наследует: | QStringListModel |
Этот класс был представлен в Qt 4.4.
Открытые функции
| 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 используется для поиска наилучшего совпадения.
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-5.15/qhelpindexmodel.html