WebEngineProfile QML Type
複数のウェブエンジン・ビューに共通する設定、スクリプト、訪問したリンクが含まれています。詳細...
| Import Statement: | import QtWebEngine |
| Since: | QtWebEngine 1.1 |
| In C++: | QQuickWebEngineProfile |
プロパティ
- cachePath : string
- downloadPath : string
(since QtWebEngine 1.9) - httpAcceptLanguage : string
(since QtWebEngine 1.2) - httpCacheMaximumSize : int
- httpCacheType : enumeration
- httpUserAgent : string
- isPushServiceEnabled : bool
(since QtWebEngine 6.5) - offTheRecord : bool
- persistentCookiesPolicy : enumeration
- persistentPermissionsPolicy : enumeration
(since 6.8) - persistentStoragePath : string
- spellCheckEnabled : bool
(since QtWebEngine 1.4) - spellCheckLanguages : list<string>
(since QtWebEngine 1.4) - storageName : string
- userScripts : WebEngineScriptCollection
シグナル
- clearHttpCacheCompleted()
(since QtWebEngine 6.7) - downloadFinished(WebEngineDownloadRequest download)
- downloadRequested(WebEngineDownloadRequest download)
- presentNotification(WebEngineNotification notification)
(since QtWebEngine 1.9)
メソッド
- void clearHttpCache()
(since QtWebEngine 1.3) - list<webEnginePermission> listAllPermissions()
(since 6.8) - list<webEnginePermission> listPermissionsForOrigin(url securityOrigin)
(since 6.8) - list<webEnginePermission> listPermissionsForPermissionType(WebEnginePermission.PermissionType permissionType)
(since 6.8) - void queryPermission(url securityOrigin, WebEnginePermission.PermissionType permissionType)
(since 6.8)
詳細説明
WebEngineProfile には、設定、スクリプト、およびプロファイルに属するすべてのビューで共有される訪問済みリンクのリストが含まれます。
訪問したリンクに関する情報は、永続的なクッキーやその他の永続的なデータとともに、storageName プロパティによって決定されるストレージに保存されます。永続データはpersistentStoragePath プロパティによって決定されるサブディレクトリに、キャッシュはcachePath プロパティによって決定されるサブディレクトリに保存されます。httpCacheType プロパティには、インメモリまたはオンディスクというキャッシュのタイプが記述されます。storageName プロパティのみが設定されている場合、他の値はそれに基づいて自動的に生成されます。いずれかの値を手動で指定する場合は、プロファイルに属するページを作成する前に指定する必要があります。
プロファイルは、ページを互いに分離するために使用できます。典型的な使用例は、プライベート・ブラウジング・モード専用のオフレコ・プロファイルです。off-the-recordプロファイルは、クッキー、HTTPキャッシュ、および他の通常永続的なデータをメモリにのみ保存することを強制します。offTheRecord プロパティは、プロファイルが off-the-record であるかどうかを保持します。
各 Web エンジン・ビューには、関連付けられたプロファイルがあります。特定のプロファイルが設定されていないビューは、共通のプロファイルを共有します。
プロパティー ドキュメント
cachePath : string |
プロファイルのキャッシュ、特に HTTP キャッシュが保存される場所へのパス。
デフォルトでは、キャッシュはQStandardPaths::writableLocation(QStandardPaths::CacheLocation) の下、storageName という名前のディレクトリに保存されます。
downloadPath : string |
ダウンロードされたファイルが保存される場所へのパス。
ダウンロード場所に使用されるデフォルトのパスを上書きします。
空の文字列を設定すると、デフォルトのパスが復元されます。
注意: デフォルトでは、ダウンロード・パスはQStandardPaths::DownloadLocation です。
このプロパティは QtWebEngine 1.9 で導入されました。
httpAcceptLanguage : string |
Accept-Language HTTP リクエスト・ヘッダー・フィールドの値。
このプロパティは QtWebEngine 1.2 で導入されました。
httpCacheMaximumSize : int |
HTTP キャッシュの最大サイズ。0 の場合、サイズはQtWebEngine によって自動的に制御されます。デフォルト値は0 です。
httpCacheTypeも参照してください。
httpCacheType : enumeration |
この列挙は HTTP キャッシュのタイプを記述します：
| 定数 | 説明 |
|---|---|
WebEngineProfile.MemoryHttpCache | メモリ内キャッシュを使用します。これは、offTheRecord が設定されているか、storageName が利用できない場合にのみ可能な設定で、デフォルトです。 |
WebEngineProfile.DiskHttpCache | ディスク・キャッシュを使用します。これは、storageName を使用する非オフレコ・プロファイルのデフォルト値です。 |
WebEngineProfile.NoCache | キャッシュを無効にします。(5.7で追加) |
httpUserAgent : string |
ブラウザを識別するために HTTP で送信されるユーザーエージェント文字列。
注意: Windows 8.1 およびそれ以降では、アプリケーションに新しい Windows バージョンをサポートすると宣言するマニフェストが含まれていない限り、デフォルトのユーザーエージェントは常に "Windows NT 6.2" (Windows 8) を報告します。
isPushServiceEnabled : bool |
プッシュ メッセージング サービスが有効かどうか。
注意: デフォルトでは、プッシュ メッセージング サービスは無効になっています。
注意: Qt WebEngine はブラウザのプッシュサービスとしてFirebase Cloud Messaging (FCM)を使用します。そのため、すべてのプッシュメッセージはGoogleプッシュサービスとその各サーバーを経由します。
このプロパティは QtWebEngine 6.5 で導入されました。
offTheRecord : bool |
Webエンジンのプロファイルがoff-the-recordであるかどうか。off-the-recordプロファイルは、クッキー、HTTPキャッシュ、および他の通常永続的なデータをメモリにのみ保存することを強制します。プロファイルはデフォルトでoff-the-recordです。
プロファイルをoff-the-recordからディスクベースの動作に変更するには、適切なstorageName 。
storageNameも参照のこと 。
persistentCookiesPolicy : enumeration |
この列挙はクッキーの永続性のポリシーを記述します：
| 定数 | 説明 |
|---|---|
WebEngineProfile.NoPersistentCookies | セッション・クッキーと永続的クッキーの両方がメモリに保存されます。これは、offTheRecord が設定されているか、storageName が利用可能でない場合にのみ可能な設定で、デフォルトです。 |
WebEngineProfile.AllowPersistentCookies | 永続的とマークされたクッキーはディスクに保存され、ディスクからリストアされますが、セッション・クッキーはクラッシュ回復のためにのみディスクに保存されます。これはstorageName が設定された非 off-the-record プロファイルのデフォルト値です。 |
WebEngineProfile.ForcePersistentCookies | セッション・クッキーと永続的クッキーの両方がディスクに保存され、ディスクから復元されます。 |
persistentPermissionsPolicy : enumeration |
この列挙はパーミッションの永続性のためのポリシーを記述します：
| 定数 | 説明 |
|---|---|
WebEngineProfile.AskEveryTime | この列挙はパーミッションの永続性に関するポリシーを記述します。これは既存のアプリケーションとの後方互換性のためであり、それ以外は推奨されません。 |
WebEngineProfile.StoreInMemory | リクエストが行われるのは、パーミッションが初めて必要になったときだけです。それ以降のリクエストは、最初のユーザーの選択に応じて、自動的に許可または拒否されます。これは、アプリケーションがシャットダウンされるまで、同じQWebEngineProfile インスタンスを使用しているすべてのページに引き継がれます。これは、off-the-record が設定されているか、永続データパスが利用できない場合に適用される設定です。 |
WebEngineProfile.StoreOnDisk | PersistentPermissionsInMemory と同じように動作しますが、パーミッションはディスクに保存され、ディスクから復元されます。これはデフォルト設定です。 |
このプロパティは Qt 6.8 で導入されました。
persistentStoragePath : string |
ブラウザとウェブコンテンツの永続データが保存される場所へのパス。永続的なデータには、永続的なクッキー、HTML5 ローカルストレージ、訪問したリンクが含まれます。
デフォルトでは、ストレージはstorageName を使用して命名されたディレクトリ内のQStandardPaths::writableLocation(QStandardPaths::AppDataLocation) の下に配置されます。
spellCheckEnabled : bool |
このプロパティは、Web エンジンのスペルチェッカーが有効になっているかどうかを保持します。
このプロパティは QtWebEngine 1.4 で導入されました。
このプロパティは、スペルチェッカーが使用する言語のリストを保持します。各言語は、.bdic 辞書の名前と一致する必要があります。例えば、言語en-US は、en-US.bdic 辞書ファイルを読み込みます。
辞書ファイルの検索方法については、スペルチェッカー機能のドキュメントを参照してください。
.bdic 辞書のコンパイル方法の詳細については、「Spellchecker の例」を参照してください。
このプロパティは QtWebEngine 1.4 で導入されました。
storageName : string |
このプロパティは、QtWebEngine 1.4 で導入されました。永続データとキャッシュを保存するためにディスクを使用する各プロファイルに対して、個別のサブディレクトリを作成するために使用されるストレージ名です。
WebEngineProfile::persistentStoragePath およびWebEngineProfile::cachePathも参照して ください。
userScripts : WebEngineScriptCollection |
このプロファイルを共有するすべてのページに注入されるWebEngineScript オブジェクトのコレクションを返します。
シグナルの説明
|
このシグナルは、clearHttpCache() 操作が完了したときに発行されます。
注: 対応するハンドラはonClearHttpCacheCompleted です。
このシグナルは QtWebEngine 6.7 で導入されました。
clearHttpCache()も参照してください 。
downloadFinished(WebEngineDownloadRequest download) |
このシグナルは、ダウンロードが正常に終了した、キャンセルされた、中断された（接続が切断されたなど）、などの理由でダウンロードが停止するたびに発行されます。引数download は、終了したダウンロード・インスタンスの状態を保持する。
注： 対応するハンドラはonDownloadFinished です。
downloadRequested(WebEngineDownloadRequest download) |
このシグナルは、ダウンロードがトリガーされるたびに発行される。download 引数はダウンロードの状態を保持する。WebEngineDownloadRequest::accept() で明示的にダウンロードを許可しなければ、ダウンロードはデフォルトでキャンセルされる。
注： 対応するハンドラはonDownloadRequested 。
|
このシグナルは、新しく作成されたユーザー通知があるたびに発行されます。notification 引数は、データを照会し、対話するためのWebEngineNotification インスタンスを保持します。
注意 : 対応するハンドラはonPresentNotification です。
このシグナルは QtWebEngine 1.9 で導入されました。
メソッドの説明
|
プロファイルのキャッシュエントリを削除します。
注意 : クリア処理中は、新しいナビゲーションを開始したり、プロファイルに対する操作を開始しないようにしてください。clearHttpCacheCompleted() シグナルが完了を通知します。
このメソッドは QtWebEngine 1.3 で導入されました。
WebEngineProfile::cachePath およびclearHttpCacheCompleted()も参照してください 。
|
webEnginePermission オブジェクトのlist を返します。各オブジェクトは、パーミッションストアに現在存在する単一のパーミッションを表します。返されるリストには、このプロファイルに対して過去に付与/拒否されたすべてのパーミッションが含まれます。
注釈 persistentPermissionPolicy プロパティがAskEveryTime に設定されている場合、これは空のリストを返します。
このメソッドは Qt 6.8 で導入されました。
queryPermission()、listPermissionsForOrigin()、listPermissionsForPermissionType()、およびwebEnginePermission::isPersistent()も参照して ください。
|
webEnginePermission オブジェクトのlist を返します。各オブジェクトは、パーミッションストアに現在存在する単一のパーミッションを表します。返されるリストには、このプロファイルの特定のsecurityOrigin に関連付けられた、過去に付与/拒否されたすべてのパーミッションが含まれます。
注: パーミッションはオリジンごとに付与されるため、指定されたsecurityOrigin はオリジンの形式に取り除かれ、返されるリストにはオリジンのすべてのパーミッションが含まれる。したがって、https://www.example.com/some/page.html を渡すことは、https://www.example.com/ だけを渡すことと同じです。
注釈 persistentPermissionPolicy() がAskEveryTime に設定されている場合、これは空のリストを返します。
このメソッドはQt 6.8で導入されました。
queryPermission()、listAllPermissions()、listPermissionsForPermissionType() およびwebEnginePermission::isPersistent()も参照してください 。
|
webEnginePermission オブジェクトのlist を返します。各オブジェクトは、パーミッションストアに現在存在する単一のパーミッションを表します。返されるリストには、指定されたpermissionType の、過去に付与/拒否されたすべてのパーミッションが含まれる。permissionTypeがnon-persistentの場合、リストは空になります。
注釈 persistentPermissionPolicy() がAskEveryTime に設定されている場合、これは空のリストを返します。
このメソッドは Qt 6.8 で導入されました。
queryPermission()、listAllPermissions()、listPermissionsForOrigin() およびwebEnginePermission::isPersistent()も参照してください 。
|
指定されたsecurityOrigin とpermissionType に対する単一のパーミッションに対応するwebEnginePermission オブジェクトを返します。このオブジェクトは、パーミッションの現在の状態を問い合わせたり、変更したりするために使用することができます。パーミッションがすでに存在する必要はない。返されたオブジェクトは、ウェブサイトがパーミッションを使用することが分かっている場合、パーミッションを事前に付与するために使用することもできる。
注意: これは永続的なパーミッション・タイプにのみ使用できる。永続的でないpermissionType で呼び出すと、無効なオブジェクトが返されます。
このメソッドは Qt 6.8 で導入されました。
listAllPermissions(),listPermissionsForOrigin(),listPermissionsForPermissionType()も参照してください 。
©2024 The Qt Company Ltd. 本書に含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
