Тип QML WebEngineDownloadRequest

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

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

Свойства

• downloadDirectory : строка
• downloadFileName : строка
• id : целое число
• interruptReason : перечисление
• interruptReasonString : строка
• isFinished : логическое значение
• isPaused : логическое значение
• isSavePageDownload : логическое значение
• mimeType : строка
• receivedBytes : целое число
• savePageFormat : перечисление
• state : перечисление
• suggestedFileName : строка
• totalBytes : целое число
• url : url
• view : WebEngineView

Методы

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

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

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

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

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

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

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

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

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

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

downloadDirectory : строка

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

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

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

downloadFileName : строка

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

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

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

id : целое число

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

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

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

См. также interruptReasonString.

interruptReasonString : строка

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

См. также interruptReason.

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

Завершён ли этот запрос на скачивание (завершен, отменен или прерван без возможности возобновления).

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

Приостановлен ли этот запрос на скачивание.

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

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

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

См. также savePageFormat.

mimeType : string

Содержит MIME-тип скачивания.

receivedBytes : int

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

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

Описывает формат, используемый для сохранения веб-страницы.

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

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

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()

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

Не имеет эффекта, если состояние не DownloadInProgress. Не изменяет состояние.

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

void resume()

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

Не имеет эффекта, если состояние не DownloadInProgress или DownloadInterrupted. Не изменяет состояние.

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