Тип QML WebEngineDownloadItem

Предоставляет информацию о закачке. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Свойства

• id : int
• interruptReason : перечисление
• interruptReasonString : строка
• isFinished : bool
• isPaused : bool
• isSavePageDownload : bool
• mimeType : строка
• путь : строка
• receivedBytes : int
• форматСохраненияСтраницы : перечисление
• состояние : перечисление
• totalBytes : int

Методы

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

Подробное описание

WebEngineDownloadItem моделирует загрузку на протяжении всего её жизненного цикла, начиная с запроса на ожидаемую загрузку и заканчивая завершённой загрузкой. Его можно использовать, например, для получения информации о новых загрузках, для отслеживания прогресса и для приостановки, возобновления и отмены загрузок.

Загрузки обычно вызываются взаимодействием пользователя на веб-странице. WebEngineProfile несет ответственность за уведомление приложения о новых запросах на загрузку, что он делает, испуская сигнал downloadRequested вместе с только что созданным WebEngineDownloadItem. Затем приложение может проверить этот элемент и решить, принять его или нет. Обработчик сигнала должен явно вызвать accept() в элементе, чтобы Qt WebEngine фактически начал загрузку и запись данных на диск. Если ни один обработчик сигнала не вызывает accept(), запрос на загрузку будет автоматически отклонен, и ничего не будет записано на диск.

Примечание: Некоторые свойства, такие как путь, под которым будет сохранён файл, могут быть изменены только до вызова accept().

Жизненный цикл объекта

Гарантируется, что все элементы будут валидными во время испускания сигнала downloadRequested. Если accept() не вызывается никаким обработчиком сигнала, элемент будет удалён немедленно после испускания сигнала. Это означает, что приложение не должно сохранять ссылки на отклоненные элементы загрузки.

Загрузки веб-страниц

В дополнение к обычным загрузкам файлов, которые состоят просто из извлечения некоторых сырых байтов из сети и записи их на диск, Qt WebEngine также поддерживает сохранение полных веб-страниц, что включает в себя разбор HTML страницы, загрузку любых зависимых ресурсов и, возможно, упаковку всего в специальный формат файла (форматСохраненияСтраницы). Чтобы проверить, является ли загрузка файлом или веб-страницей, используйте isSavePageDownload.

См. также WebEngineProfile, WebEngineProfile::downloadRequested и WebEngineProfile::downloadFinished.

Документация по свойствам

id : int

Содержит идентификатор элемента загрузки.

[только для чтения] interruptReason : перечисление

Возвращает причину прерывания загрузки:

Это свойство было добавлено в QtWebEngine 1.5.

См. также interruptReasonString.

interruptReasonString : строка

Возвращает удобочитаемое описание причины прерывания загрузки.

Это свойство было добавлено в QtWebEngine 1.5.

См. также interruptReason.

[только для чтения] isFinished : bool

Завершена ли эта загрузка (завершена, отменена или прервана невозобновляемым состоянием).

Это свойство было добавлено в QtWebEngine 1.6.

[только для чтения] isPaused : bool

Приостановлена ли эта загрузка.

Это свойство было добавлено в QtWebEngine 1.6.

См. также pause и resume.

[только для чтения] isSavePageDownload : bool

Является ли это запросом на загрузку для сохранения веб-страницы или файла.

Это свойство было добавлено в QtWebEngine 1.7.

См. также форматСохраненияСтраницы.

mimeType : строка

Содержит тип MIME загрузки.

Это свойство было добавлено в QtWebEngine 1.2.

path : строка

Содержит полный целевой путь, куда загружаются данные.

Путь включает имя файла. Предлагаемый по умолчанию путь — стандартное место для загрузок, а имя файла выводится таким образом, чтобы не перезаписывать уже существующие файлы.

Путь загрузки можно установить только в обработчике downloadRequested до принятия загрузки.

См. также WebEngineProfile::downloadRequested() и accept().

receivedBytes : целое

Содержит объем данных в байтах, загруженных до настоящего момента.

savePageFormat : перечисление

Описывает формат сохранения веб-страницы.

Это свойство было добавлено в QtWebEngine 1.3.

state : перечисление

Описывает состояние загрузки:

totalBytes : целое

Содержит общий объем данных для загрузки в байтах.

-1 означает, что общий размер неизвестен.

Методы

void accept()

Принимает запрос на загрузку, что запустит загрузку.

Если элемент находится в состоянии DownloadRequested, то он перейдет в состояние DownloadInProgress и начнется загрузка. Если элемент находится в любом другом состоянии, ничего не произойдет.

См. также state.

void cancel()

Отменяет загрузку.

Если элемент находится в состоянии DownloadInProgress, то он перейдет в состояние DownloadCancelled, загрузка остановится, а частично загруженные файлы будут удалены с диска.

Если элемент находится в состоянии DownloadCompleted, ничего не произойдет. Если элемент находится в любом другом состоянии, он перейдет в состояние DownloadCancelled без дальнейшего эффекта.

См. также state.

void pause()

Приостанавливает загрузку.

Не оказывает никакого влияния, если состояние не DownloadInProgress. Не изменяет состояние.

Этот метод был добавлен в QtWebEngine 1.6.

См. также resume и isPaused.

void resume()

Возобновляет загрузку, если она была приостановлена или прервана.

Не оказывает никакого влияния, если состояние не DownloadInProgress или DownloadInterrupted. Не изменяет состояние.

Этот метод был добавлен в QtWebEngine 1.6.

См. также pause и isPaused.