QQuickWebEngineProfile Class

QQuickWebEngineProfile クラスは、複数のページで共有されるウェブエンジンプロファイルを提供します。詳細...

ヘッダ #include <QQuickWebEngineProfile>
CMake: find_package(Qt6 REQUIRED COMPONENTS WebEngineQuick)
target_link_libraries(mytarget PRIVATE Qt6::WebEngineQuick)
qmake QT += webenginequick
QML で WebEngineProfile
継承: QObject

パブリックな型

enum HttpCacheType { MemoryHttpCache, DiskHttpCache, NoCache }
enum PersistentCookiesPolicy { NoPersistentCookies, AllowPersistentCookies, ForcePersistentCookies }
(since 6.8) enum class PersistentPermissionsPolicy { AskEveryTime, StoreInMemory, StoreOnDisk }

プロパティ

パブリック機能

QQuickWebEngineProfile(QObject *parent = nullptr)
QString cachePath() const
void clearHttpCache()
QWebEngineClientCertificateStore *clientCertificateStore()
(since 6.8) QWebEngineClientHints *clientHints() const
QWebEngineCookieStore *cookieStore() const
QString downloadPath() const
QString httpAcceptLanguage() const
int httpCacheMaximumSize() const
QQuickWebEngineProfile::HttpCacheType httpCacheType() const
QString httpUserAgent() const
void installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler)
bool isOffTheRecord() const
bool isPushServiceEnabled() const
bool isSpellCheckEnabled() const
(since 6.8) QList<QWebEnginePermission> listAllPermissions() const
(since 6.8) QList<QWebEnginePermission> listPermissionsForOrigin(const QUrl &securityOrigin) const
(since 6.8) QList<QWebEnginePermission> listPermissionsForPermissionType(QWebEnginePermission::PermissionType permissionType) const
QQuickWebEngineProfile::PersistentCookiesPolicy persistentCookiesPolicy() const
QQuickWebEngineProfile::PersistentPermissionsPolicy persistentPermissionsPolicy() const
QString persistentStoragePath() const
(since 6.8) QWebEnginePermission queryPermission(const QUrl &securityOrigin, QWebEnginePermission::PermissionType permissionType) const
void removeAllUrlSchemeHandlers()
void removeUrlScheme(const QByteArray &scheme)
void removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)
void setCachePath(const QString &path)
void setDownloadPath(const QString &path)
void setHttpAcceptLanguage(const QString &httpAcceptLanguage)
void setHttpCacheMaximumSize(int maxSize)
void setHttpCacheType(QQuickWebEngineProfile::HttpCacheType)
void setHttpUserAgent(const QString &userAgent)
void setOffTheRecord(bool offTheRecord)
void setPersistentCookiesPolicy(QQuickWebEngineProfile::PersistentCookiesPolicy)
void setPersistentPermissionsPolicy(QQuickWebEngineProfile::PersistentPermissionsPolicy)
void setPersistentStoragePath(const QString &path)
void setPushServiceEnabled(bool enable)
void setSpellCheckEnabled(bool enabled)
void setSpellCheckLanguages(const QStringList &languages)
void setStorageName(const QString &name)
void setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)
QStringList spellCheckLanguages() const
QString storageName() const
const QWebEngineUrlSchemeHandler *urlSchemeHandler(const QByteArray &scheme) const
QQuickWebEngineScriptCollection *userScripts() const

シグナル

void cachePathChanged()
(since 6.7) void clearHttpCacheCompleted()
void downloadFinished(QQuickWebEngineDownloadRequest *download)
void downloadPathChanged()
void downloadRequested(QQuickWebEngineDownloadRequest *download)
void httpAcceptLanguageChanged()
void httpCacheMaximumSizeChanged()
void httpCacheTypeChanged()
void httpUserAgentChanged()
void offTheRecordChanged()
void persistentCookiesPolicyChanged()
void persistentPermissionsPolicyChanged()
void persistentStoragePathChanged()
void presentNotification(QWebEngineNotification *notification)
void pushServiceEnabledChanged()
void spellCheckEnabledChanged()
void spellCheckLanguagesChanged()
void storageNameChanged()

静的パブリックメンバ

QQuickWebEngineProfile *defaultProfile()

詳細説明

ウェブエンジンプロファイルには、設定、スクリプト、永続的なクッキーポリシー、およびプロファイルに属するすべてのウェブエンジンページで共有される訪問済みリンクのリストが含まれます。

訪問したリンクに関する情報は、永続的なクッキーやその他の永続的なデータとともに、storageName プロパティによって決定されるストレージに保存されます。永続データはpersistentStoragePath プロパティによって決定されるサブディレクトリに、キャッシュはcachePath プロパティによって決定されるサブディレクトリに保存されます。httpCacheType プロパティには、インメモリまたはオンディスクというキャッシュのタイプが記述されます。storageName プロパティのみが設定されている場合、他の値はそれに基づいて自動的に生成されます。いずれかの値を手動で指定する場合は、プロファイルに属するページを作成する前に指定する必要があります。

プロファイルは、ページを互いに分離するために使用できます。典型的な使用例は、プライベート・ブラウジング・モード専用のオフレコ・プロファイルです。off-the-recordプロファイルは、クッキー、HTTPキャッシュ、および他の通常永続的なデータをメモリにのみ保存することを強制します。offTheRecord プロパティは、プロファイルが off-the-record であるかどうかを保持します。

デフォルト・プロファイルには、defaultProfile() でアクセスできます。これは、別のプロファイルで特別に作成されていないすべての Web ページが属する組み込みプロファイルです。

QQuickWebEngineProfile クラスを通して、C++ からWebEngineProfile インスタンスを作成し、アクセスすることができます。これにより、Qt Quick アプリケーションで URL 要求をインターセプトしたり (QQuickWebEngineProfile::setRequestInterceptor)、カスタム URL スキームを登録したりできます (QQuickWebEngineProfile::installUrlSchemeHandler)。

spellCheckEnabled プロパティを設定することで、プロファイルごとに HTML フォーム・フィールドのスペルチェックを有効にでき、spellCheckLanguages プロパティを使用することで、スペルチェックに使用される現在の言語を設定できます。

メンバー型ドキュメント

enum QQuickWebEngineProfile::HttpCacheType

この列挙型は HTTP キャッシュのタイプを記述します:

定数説明
QQuickWebEngineProfile::MemoryHttpCache0メモリ内キャッシュを使用します。これは、off-the-record が設定されている場合のデフォルトです。
QQuickWebEngineProfile::DiskHttpCache1ディスクキャッシュを使用する。off-the-record が設定されていない場合のデフォルトである。off-the-record が設定されている場合はMemoryHttpCache にフォールバックする。
QQuickWebEngineProfile::NoCache2メモリ内キャッシュとディスクキャッシュの両方を無効にします。(Qt 5.7 で追加)

enum QQuickWebEngineProfile::PersistentCookiesPolicy

この列挙型は、クッキーの永続性に関するポリシーを記述します:

定数説明
QQuickWebEngineProfile::NoPersistentCookies0セッション・クッキーと永続的クッキーの両方がメモリに保存されます。これは、off-the-record が設定されているか、永続的なデータ・パスが利用できない場合にのみ可能な設定です。
QQuickWebEngineProfile::AllowPersistentCookies1永続的とマークされたクッキーはディスクに保存され、ディスクから復元されますが、セッション・クッキーはクラッシュ回復のためにのみディスクに保存されます。これはデフォルトの設定です。
QQuickWebEngineProfile::ForcePersistentCookies2セッション・クッキーと永続的クッキーの両方がディスクに保存され、ディスクから復元されます。

[since 6.8] enum class QQuickWebEngineProfile::PersistentPermissionsPolicy

この列挙型は、パーミッションの永続化のためのポリシーを記述する:

定数説明
QQuickWebEngineProfile::PersistentPermissionsPolicy::AskEveryTime0アプリケーションは、パーミッションが必要になる度に、以前に許可されたかどうかに関わらず、パーミッションを要求します。これは既存のアプリケーションとの後方互換性のためであり、それ以外は推奨されません。
QQuickWebEngineProfile::PersistentPermissionsPolicy::StoreInMemory1リクエストが行われるのは、パーミッションが初めて必要になったときだけです。それ以降のリクエストは、最初のユーザーの選択に応じて、自動的に許可または拒否されます。これは、アプリケーションがシャットダウンされるまで、同じQQuickWebEngineProfile インスタンスを使用するすべてのページに引き継がれます。これは、off-the-record が設定されているか、永続データ・パスが利用できない場合に適用される設定です。
QQuickWebEngineProfile::PersistentPermissionsPolicy::StoreOnDisk2PersistentPermissionsInMemory と同じように動作しますが、パーミッションはディスクに保存され、ディスクから復元されます。これはデフォルトの設定です。

この列挙は Qt 6.8 で導入されました。

プロパティの説明

cachePath : QString

プロファイルのキャッシュ、特に HTTP キャッシュが保存される場所へのパス。

デフォルトでは、キャッシュはQStandardPaths::writableLocation(QStandardPaths::CacheLocation) の下のstorageName というディレクトリに保存されます。

アクセス関数:

QString cachePath() const
void setCachePath(const QString &path)

通知シグナル:

void cachePathChanged()

[since QtWebEngine 1.9] downloadPath : QString

ダウンロードされたファイルが保存される場所へのパス。

ダウンロード場所に使用されるデフォルトのパスを上書きし、path に設定します。

空の文字列を設定すると、デフォルトのパスが復元されます。

注意: デフォルトでは、ダウンロード・パスはQStandardPaths::DownloadLocation です。

このプロパティは QtWebEngine 1.9 で導入されました。

アクセス関数

QString downloadPath() const
void setDownloadPath(const QString &path)

通知シグナル:

void downloadPathChanged()

httpAcceptLanguage : QString

Accept-Language HTTPリクエストヘッダーフィールドの値。

アクセス関数:

QString httpAcceptLanguage() const
void setHttpAcceptLanguage(const QString &httpAcceptLanguage)

Notifier シグナル:

void httpAcceptLanguageChanged()

httpCacheMaximumSize : int

HTTPキャッシュの最大サイズ。0 の場合、サイズはQtWebEngine によって自動的に制御されます。デフォルト値は0 です。

アクセス関数:

int httpCacheMaximumSize() const
void setHttpCacheMaximumSize(int maxSize)

Notifier シグナル:

void httpCacheMaximumSizeChanged()

httpCacheTypeも参照のこと。

httpCacheType : HttpCacheType

この列挙は,HTTPキャッシュの型を記述する。

プロファイルが off-the-record またはstorageName が設定されていない場合、MemoryHttpCache が返されます。

アクセス関数:

QQuickWebEngineProfile::HttpCacheType httpCacheType() const
void setHttpCacheType(QQuickWebEngineProfile::HttpCacheType)

通知シグナル:

void httpCacheTypeChanged()

httpUserAgent : QString

ブラウザを識別するためにHTTPで送信されるユーザーエージェント文字列。

アクセス機能:

QString httpUserAgent() const
void setHttpUserAgent(const QString &userAgent)

通知シグナル:

void httpUserAgentChanged()

[since QtWebEngine 6.5] isPushServiceEnabled : bool

プッシュ・メッセージング・サービスが有効かどうか。

注: デフォルトでは、プッシュメッセージングサービスは無効になっています。

注意: Qt WebEngine はブラウザプッシュサービスとしてFirebase Cloud Messaging (FCM)を使用しています。そのため、すべてのプッシュメッセージは Google のプッシュサービスとそれぞれのサーバーを経由します。

このプロパティは QtWebEngine 6.5 で導入されました。

アクセス関数

bool isPushServiceEnabled() const
void setPushServiceEnabled(bool enable)

通知シグナル

void pushServiceEnabledChanged()

offTheRecord : bool

ウェブエンジンプロファイルがoff-the-recordであるかどうか。off-the-recordプロファイルは、クッキー、HTTPキャッシュ、および他の通常永続的なデータをメモリにのみ保存することを強制します。プロファイルはデフォルトで off-the-record です。

プロファイルをoff-the-recordからディスク・ベースの動作に変更するには、適切なstorageName

アクセス関数:

bool isOffTheRecord() const
void setOffTheRecord(bool offTheRecord)

通知シグナル:

void offTheRecordChanged()

setStorageName()も参照のこと

persistentCookiesPolicy : PersistentCookiesPolicy

この列挙は、クッキーの永続性のポリシーを記述する。プロファイルがoff-the-recordの場合、NoPersistentCookies

アクセス関数:

QQuickWebEngineProfile::PersistentCookiesPolicy persistentCookiesPolicy() const
void setPersistentCookiesPolicy(QQuickWebEngineProfile::PersistentCookiesPolicy)

通知シグナル:

void persistentCookiesPolicyChanged()

[since 6.8] persistentPermissionsPolicy : PersistentPermissionsPolicy

パーミッションの永続化のポリシーを記述する。プロファイルが off-the-record の場合、NoPersistentCookies が返されます。

このプロパティは Qt 6.8 で導入されました。

アクセス関数:

QQuickWebEngineProfile::PersistentPermissionsPolicy persistentPermissionsPolicy() const
void setPersistentPermissionsPolicy(QQuickWebEngineProfile::PersistentPermissionsPolicy)

Notifier シグナル:

void persistentPermissionsPolicyChanged()

persistentStoragePath : QString

ブラウザとウェブコンテンツの永続データが保存される場所へのパス。永続データには、永続クッキー、HTML5 ローカルストレージ、訪問済みリンクが含まれます。

デフォルトでは、ストレージはQStandardPaths::writableLocation(QStandardPaths::AppDataLocation) の下、storageName という名前のディレクトリにあります。

アクセス機能:

QString persistentStoragePath() const
void setPersistentStoragePath(const QString &path)

通知シグナル:

void persistentStoragePathChanged()

[since QtWebEngine 1.4] spellCheckEnabled : bool

このプロパティは、Web エンジンのスペルチェッカーが有効かどうかを保持します。

このプロパティは QtWebEngine 1.4 で導入されました。

アクセス関数

bool isSpellCheckEnabled() const
void setSpellCheckEnabled(bool enabled)

通知シグナル

void spellCheckEnabledChanged()

[since QtWebEngine 1.4] spellCheckLanguages : QStringList

このプロパティは、スペルチェッカーが使用する言語を保持します。

このプロパティは QtWebEngine 1.4 で導入されました。

アクセス関数です:

QStringList spellCheckLanguages() const
void setSpellCheckLanguages(const QStringList &languages)

通知シグナル

void spellCheckLanguagesChanged()

storageName : QString

永続データとキャッシュを格納するためにディスクを使用する各プロファイル用に個別のサブディレクトリを作成するために使用されるストレージ名。

アクセス関数:

QString storageName() const
void setStorageName(const QString &name)

通知シグナル:

void storageNameChanged()

persistentStoragePath およびcachePathも参照のこと

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

QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent = nullptr)

新しい off-the-record プロファイルを親parent で構築します。

off-the-recordプロファイルはローカルマシンに記録を残さず、永続的なデータやキャッシュを持たない。したがって,HTTPキャッシュはメモリ内にしか存在せず,クッキーは永続的でないものしか存在しない。これらの設定を変更しようとしても、何の効果もありません。

[invokable] void QQuickWebEngineProfile::clearHttpCache()

プロファイルのキャッシュエントリーを削除します。

注意: クリア処理中は、プロファイルに対して新しいナビゲーションや操作を開始しないようにしてください。clearHttpCacheCompleted() シグナルが完了を通知します。

注意 :この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

WebEngineProfile::clearHttpCache() およびclearHttpCacheCompleted()も参照して ください。

[signal, since 6.7] void QQuickWebEngineProfile::clearHttpCacheCompleted()

このシグナルは、clearHttpCache() 操作が完了したときに発せられます。

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

clearHttpCache()も参照してください

QWebEngineClientCertificateStore *QQuickWebEngineProfile::clientCertificateStore()

プロファイルのクライアント証明書ストアを返します。

[since 6.8] QWebEngineClientHints *QQuickWebEngineProfile::clientHints() const

このブラウジングコンテキストに関連付けられたクライアントヒント設定を返します。

注: プロパティclientHintsのゲッター関数です。

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

QWebEngineClientHintsも参照してください

QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const

このプロファイルのクッキーストアを返します。

[static] QQuickWebEngineProfile *QQuickWebEngineProfile::defaultProfile()

デフォルトのプロファイルを返します。

デフォルトのプロファイルは off-the-record です。

storageName()も参照

[signal] void QQuickWebEngineProfile::downloadFinished(QQuickWebEngineDownloadRequest *download)

このシグナルは、ダウンロードが正常に終了した、キャンセルされた、中断された(接続が失われたなど)、などの理由でダウンロードが停止するたびに発行される。引数download は、終了したダウンロード・インスタンスの状態を保持します。

注: C++から使用するには、download を静的にキャストしてください。QWebEngineDownloadRequest

[signal] void QQuickWebEngineProfile::downloadRequested(QQuickWebEngineDownloadRequest *download)

このシグナルは、ダウンロードがトリガーされるたびに発行される。引数download はダウンロードの状態を保持する。ダウンロードは、QWebEngineDownloadRequest::accept() で明示的に受け入れられなければなりません。そうでなければ、デフォルトでキャンセルされます。ダウンロード項目はプロファイルによって親にされます。受け入れられなかった場合、シグナル発信後すぐに削除されます。このシグナルは、キュー接続では使用できません。

注: C++から使用するには、download を静的にキャストします。QWebEngineDownloadRequest

void QQuickWebEngineProfile::installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler)

カスタム URL スキームscheme 用のハンドラhandler をプロファイルに登録します。

アプリケーションの起動時に、まずQWebEngineUrlScheme::registerScheme にスキームを登録する必要があります。

[invokable, since 6.8] QList<QWebEnginePermission> QQuickWebEngineProfile::listAllPermissions() const

QWebEnginePermission オブジェクトのQList を返します。各オブジェクトは、パーミッションストアに現在存在する単一のパーミッションを表します。返されるリストには、このプロファイルに対して過去に付与/拒否されたすべてのパーミッションが含まれます。

注釈 persistentPermissionPolicy() がAskEveryTime に設定されている場合、これは空のリストを返します。

注意 : この関数は、メタオブジェクトシステムおよび QML から呼び出すことができます。Q_INVOKABLE を参照してください。

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

queryPermission(),listPermissionsForOrigin(),listPermissionsForPermissionType(),QWebEnginePermission::isPersistent()も参照してください

[invokable, since 6.8] QList<QWebEnginePermission> QQuickWebEngineProfile::listPermissionsForOrigin(const QUrl &securityOrigin) const

QWebEnginePermission オブジェクトのQList を返します。各オブジェクトは、パーミッションストアに現在存在する単一のパーミッションを表します。返されるリストには、このプロファイルの特定のsecurityOrigin に関連付けられた、以前に付与/拒否されたすべてのパーミッションが含まれます。

注意: パーミッションはオリジンごとに付与されるため、提供されたsecurityOrigin はオリジンの形式に取り除かれ、返されるリストにはオリジンのすべてのパーミッションが含まれます。したがって、https://www.example.com/some/page.html を渡すことは、https://www.example.com/ だけを渡すことと同じです。

注意: この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

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

queryPermission(),listAllPermissions(),listPermissionsForPermissionType(),QWebEnginePermission::isPersistent()も参照してください

[invokable, since 6.8] QList<QWebEnginePermission> QQuickWebEngineProfile::listPermissionsForPermissionType(QWebEnginePermission::PermissionType permissionType) const

QWebEnginePermission オブジェクトのQList を返す。各オブジェクトは、パーミッションストアに現 在存する単一のパーミッションを表す。返されるリストには、提供されたpermissionType の、過去に付与/拒否されたすべてのパーミッションが含まれる。permissionTypeがnon-persistentの場合、リストは空になります。

注意 : persistentPermissionPolicy() がAskEveryTime に設定されている場合、空のリストが返されます。

注意 :この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

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

queryPermission()、listAllPermissions()、listPermissionsForOrigin()、QWebEnginePermission::PermissionTypeQWebEnginePermission::isPersistent()も参照してください

[signal] void QQuickWebEngineProfile::presentNotification(QWebEngineNotification *notification)

このシグナルは、新しく作成されたユーザー通知があるたびに発行される。notification 引数は、データを照会し、対話するためのQWebEngineNotification インスタンスを保持します。

WebEngineProfile::presentNotificationも参照してください

[invokable, since 6.8] QWebEnginePermission QQuickWebEngineProfile::queryPermission(const QUrl &securityOrigin, QWebEnginePermission::PermissionType permissionType) const

提供されたsecurityOriginpermissionType のための単一のパーミッションに対応するQWebEnginePermission オブジェクトを返します。このオブジェクトは、パーミッションの現在の状態を問い合わせたり、変更したりするために使用することができる。パーミッションが既に存在する必要はありません。返されたオブジェクトは、ウェブサイトがパーミッションを使用することが分かっている場合、パーミッションを事前に付与するために使用することもできます。

注意: これは永続的なパーミッション・タイプにのみ使用できる。永続的でないpermissionType 、無効なオブジェクトを返します。

注意 :この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

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

listAllPermissions(),listPermissionsForOrigin(),listPermissionsForPermissionType(),QWebEnginePermission::PermissionTypeも参照してください

void QQuickWebEngineProfile::removeAllUrlSchemeHandlers()

プロファイルにインストールされているすべてのカスタムURLスキームハンドラを削除します。

void QQuickWebEngineProfile::removeUrlScheme(const QByteArray &scheme)

プロファイルからカスタム URL スキームscheme を削除します。

removeUrlSchemeHandler()も参照してください

void QQuickWebEngineProfile::removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)

カスタム URL スキームハンドラhandler をプロファイルから削除します。

removeUrlScheme()も参照してください

void QQuickWebEngineProfile::setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)

URL リクエストをインターセプトするために、 リクエストインターセプターシングルトンinterceptor を登録します。

プロファイルはポインタの所有権を持ちません。

QWebEngineUrlRequestInfo およびQWebEngineUrlRequestInterceptorも参照してください

QStringList QQuickWebEngineProfile::spellCheckLanguages() const

スペルチェッカーが使用する言語のリストを返します。

注意: プロパティ spellCheckLanguages のゲッター関数です。

setSpellCheckLanguages()も参照してください

const QWebEngineUrlSchemeHandler *QQuickWebEngineProfile::urlSchemeHandler(const QByteArray &scheme) const

URL スキームscheme のカスタム URL スキームハンドラ登録を返します。

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.