QHelpIndexModel Class

The QHelpIndexModel class provides a model that supplies index keywords to views. 更多...

头文件: #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

信号

其他继承的成员

详细描述

The QHelpIndexModel class provides a model that supplies index keywords to views.

成员函数

void QHelpIndexModel::createIndex(const QString &customFilterName)

Creates a new index by querying the help system for keywords for the specified customFilterName.

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

Filters the indices and returns the model index of the best matching keyword. In a first step, only the keywords containing filter are kept in the model's index list. Analogously, if wildcard is not empty, only the keywords matched are left in the index list. In a second step, the best match is determined and its index model returned. When specifying a wildcard expression, the filter string is used to search for the best match.

[signal] void QHelpIndexModel::indexCreated()

This signal is emitted when the index has been created.

[signal] void QHelpIndexModel::indexCreationStarted()

This signal is emitted when the creation of a new index has started. The current index is invalid from this point on until the signal indexCreated() is emitted.

参见 isCreatingIndex().

bool QHelpIndexModel::isCreatingIndex() const

Returns true if the index is currently built up, otherwise false.