WebEngineDownloadRequest QML Type
ダウンロードに関する情報を提供する。詳細...
| Import Statement: | import QtWebEngine |
| In C++: | QWebEngineDownloadRequest |
プロパティ
- downloadDirectory : string
- downloadFileName : string
- id : int
- interruptReason : enumeration
- interruptReasonString : string
- isFinished : bool
- isPaused : bool
- isSavePageDownload : bool
- mimeType : string
- receivedBytes : int
- savePageFormat : enumeration
- state : enumeration
- suggestedFileName : string
- totalBytes : int
- url : url
- view : WebEngineView
メソッド
詳細説明
WebEngineDownloadRequest は、保留中のダウンロード要求から始まり、完了したダウンロードで終わる、ライフサイクル全体のダウンロードをモデル化します。たとえば、新しいダウンロードに関する情報の取得、進行状況の監視、ダウンロードの一時停止、再開、キャンセルなどに使用できます。
ダウンロードは通常、ウェブページ上でのユーザーの操作によって開始されます。新しいダウンロード要求をアプリケーショ ンに通知するのはWebEngineProfile の責任です。downloadRequested シグナルを新しく作成された WebEngineDownloadRequest と共に発信します。アプリケーションはこのアイテムを調べ、受け入れるかどうかを決定します。Qt WebEngine が実際にデータのダウンロードとディスクへの書き込みを開始するには、 シグナルハンドラがアイテムに対してaccept() を明示的に呼び出す必要があります。シグナルハンドラがaccept() を呼び出さない場合、ダウンロード要求は自動的に拒否され、ディスクには何も書き込まれません。
オブジェクトのライフサイクル
すべての項目は、downloadRequested シグナルが発せられる間、有効であることが保証される。どのシグナル・ハンドラからもaccept() が呼び出されなかった場合、そのアイテムはシグナルの 発生直後に削除されます。つまり、アプリケーションは、拒否されたダウンロード・アイテムの参照を保持してはなりません。
Webページのダウンロード
Qt WebEngine は、ネットワークから生のバイトを取得してディスクに書き込むだけの通常のファイルダ ウンロードに加えて、ページの HTML を解析して依存リソースをダウンロードし、すべてを特殊なファイル形式 (savePageFormat) にパッケージ化する可能性のある完全な Web ページの保存もサポートしています。ダウンロードがファイルか Web ページかを確認するには、isSavePageDownload を使用します。
WebEngineProfile 、WebEngineProfile::downloadRequested 、WebEngineProfile::downloadFinishedも参照してください 。
プロパティ Documentation
downloadDirectory : string |
データがダウンロードされるファイル名なしの完全なターゲット・パスを保持します。
ダウンロード・ディレクトリは、ダウンロードを受け付ける前のdownloadRequested ハンドラでのみ設定できます。
WebEngineProfile::downloadRequested() およびaccept()も参照してください 。
downloadFileName : string |
データのダウンロード先のファイル名を保持します。
ダウンロード・ファイル名は、ダウンロードを受け付ける前にdownloadRequested ハンドラでのみ設定できる。
WebEngineProfile::downloadRequested() およびaccept()も参照 。
id : int |
ダウンロード項目の ID を保持します。
interruptReason : enumeration |
ダウンロードが中断された理由を返します：
| 定数 | 説明 |
|---|---|
WebEngineDownloadRequest.NoReason | 不明な理由、または中断されていません。 |
WebEngineDownloadRequest.FileFailed | 一般的なファイル操作の失敗。 |
WebEngineDownloadRequest.FileAccessDenied | アクセス制限のため、ファイルをローカルに書き込めません。 |
WebEngineDownloadRequest.FileNoSpace | ターゲット・ドライブの空き容量不足。 |
WebEngineDownloadRequest.FileNameTooLong | ディレクトリ名またはファイル名が長すぎる。 |
WebEngineDownloadRequest.FileTooLarge | ファイル・サイズがファイル・システムの制限を超えている。 |
WebEngineDownloadRequest.FileVirusInfected | ファイルがウイルスに感染している。 |
WebEngineDownloadRequest.FileTransientError | 一時的な問題（ファイルが使用中、メモリ不足、一度に開くファイルが多すぎるなど）。 |
WebEngineDownloadRequest.FileBlocked | ローカルポリシーによりファイルがブロックされた。 |
WebEngineDownloadRequest.FileSecurityCheckFailed | ダウンロードの安全性を確認しようとしましたが、予期せぬ理由で失敗しました。 |
WebEngineDownloadRequest.FileTooShort | ファイルを開くときに、（以前に中断されたダウンロードを再開する一環として）ファイルの終端を超えてシークしようとしました。 |
WebEngineDownloadRequest.FileHashMismatch | 部分ファイルが予想されたハッシュと一致しませんでした。 |
WebEngineDownloadRequest.NetworkFailed | 一般的なネットワーク障害。 |
WebEngineDownloadRequest.NetworkTimeout | ネットワーク操作がタイムアウトしました。 |
WebEngineDownloadRequest.NetworkDisconnected | ネットワーク接続が終了しました。 |
WebEngineDownloadRequest.NetworkServerDown | サーバーがダウンしました。 |
WebEngineDownloadRequest.NetworkInvalidRequest | ネットワーク要求が無効でした（たとえば、元の URL またはリダイレクトされた URL が無効、サポートされていないスキーム、またはポリシーで許可されていない）。 |
WebEngineDownloadRequest.ServerFailed | 一般的なサーバー障害。 |
WebEngineDownloadRequest.ServerBadContent | サーバーに要求されたデータがない。 |
WebEngineDownloadRequest.ServerUnauthorized | サーバーがリソースへのアクセスを許可しませんでした。 |
WebEngineDownloadRequest.ServerCertProblem | サーバー証明書に問題が発生しました。 |
WebEngineDownloadRequest.ServerForbidden | サーバーがアクセスを禁止した。 |
WebEngineDownloadRequest.ServerUnreachable | 予期しないサーバー応答（応答したサーバーが意図したサーバーでない可能性があることを示す）。 |
WebEngineDownloadRequest.UserCanceled | ユーザーがダウンロードをキャンセルした。 |
interruptReasonStringも参照のこと 。
interruptReasonString : string |
ダウンロードを中断した理由を人間が読める形で返します。
interruptReason も参照 。
isFinished : bool |
このダウンロードが終了したかどうか（完了、キャンセル、または再開不可能な中断状態）。
isSavePageDownload : bool |
このダウンロードがウェブページまたはファイルの保存要求かどうか。
savePageFormatも参照 。
mimeType : string |
ダウンロードの MIME タイプを保持します。
receivedBytes : int |
現在までにダウンロードされたデータ量をバイト単位で保持します。
savePageFormat : enumeration |
Web ページの保存に使用される形式を記述します。
| 定数 | 説明 |
|---|---|
WebEngineDownloadRequest.UnknownSaveFormat | これは完全なウェブページをダウンロードするためのリクエストではありません。 |
WebEngineDownloadRequest.SingleHtmlSaveFormat | ページは単一の HTML ページとして保存されます。画像のようなリソースは保存されません。 |
WebEngineDownloadRequest.CompleteHtmlSaveFormat | ページは完全なHTMLページとして保存され、例えば、単一のHTMLページとリソースを含むディレクトリとして保存されます。 |
WebEngineDownloadRequest.MimeHtmlSaveFormat | ページは、MIME HTML形式の完全なWebページとして保存されます。 |
state : enumeration |
ダウンロードの状態を表します：
| 定数 | 説明 |
|---|---|
WebEngineDownloadRequest.DownloadRequested | ダウンロードが要求されたが、まだ受け入れられていない。 |
WebEngineDownloadRequest.DownloadInProgress | ダウンロードは進行中です。 |
WebEngineDownloadRequest.DownloadCompleted | ダウンロードは正常に完了しました。 |
WebEngineDownloadRequest.DownloadCancelled | ダウンロードはユーザーによってキャンセルされました。 |
WebEngineDownloadRequest.DownloadInterrupted | ダウンロードが中断されました（サーバーによって、または接続が失われたため）。 |
suggestedFileName : string |
推奨ファイル名を返します。
totalBytes : int |
ダウンロードするデータの総量をバイト単位で保持します。
-1 は、合計サイズが不明であることを意味します。
url : url |
ダウンロード元のURLを返します。
view : WebEngineView |
ダウンロードが要求されたビューを返します。ダウンロードがビューのコンテンツによってトリガされなかった場合、nullptr が返されます。
WebEngineViewも参照してください 。
メソッドの説明
void accept() |
ダウンロード要求を受け付け、ダウンロードを開始します。
アイテムがDownloadRequested 状態の場合、DownloadInProgress 状態に遷移し、ダウンロードが開始されます。アイテムが他の状態にある場合は、何も起こりません。
stateも参照してください 。
void cancel() |
ダウンロードをキャンセルします。
アイテムがDownloadInProgress の状態にある場合、DownloadCancelled の状態に遷移し、ダウンロードが中止され、部分的にダウンロードされたファイルがディスクから削除されます。
アイテムがDownloadCompleted の状態にある場合は、何も起こりません。アイテムが他の状態にある場合は、そのままDownloadCancelled の状態に移行します。
stateも参照してください 。
void pause() |
void resume() |
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
