QHelpIndexModel Class

メンバー関数ドキュメント

void QHelpIndexModel::createIndex(const QString &filter)

指定されたカスタムfilter 名のキーワードをヘルプシステムに問い合わせることで、新しいインデックスを作成します。

[since 6.8] void QHelpIndexModel::createIndexForCurrentFilter()

現在のフィルタのキーワードをヘルプシステムに問い合わせることによって、新しいインデックスを作成します。

この関数は Qt 6.8 で導入されました。

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

インデックスをフィルタリングし、最もよくマッチするキーワードのモデルインデックスを返す。最初のステップでは、filter を含むキーワードのみがモデルのインデックスリストに残される。同様に、wildcard が空でなければ、マッチしたキーワードのみがインデックスリストに残される。2番目のステップでは、ベストマッチが決定され、そのインデックスモデルが返されます。ワイルドカード表現を指定した場合、filter の文字列がベストマッチの検索に使用されます。

QHelpEngineCore *QHelpIndexModel::helpEngine() const

このモデルを管理する関連ヘルプエンジンを返します。

[signal] void QHelpIndexModel::indexCreated()

このシグナルは、インデックスが作成されたときに発せられる。

[signal] void QHelpIndexModel::indexCreationStarted()

このシグナルは、新しいインデックスの作成が開始されたときに発せられる。この時点から、シグナルindexCreated() が発せられるまで、現在のインデックスは無効である。

isCreatingIndex()も参照のこと 。

bool QHelpIndexModel::isCreatingIndex() const

インデックスが現在構築されていればtrueを返し、そうでなければfalseを返す。