QGIS API Documentation  2.99.0-Master (19b062c)
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsFileDownloader Class Reference

QgsFileDownloader is a utility class for downloading files. More...

#include <qgsfiledownloader.h>

Inheritance diagram for QgsFileDownloader:
Inheritance graph
[legend]

Public Slots

void cancelDownload ()
 Call to abort the download and delete this object after the cancelation has been processed. More...
 
void startDownload ()
 Called to start the download. More...
 

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

 QgsFileDownloader (const QUrl &url, const QString &outputFileName, const QString &authcfg=QString(), bool delayStart=false)
 QgsFileDownloader. More...
 

Protected Member Functions

 ~QgsFileDownloader ()
 

Detailed Description

QgsFileDownloader is a utility class for downloading files.

To use this class, it is necessary to pass the URL and an output file name as arguments to the constructor, the download will start immediately.

The download is asynchronous.

The object will destroy itself when the request completes, errors or is canceled. An optional authentication configuration can be specified.

Note
This class was part of the GUI library from QGIS 2.18.1 until QGIS 3.0
Since
QGIS 3.0

Definition at line 43 of file qgsfiledownloader.h.

Constructor & Destructor Documentation

◆ QgsFileDownloader()

QgsFileDownloader::QgsFileDownloader ( const QUrl &  url,
const QString &  outputFileName,
const QString &  authcfg = QString(),
bool  delayStart = false 
)

QgsFileDownloader.

Parameters
urlthe download url
outputFileNamefile name where the downloaded content will be stored
authcfgoptionally apply this authentication configuration
delayStartif true, the download will not be commenced immediately and must be triggered by a later call to startDownload(). This can be useful if connections need to be made to the downloader and there's a chance the download will emit signals before these connections have been made.

Definition at line 28 of file qgsfiledownloader.cpp.

◆ ~QgsFileDownloader()

QgsFileDownloader::~QgsFileDownloader ( )
protected

Definition at line 39 of file qgsfiledownloader.cpp.

Member Function Documentation

◆ cancelDownload

void QgsFileDownloader::cancelDownload ( )
slot

Call to abort the download and delete this object after the cancelation has been processed.

See also
downloadCanceled()

Definition at line 83 of file qgsfiledownloader.cpp.

◆ downloadCanceled

void QgsFileDownloader::downloadCanceled ( )
signal

Emitted when the download was canceled by the user.

See also
cancelDownload()

◆ downloadCompleted

void QgsFileDownloader::downloadCompleted ( )
signal

Emitted when the download has completed successfully.

◆ downloadError

void QgsFileDownloader::downloadError ( QStringList  errorMessages)
signal

Emitted when an error makes the download fail.

◆ downloadExited

void QgsFileDownloader::downloadExited ( )
signal

Emitted always when the downloader exits.

◆ downloadProgress

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

Emitted when data are ready to be processed.

◆ startDownload

void QgsFileDownloader::startDownload ( )
slot

Called to start the download.

Definition at line 49 of file qgsfiledownloader.cpp.


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