QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Signals | Public Member Functions | List of all members
QgsFileDownloaderDialog Class Reference

QgsFileDownloaderDialog is a QProgressDialog subclass which handles file downloads and user feedback. More...

#include <qgsfiledownloaderdialog.h>

Inheritance diagram for QgsFileDownloaderDialog:
Inheritance graph
[legend]

Signals

void downloadCanceled ()
 Emitted when the download was canceled by the user. More...
 
void downloadCompleted ()
 Emitted when the download has completed successfully. More...
 
void downloadError (QStringList errorMessages)
 Emitted when an error makes the download fail. More...
 
void downloadExited ()
 Emitted always when the downloader exits. More...
 
void downloadProgress (qint64 bytesReceived, qint64 bytesTotal)
 Emitted when data are ready to be processed. More...
 

Public Member Functions

 QgsFileDownloaderDialog (const QUrl &url, const QString &outputFileName, const QString &authcfg=QString())
 QgsFileDownloader. More...
 

Detailed Description

QgsFileDownloaderDialog is a QProgressDialog subclass which handles file downloads and user feedback.

Internally, it uses QgsFileDownloader to handle the download, while showing progress via a progress dialog and supporting cancellation.

Note
Until QGIS 3.0 this functionality was available via QgsFileDownloader.

Definition at line 36 of file qgsfiledownloaderdialog.h.

Constructor & Destructor Documentation

◆ QgsFileDownloaderDialog()

QgsFileDownloaderDialog::QgsFileDownloaderDialog ( const QUrl &  url,
const QString &  outputFileName,
const QString &  authcfg = QString() 
)

QgsFileDownloader.

Parameters
urlthe download url
outputFileNamefile name where the downloaded content will be stored
authcfgoptionally apply this authentication configuration

Definition at line 21 of file qgsfiledownloaderdialog.cpp.

Member Function Documentation

◆ downloadCanceled

void QgsFileDownloaderDialog::downloadCanceled ( )
signal

Emitted when the download was canceled by the user.

◆ downloadCompleted

void QgsFileDownloaderDialog::downloadCompleted ( )
signal

Emitted when the download has completed successfully.

◆ downloadError

void QgsFileDownloaderDialog::downloadError ( QStringList  errorMessages)
signal

Emitted when an error makes the download fail.

◆ downloadExited

void QgsFileDownloaderDialog::downloadExited ( )
signal

Emitted always when the downloader exits.

◆ downloadProgress

void QgsFileDownloaderDialog::downloadProgress ( qint64  bytesReceived,
qint64  bytesTotal 
)
signal

Emitted when data are ready to be processed.


The documentation for this class was generated from the following files: