QHelpIndexModel Class▲
-
Header: QHelpIndexModel
-
Since: Qt 4.4
-
qmake: QT += help
-
Inherits: QStringListModel
Detailed Description▲
Member Function Documentation▲
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.
void QHelpIndexModel::indexCreated()▲
This signal is emitted when the index has been created.
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.
See Also▲
See also isCreatingIndex()
bool QHelpIndexModel::isCreatingIndex() const▲
Returns true if the index is currently built up, otherwise false.
Obsolete Members for QHelpIndexModel▲
The following members of class QHelpIndexModel are deprecated. We strongly advise against using them in new code.
Obsolete Member Function Documentation▲
QMap<QString, QUrl> QHelpIndexModel::linksForKeyword(const QString &keyword) const▲
This function is deprecated. We strongly advise against using it in new code.
Use QHelpEngineCore::linksForKeyword() instead.