QHelpIndexModel 類

QHelpIndexModel 類提供嚮視圖供給索引關鍵字的模型。 更多...

頭: #include <QHelpIndexModel>
qmake: QT += help
Since: 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 ()

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 () 發射。

另請參閱 isCreatingIndex ().

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.

QHelpEngineCore *QHelpIndexModel:: helpEngine () const

返迴管理此模型的關聯幫助引擎。

該函數在 Qt 5.15 引入。

bool QHelpIndexModel:: isCreatingIndex () const

返迴 true 若索引目前已建立,否則 false。