QQuickWebEngineProfile Class

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

Header: #include <QQuickWebEngineProfile>
CMake: find_package(Qt6 REQUIRED COMPONENTS WebEngineQuick)
target_link_libraries(mytarget PRIVATE Qt6::WebEngineQuick)
qmake: QT += webenginequick
In QML: WebEngineProfile
Inherits: 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 で導入されました。

プロパティ Documentation

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)

Notifier シグナル:

void httpCacheTypeChanged()

httpUserAgent : QString

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

アクセス関数:

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

Notifierシグナル:

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)

Notifier シグナル:

void pushServiceEnabledChanged()

offTheRecord : bool

Webエンジンのプロファイルが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)

Notifier シグナル:

void spellCheckEnabledChanged()

[since QtWebEngine 1.4] spellCheckLanguages : QStringList

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

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

アクセス関数:

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

Notifier signal: このプロパティは、QtWebEngine 1.4で導入されました:

void spellCheckLanguagesChanged()

storageName : QString

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

アクセス関数:

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

このプロファイルの Cookie ストアを返します。

[static] QQuickWebEngineProfile *QQuickWebEngineProfile::defaultProfile()

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

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

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

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

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

注: C++から使用するには、download を static_cast してください。QWebEngineDownloadRequest

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

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

注: C++から使用するには、static_castdownloadQWebEngineDownloadRequest

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 を返します。各オブジェクトは現在パーミッションストアに存在する1つのパーミッションを表します。返されるリストには、このプロファイルの特定の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 を返します。各オブジェクトは現在パーミッションストアに存在する1つのパーミッションを表します。返されるリストには、提供された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 スキームのカスタム URL スキームハンドラ登録を返しますscheme

本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します ここで提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。