QWebEngineDownloadRequest Class

The QWebEngineDownloadRequest class provides information about a download. 更多...

头：	#include <QWebEngineDownloadRequest>
CMake:	find_package(Qt6 REQUIRED COMPONENTS WebEngineCore) target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore)
qmake:	QT += webenginecore
实例化：	WebEngineDownloadRequest
继承：	QObject

所有成员列表，包括继承成员

公共类型

enum	DownloadInterruptReason { NoReason, FileFailed, FileAccessDenied, FileNoSpace, FileNameTooLong, …, UserCanceled }
enum	DownloadState { DownloadRequested, DownloadInProgress, DownloadCompleted, DownloadCancelled, DownloadInterrupted }
enum	SavePageFormat { UnknownSaveFormat, SingleHtmlSaveFormat, CompleteHtmlSaveFormat, MimeHtmlSaveFormat }

特性

isFinished : const bool
isPaused : const bool

公共函数

QString	downloadDirectory () const
QString	downloadFileName () const
quint32	id () const
QWebEngineDownloadRequest::DownloadInterruptReason	interruptReason () const
QString	interruptReasonString () const
bool	isFinished () const
bool	isPaused () const
bool	isSavePageDownload () const
QString	mimeType () const
QWebEnginePage *	page () const
qint64	receivedBytes () const
QWebEngineDownloadRequest::SavePageFormat	savePageFormat () const
void	setDownloadDirectory (const QString & directory )
void	setDownloadFileName (const QString & fileName )
void	setSavePageFormat (QWebEngineDownloadRequest::SavePageFormat format )
QWebEngineDownloadRequest::DownloadState	state () const
QString	suggestedFileName () const
qint64	totalBytes () const
QUrl	url () const

公共槽

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

信号

void	downloadDirectoryChanged ()
void	downloadFileNameChanged ()
void	interruptReasonChanged ()
void	isFinishedChanged ()
void	isPausedChanged ()
void	receivedBytesChanged ()
void	savePageFormatChanged ()
void	stateChanged (QWebEngineDownloadRequest::DownloadState state )
void	totalBytesChanged ()

详细描述

QWebEngineDownloadRequest models a download throughout its life cycle, starting with a pending download request and finishing with a completed download. It can be used, for example, to get information about new downloads, to monitor progress, and to pause, resume, and cancel downloads.

通常，下载由网页上的用户交互触发。它是 QWebEngineProfile 的职责，通知应用程序有新的下载请求，通过发射 downloadRequested signal together with a newly created QWebEngineDownloadRequest. The application can then examine this item and decide whether to accept it or not. A signal handler must explicitly call accept () 在项，以便 Qt WebEngine 实际开始下载并把数据写入磁盘。若没有信号处理程序调用 accept ()，那么下载请求将被自动拒绝，且什么都不会被写入磁盘。

注意： 某些特性，如设置文件保存路径和文件名 (见 downloadDirectory () 和 downloadFileName ())，才可以改变先于调用 accept ().

对象生命周期

所有项均保证有效，在发出期间为 downloadRequested 信号。若 accept () 是 not 被任何信号处理程序所调用，则项会被删除 immediately 在信号发出之后。这意味着应用程序不必对拒绝下载项保持引用。它也意味着应用程序不应对此信号使用队列连接。

若 accept () is 被信号处理程序所调用，那么 QWebEngineProfile 将获得项的所有权。不管怎样，应用程序随时删除项是安全的，除了在处理期间为 downloadRequested 信号。 QWebEngineProfile 是长期存活对象，事实上，推荐应用程序删除它不再感兴趣的任何项。

注意： 从 5.12.2 起删除项也会被自动取消下载，但为了可移植性，推荐在删除之前手动取消。

网页下载

除正常文件下载 (简单地从网络检索一些原生字节并把它们写入磁盘) 外，Qt WebEngine 还支持保存完整网页，涉及剖析页面的 HTML、下载任何从属资源及把潜在的一切打包进特殊文件格式 ( savePageFormat )。要检查下载的是文件还是网页，使用 isSavePageDownload .

另请参阅 QWebEngineProfile , QWebEngineProfile::downloadRequested , QWebEnginePage::download ，和 QWebEnginePage::save .

成员类型文档编制

enum QWebEngineDownloadRequest:: DownloadInterruptReason

描述下载为什么被中断的原因：

常量	值	描述
`QWebEngineDownloadRequest::NoReason`	`0`	未知原因或未中断。
`QWebEngineDownloadRequest::FileFailed`	`1`	常规文件操作故障。
`QWebEngineDownloadRequest::FileAccessDenied`	`2`	文件无法在本地写入，由于访问限定。
`QWebEngineDownloadRequest::FileNoSpace`	`3`	目标驱动器空间不足。
`QWebEngineDownloadRequest::FileNameTooLong`	`5`	目录或文件名太长。
`QWebEngineDownloadRequest::FileTooLarge`	`6`	文件大小超过文件系统限制。
`QWebEngineDownloadRequest::FileVirusInfected`	`7`	文件被病毒感染。
`QWebEngineDownloadRequest::FileTransientError`	`10`	临时问题 (例如：文件在使用中、内存不足或一次打开太多文件)。
`QWebEngineDownloadRequest::FileBlocked`	`11`	文件被阻塞由于本地策略。
`QWebEngineDownloadRequest::FileSecurityCheckFailed`	`12`	试图检查下载失败的安全性，由于意外原因。
`QWebEngineDownloadRequest::FileTooShort`	`13`	尝试寻址超出文件末尾，当打开文件时 (作为再继续先前被中断下载的一部分)。
`QWebEngineDownloadRequest::FileHashMismatch`	`14`	部分文件不匹配预期哈希。
`QWebEngineDownloadRequest::NetworkFailed`	`20`	常规网络故障。
`QWebEngineDownloadRequest::NetworkTimeout`	`21`	网络操作已超时。
`QWebEngineDownloadRequest::NetworkDisconnected`	`22`	网络连接已被终止。
`QWebEngineDownloadRequest::NetworkServerDown`	`23`	服务器宕机。
`QWebEngineDownloadRequest::NetworkInvalidRequest`	`24`	网络请求无效 (例如：原始或重定向 URL 无效，方案不受支持或被策略禁止)。
`QWebEngineDownloadRequest::ServerFailed`	`30`	常规服务器故障。
`QWebEngineDownloadRequest::ServerBadContent`	`33`	服务器没有请求的数据。
`QWebEngineDownloadRequest::ServerUnauthorized`	`34`	服务器未授权访问资源。
`QWebEngineDownloadRequest::ServerCertProblem`	`35`	服务器证书发生问题。
`QWebEngineDownloadRequest::ServerForbidden`	`36`	访问被服务器禁止。
`QWebEngineDownloadRequest::ServerUnreachable`	`37`	意外服务器响应 (可能指示响应服务器，可能不是企图服务器)。
`QWebEngineDownloadRequest::UserCanceled`	`40`	用户取消下载。

enum QWebEngineDownloadRequest:: DownloadState

此枚举描述下载的状态：

常量	值	描述
`QWebEngineDownloadRequest::DownloadRequested`	`0`	下载已请求，但尚未接受。
`QWebEngineDownloadRequest::DownloadInProgress`	`1`	下载正在进行中。
`QWebEngineDownloadRequest::DownloadCompleted`	`2`	下载成功完成。
`QWebEngineDownloadRequest::DownloadCancelled`	`3`	下载已被取消。
`QWebEngineDownloadRequest::DownloadInterrupted`	`4`	下载已被中断 (由服务器或由于丢失连接)。

enum QWebEngineDownloadRequest:: SavePageFormat

此枚举描述用于保存网页的格式。

常量	值	描述
`QWebEngineDownloadRequest::UnknownSaveFormat`	`-1`	这不是下载完整网页的请求。
`QWebEngineDownloadRequest::SingleHtmlSaveFormat`	`0`	页面被另存为单 HTML 页面。图像等资源不被保存。
`QWebEngineDownloadRequest::CompleteHtmlSaveFormat`	`1`	页面被另存为完整 HTML 页面，例如：目录包含单 HTML 页面和资源。
`QWebEngineDownloadRequest::MimeHtmlSaveFormat`	`2`	页面以 MIME HTML 格式，被另存为完整网页。

特性文档编制

`[read-only]` isFinished : const bool

This property holds whether this download is finished (completed, cancelled, or non-resumable interrupted state).

访问函数：

bool	isFinished () const

通知程序信号：

void	isFinishedChanged ()

另请参阅 state ().

`[read-only]` isPaused : const bool

This property holds whether this download is paused.

访问函数：

bool	isPaused () const

通知程序信号：

void	isPausedChanged ()

另请参阅 pause () 和 resume ().

成员函数文档编制

`[slot]` void QWebEngineDownloadRequest:: accept ()

接受当前下载请求，将开始下载。

若项在 DownloadRequested 状态，那么它将过渡到 DownloadInProgress 状态，且下载会开始。若项在任何其它状态，则什么都不会发生。

另请参阅 isFinished and stateChanged ().

`[slot]` void QWebEngineDownloadRequest:: cancel ()

取消当前下载。

若项在 DownloadInProgress 状态，那么它将过渡到 DownloadCancelled 状态，下载会停止，且部分下载文件会从磁盘被删除。

若项在 DownloadCompleted 状态，则什么都不会发生。若项在任何其它状态，则它会过渡到 DownloadCancelled 状态，没有进一步影响。

另请参阅 isFinished and stateChanged ().

QString QWebEngineDownloadRequest:: downloadDirectory () const

返回下载目录路径。

注意： Getter function for property downloadDirectory.

另请参阅 setDownloadDirectory ().

QString QWebEngineDownloadRequest:: downloadFileName () const

返回要下载文件的文件名。

注意： Getter function for property downloadFileName.

另请参阅 setDownloadFileName ().

quint32 QWebEngineDownloadRequest:: id () const

返回下载项 ID。

注意： Getter function for property id.

QWebEngineDownloadRequest::DownloadInterruptReason QWebEngineDownloadRequest:: interruptReason () const

返回下载为什么被中断的原因。

注意： Getter function for property interruptReason.

另请参阅 interruptReasonString ().

QString QWebEngineDownloadRequest:: interruptReasonString () const

返回人类可读的中断下载原因的描述。

注意： Getter function for property interruptReasonString.

另请参阅 interruptReason ().

`[signal]` void QWebEngineDownloadRequest:: isPausedChanged ()

此信号被发射每当 isPaused 改变。

注意： 通知程序信号对于特性 isPaused .

另请参阅 pause () 和 isPaused .

bool QWebEngineDownloadRequest:: isSavePageDownload () const

返回 true 若这是用于保存网页的下载请求。

注意： Getter function for property isSavePageDownload.

另请参阅 savePageFormat () 和 setSavePageFormat ().

QString QWebEngineDownloadRequest:: mimeType () const

返回下载的 MIME 类型。

注意： Getter function for property mimeType.

QWebEnginePage *QWebEngineDownloadRequest:: page () const

返回请求下载的页面。若下载不由页面内容所触发， nullptr 被返回。

`[slot]` void QWebEngineDownloadRequest:: pause ()

暂停下载。

不起作用，若状态不是 DownloadInProgress 。不改变状态。

另请参阅 resume () 和 isPaused ().

qint64 QWebEngineDownloadRequest:: receivedBytes () const

返回到目前为止已下载的数据数量 (以字节为单位)。

-1 意味着尺寸未知。

注意： Getter function for property receivedBytes.

`[slot]` void QWebEngineDownloadRequest:: resume ()

再继续当前下载，若它被暂停或中断。

不起作用，若状态不是 DownloadInProgress or DownloadInterrupted 。不改变状态。

另请参阅 pause (), isPaused ()，和 state ().

QWebEngineDownloadRequest::SavePageFormat QWebEngineDownloadRequest:: savePageFormat () const

返回保存网页的格式，如果这是用于网页的下载请求。

注意： Getter function for property savePageFormat.

另请参阅 setSavePageFormat () 和 isSavePageDownload ().

void QWebEngineDownloadRequest:: setDownloadDirectory (const QString & directory )

设置 directory 作为要下载文件的目录路径。

下载目录才可以被设置为响应 QWebEngineProfile::downloadRequested () 信号在接受下载前。此后，此函数对下载项状态不起作用。

注意： setter 函数对于特性 downloadDirectory .

另请参阅 downloadDirectory ().

void QWebEngineDownloadRequest:: setDownloadFileName (const QString & fileName )

设置 fileName 作为要下载文件的文件名。

下载文件名才可以被设置为响应 QWebEngineProfile::downloadRequested () 信号在接受下载前。此后，此函数对下载项状态不起作用。

注意： setter 函数对于特性 downloadFileName .

另请参阅 downloadFileName ().

void QWebEngineDownloadRequest:: setSavePageFormat ( QWebEngineDownloadRequest::SavePageFormat format )

设置 format 为网页保存，若这是网页下载请求。

注意： setter 函数对于特性 savePageFormat .

另请参阅 savePageFormat () 和 isSavePageDownload ().

QWebEngineDownloadRequest::DownloadState QWebEngineDownloadRequest:: state () const

返回下载项的当前状态。

注意： Getter function for property state.

另请参阅 DownloadState .

`[signal]` void QWebEngineDownloadRequest:: stateChanged ( QWebEngineDownloadRequest::DownloadState state )

此信号被发射每当下载的 state 改变。

注意： 通知程序信号对于特性 state .

另请参阅 state () 和 DownloadState .

QString QWebEngineDownloadRequest:: suggestedFileName () const

返回建议的文件名。

注意： Getter function for property suggestedFileName.

qint64 QWebEngineDownloadRequest:: totalBytes () const

Returns the total amount of data to download in bytes.