Класс QHelpIndexModel
Класс QHelpIndexModel предоставляет модель, которая предоставляет ключевые слова индексов для представлений. Подробнее...
| Заголовок: | #include <QHelpIndexModel> |
| qmake: | QT += help |
| С тех пор: | Qt 4.4 |
| Наследует: | QStringListModel |
Открытые функции
| void | createIndex(const QString &customFilterName) |
| QModelIndex | filter(const QString &filter, const QString &wildcard = QString()) |
| bool | isCreatingIndex() const |
| QMap<QString, QUrl> | linksForKeyword(const QString &keyword) const |
- 11 открытых функций унаследовано от QStringListModel
- 4 открытых функций унаследовано от QAbstractListModel
- 39 открытых функций унаследовано от QAbstractItemModel
- 31 открытых функций унаследовано от QObject
Сигналы
| void | indexCreated() |
| void | indexCreationStarted() |
- 18 сигналов унаследовано от QAbstractItemModel
- 2 сигнала унаследовано от QObject
Дополнительные унаследованные члены
- 1 свойство унаследовано от QObject
- 2 открытых слотов унаследовано от QAbstractItemModel
- 1 открытый слот унаследовано от QObject
- 11 статических открытых членов унаследовано от QObject
- 19 защищенных функций унаследовано от QAbstractItemModel
- 9 защищенных функций унаследовано от QObject
- 1 защищенный слот унаследовано от QAbstractItemModel
Подробное описание
Класс QHelpIndexModel предоставляет модель, которая предоставляет ключевые слова индексов для представлений.
Документация по функциям-членам
void QHelpIndexModel::createIndex(const QString &customFilterName)
Создает новый индекс, запрашивая у системы справки ключевые слова для указанного customFilterName.
QModelIndex QHelpIndexModel::filter(const QString &filter, const QString &wildcard = QString())
Фильтрует индексы и возвращает индекс модели для наилучшего соответствия ключевому слову. На первом шаге в списке индексов модели сохраняются только ключевые слова, содержащие filter. Аналогично, если wildcard не пустое, в списке индексов остаются только соответствующие ключевые слова. На втором шаге определяется наилучшее соответствие и возвращается его индекс модели. При указании выражения подстановочного знака строка filter используется для поиска наилучшего соответствия.
void QHelpIndexModel::indexCreated()
Этот сигнал излучается, когда индекс был создан.
void QHelpIndexModel::indexCreationStarted()
Этот сигнал излучается, когда началось создание нового индекса. Текущий индекс становится недопустимым с этого момента до тех пор, пока не будет излучен сигнал indexCreated().
См. также isCreatingIndex().
bool QHelpIndexModel::isCreatingIndex() const
Возвращает true, если индекс в данный момент строится, в противном случае false.
QMap<QString, QUrl> QHelpIndexModel::linksForKeyword(const QString &keyword) const
Возвращает все найденные соответствия для keyword. Соответствие состоит из URL и заголовка документа.