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

filterName でフィルタリングされたkeyword について見つかった文書リンクのリストを返します。返されるリストの内容は渡されたフィルタに依存するので、このフィルタに登録されたキーワードのみが返されます。フィルタを通さずにすべての結果を得たい場合は、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

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

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つの圧縮ヘルプファイルは、一度しか登録できません。登録に成功した場合は 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)

key の下にvalue を保存します。 キーが既に存在する場合、値は上書きされます。値が正常に保存された場合は 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 に格納されます。