QHelpEngineCore Class

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

[explicit] QHelpEngineCore::QHelpEngineCore(const QString &collectionFile, QObject *parent = nullptr)

parent を使用して、新しいコアヘルプエンジンを構築します。このヘルプエンジンは、collectionFile に保存されている情報を使用してヘルプを提供します。コレクションファイルがまだ存在しない場合は、作成されます。

[virtual noexcept] QHelpEngineCore::~QHelpEngineCore()

ヘルプエンジンを削除します。

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

fileName というファイルを作成し、現在のコレクションファイルの内容をすべて新しく作成されたファイルにコピーします。成功した場合は true を返し、失敗した場合は false を返します。

このコピー処理により、Qtコレクションファイル（.qch ）へのファイル参照が適切に更新されることが保証されます。

QVariant QHelpEngineCore::customValue(const QString &key, const QVariant &defaultValue = {}) const

key に割り当てられた値を返します。要求されたキーが存在しない場合は、指定されたdefaultValue が返されます。

setCustomValue() およびremoveCustomValue()も参照してください 。

QString QHelpEngineCore::documentationFileName(const QString &namespaceName)

namespaceName で指定された Qt 圧縮ヘルプファイル (.qch) の絶対ファイル名を返します。指定された名前空間を持つ Qt 圧縮ヘルプファイルが登録されていない場合は、空の文字列が返されます。

namespaceName()も参照してください 。

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id) const

id に対して見つかったすべてのドキュメントリンクのリストを返します。返されるリストの内容は現在のフィルタによって異なるため、現在のフィルタに登録されているキーワードのみが返されます。

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id, const QString &filterName) const

id に対して見つかったドキュメントリンクのリストを、filterName でフィルタリングして返します。返されるリストの内容は渡されたフィルタによって異なるため、このフィルタに登録されているキーワードのみが返されます。フィルタリングせずにすべての結果を取得したい場合は、filterName に空の文字列を渡してください。

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword) const

keyword に対して見つかったすべてのドキュメントリンクのリストを返します。返されるリストの内容は現在のフィルタによって異なるため、現在のフィルタに登録されているキーワードのみが返されます。

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword, const QString &filterName) const

keyword に対して見つかったドキュメントリンクのリストを、filterName でフィルタリングして返します。返されるリストの内容は渡されたフィルタによって異なるため、このフィルタに登録されているキーワードのみが返されます。フィルタをかけずにすべての結果を取得したい場合は、filterName に空の文字列を渡してください。

QString QHelpEngineCore::error() const

最後に発生したエラーの説明を返します。

QByteArray QHelpEngineCore::fileData(const QUrl &url) const

url で指定されたファイルのデータを返します。ファイルが存在しない場合は、空の `QByteArray ` が返されます。

findFile()も参照してください 。

QList<QUrl> QHelpEngineCore::files(const QString namespaceName, const QString &filterName, const QString &extensionFilter = {})

namespaceName 用のQt圧縮ヘルプファイルに含まれるファイルのリストを返します。ファイルは、filterName によるフィルタリングのほか、拡張子extensionFilter （例：'html'）によるフィルタリングも可能です。

QHelpFilterEngine *QHelpEngineCore::filterEngine() const

このヘルプエンジンに関連付けられたフィルタエンジンを返します。このフィルタエンジンを使用すると、このヘルプエンジンに対して既存のフィルタの追加、変更、削除を行うことができます。このエンジンを使用するには、setUsesFilterEngine() を呼び出し、true に設定する必要があります。

QUrl QHelpEngineCore::findFile(const QUrl &url) const

url の一部として定義された仮想フォルダによって定義された、別の名前空間を参照している可能性があるurl の修正済みURLを返します。仮想フォルダがurl の名前空間と一致する場合、このメソッドはファイルが存在するかどうかを確認するだけで、元のurl をそのまま返します。 仮想フォルダがurl のネームスペースと一致しない場合、アクティブなフィルタに基づいて最も一致するネームスペースを検索しようとします。ネームスペースが見つかった場合、ファイルが存在すれば修正されたURLを返し、存在しなければ無効なURLを返します。

[static] QVariant QHelpEngineCore::metaData(const QString &documentationFileName, const QString &name)

Qt圧縮ヘルプファイル `documentationFileName` のメタデータを返します。name に関するデータが存在しない場合、無効な `QVariant()` が返されます。メタデータはQt圧縮ヘルプファイルの作成時に定義され、後から変更することはできません。一般的なメタデータには、例えばドキュメントの作成者などが含まれます。

[static] QString QHelpEngineCore::namespaceName(const QString &documentationFileName)

documentationFileName で指定された Qt 圧縮ヘルプファイル (.qch) に対して定義されている名前空間名を返します。ファイルが無効な場合は、空の文字列が返されます。

documentationFileName()も参照してください 。

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

ファイル `documentationFileName` に含まれる Qt 圧縮ヘルプファイル（.qch）を登録します。名前空間によって一意に識別される圧縮ヘルプファイルは、1 つにつき 1 回のみ登録できます。登録に成功した場合は `true` を返し、失敗した場合は `false` を返します。

unregisterDocumentation() およびerror()も参照してください 。

QStringList QHelpEngineCore::registeredDocumentations() const

現在のコレクションファイルに登録されているすべてのQt圧縮ヘルプファイルのリストを返します。返される名前は、登録されているQt圧縮ヘルプファイル（.qch）のネームスペースです。

bool QHelpEngineCore::removeCustomValue(const QString &key)

コレクションファイルの設定セクションから「key 」を削除します。値が正常に削除された場合はtrueを返し、そうでない場合はfalseを返します。

customValue() およびsetCustomValue()も参照してください 。

bool QHelpEngineCore::setCustomValue(const QString &key, const QVariant &value)

value をkey に保存します。キーがすでに存在する場合、値は上書きされます。値が正常に保存された場合はtrueを返し、そうでない場合はfalseを返します。

customValue() およびremoveCustomValue()も参照してください 。

void QHelpEngineCore::setUsesFilterEngine(bool uses)

渡されたuses パラメータに基づいて、ヘルプエンジン内の新しいフィルターエンジン機能を有効または無効にします。

usesFilterEngine() およびfilterEngine()も参照してください 。

bool QHelpEngineCore::setupData()

コレクションファイル内の情報を処理してヘルプエンジンをセットアップし、成功した場合はtrueを返し、そうでない場合はfalseを返します。

この関数を呼び出すと、ヘルプエンジンは直ちに初期化されます。ほとんどの場合、正しく設定されたヘルプエンジンに依存するゲッター関数が自動的に初期化を行うため、この関数を明示的に呼び出す必要はありません。

[signal] void QHelpEngineCore::setupFinished()

この信号は、セットアップが完了した際に送信されます。

[signal] void QHelpEngineCore::setupStarted()

この信号は、セットアップが開始されたときに発信されます。

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

namespaceName で識別される Qt 圧縮ヘルプファイル (.qch) を、ヘルプコレクションから登録解除します。成功した場合は true を返し、そうでない場合は false を返します。

registerDocumentation() およびerror()も参照してください 。

bool QHelpEngineCore::usesFilterEngine() const

ヘルプエンジンが新しいフィルタ機能を使用しているかどうかを返します。

setUsesFilterEngine() およびfilterEngine()も参照してください 。

[signal] void QHelpEngineCore::warning(const QString &msg)

この信号は、重大ではないエラーが発生したときに発信されます。警告メッセージは、msg に保存されます。