WebEngineDownloadRequest QML Type

ダウンロードに関する情報を提供する。詳細...

• 継承されたメンバーを含む全メンバーのリスト

プロパティ

• 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

方法

• void accept()
• void cancel()
• void pause()
• void resume()

詳細説明

WebEngineDownloadRequest は、保留中のダウンロード要求から始まり、完了したダウンロードで終わる、ライフサイクル全体のダウンロードをモデル化します。たとえば、新しいダウンロードに関する情報の取得、進行状況の監視、ダウンロードの一時停止、再開、キャンセルなどに使用できます。

ダウンロードは通常、ウェブページ上でのユーザーの操作によって開始されます。新しいダウンロード要求をアプリケーショ ンに通知するのはWebEngineProfile の責任です。downloadRequested シグナルを新しく作成された WebEngineDownloadRequest と共に発信します。アプリケーションはこのアイテムを調べ、受け入れるかどうかを決定します。Qt WebEngine が実際にダウンロードを開始し、データをディスクに書き込むには、シグナル ハンドラが明示的にaccept() を呼び出す必要があります。シグナル・ハンドラがaccept （）を呼び出さない場合、ダウンロード要求は自動的に拒否され、ディスクには何も書き込まれません。

オブジェクトのライフサイクル

すべての項目は、downloadRequested シグナルが発せられる間、有効であることが保証される。どのシグナル・ハンドラからもaccept() が呼び出されなかった場合、そのアイテムはシグナルの 発生直後に削除されます。つまり、アプリケーションは、拒否されたダウンロード・アイテムの参照を保持してはなりません。

Webページのダウンロード

ネットワークから生のバイトを取得してディスクに書き込むだけの通常のファイル・ダウンロードに加えて、Qt WebEngine は完全なウェブ・ページの保存もサポートしている。これは、ページのHTMLを解析し、依存するリソースをダウンロードし、すべてを特別なファイル・フォーマット (savePageFormat) にパッケージ化する可能性がある。ダウンロードの対象がファイルかウェブページかを確認するには、isSavePageDownload を使用します。

WebEngineProfile 、WebEngineProfile::downloadRequested 、WebEngineProfile::downloadFinishedも参照してください 。

プロパティ・ドキュメンテーション

downloadDirectory : string

データがダウンロードされる完全なターゲットパス（ファイル名なし）を保持する。

ダウンロード・ディレクトリは、ダウンロードを受け付ける前にdownloadRequested ハンドラでのみ設定できる。

WebEngineProfile::downloadRequested() およびaccept()も参照 。

downloadFileName : string

データをダウンロードするファイル名を保持する。

ダウンロードファイル名は、ダウンロードを受け付ける前にdownloadRequested ハンドラでのみ設定できる。

WebEngineProfile::downloadRequested() およびaccept()も参照 。

id : int [read-only]

ダウンロードアイテムのIDを保持します。

interruptReason : enumeration [read-only]

ダウンロードが中断された理由を返します：

interruptReasonStringも参照のこと 。

interruptReasonString : string [read-only]

ダウンロードを中断した理由を人間が読める形で返す。

interruptReasonも参照 。

isFinished : bool [read-only]

このダウンロードが終了したかどうか（完了、キャンセル、または再開不可能な中断状態）。

isPaused : bool [read-only]

ダウンロードが一時停止されているかどうか。

pause およびresumeも参照のこと 。

isSavePageDownload : bool [read-only]

ウェブページを保存するためのダウンロード要求か、ファイルを保存するためのダウンロード要求か。

savePageFormatも参照 。

mimeType : string [read-only]

ダウンロードのMIMEタイプを保持する。

receivedBytes : int [read-only]

これまでにダウンロードされたデータ量をバイト単位で保持する。

savePageFormat : enumeration

ウェブページを保存するために使用されるフォーマットを記述します。

state : enumeration [read-only]

ダウンロードの状態を記述する：

suggestedFileName : string [read-only]

推奨されるファイル名を返します。

totalBytes : int [read-only]

ダウンロードするデータの総量をバイト単位で保持する。

-1 は合計サイズが不明であることを意味する。

url : url [read-only]

ダウンロード元のURLを返します。

view : WebEngineView [read-only]

ダウンロードが要求されたビューを返します。ダウンロードがビュー内のコンテンツによってトリガされなかった場合、nullptr が返されます。

WebEngineViewも参照ください 。

メソッドのドキュメント

void accept()

ダウンロード要求を受け付け、ダウンロードを開始する。

アイテムがDownloadRequested 状態の場合、DownloadInProgress 状態に遷移し、ダウンロードが開始されます。アイテムが他の状態にある場合は、何も起こりません。

stateも参照してください 。

void cancel()

ダウンロードをキャンセルします。

アイテムがDownloadInProgress 状態の場合、DownloadCancelled 状態に移行し、ダウンロードが停止し、部分的にダウンロードされたファイルがディスクから削除されます。

アイテムがDownloadCompleted 状態の場合は、何も起こりません。アイテムが他の状態にある場合は、そのままDownloadCancelled の状態に移行します。

stateも参照 。

void pause()

ダウンロードを一時停止する。

状態がDownloadInProgress でない場合は効果がない。状態を変更しない。

resume およびisPausedも参照のこと 。

void resume()

ダウンロードが一時停止または中断された場合、ダウンロードを再開する。

状態がDownloadInProgress またはDownloadInterrupted でない場合、効果はありません。状態を変更しない。

pause およびisPausedも参照のこと 。