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を返します。