WebEngineDownloadItem QML Type

Provides information about a download. More...

Import Statement: import QtWebEngine 1.2
Since: QtWebEngine 1.1



Detailed Description

Stores the state of a download to be used to manage requested downloads.

By default, the download is rejected unless the user explicitly accepts it with WebEngineDownloadItem::accept().

Property Documentation

id : int

Holds the download item's ID.

mimeType : string

Holds the MIME type of the download.

This QML property was introduced in QtWebEngine 1.2.

path : string

Holds the full target path where data is being downloaded to.

The path includes the file name. The default suggested path is the standard download location and file name is deduced not to overwrite already existing files.

The download path can only be set in the WebEngineProfile.onDownloadRequested handler before the download is accepted.

See also WebEngineProfile::downloadRequested() and accept().

receivedBytes : int

Holds the amount of data in bytes that has been downloaded so far.

state : enumeration

Describes the state of the download:

WebEngineDownloadItem.DownloadRequestedDownload has been requested, but it has not been accepted yet.
WebEngineDownloadItem.DownloadInProgressDownload is in progress.
WebEngineDownloadItem.DownloadCompletedDownload completed successfully.
WebEngineDownloadItem.DownloadInterruptedDownload has been interrupted (by the server or because of lost connectivity).

totalBytes : int

Holds the total amount of data to download in bytes.

-1 means the total size is unknown.

Method Documentation

void accept()

Accepts the download request, which will start the download.

See also WebEngineDownloadItem::cancel().

void cancel()

Cancels the download.

© 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.