QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Slots | Signals | Public 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 onDownloadCanceled ()
 Called when a download is canceled by the user this slot aborts the download and deletes the object. 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 ready to be processed. More...
 

Public Member Functions

 QgsFileDownloader (QUrl url, QString outputFileName, bool guiNotificationsEnabled=true)
 QgsFileDownloader. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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 and depending on the guiNotificationsEnabled parameter accepted by the constructor (default = true) the class will show a progress dialog and report all errors in a QMessageBox::warning dialog. If the guiNotificationsEnabled parameter is set to false, the class can still be used through the signals and slots mechanism. The object will destroy itself when the request completes, errors or is canceled.

Note
added in QGIS 2.18.1

Definition at line 41 of file qgsfiledownloader.h.

Constructor & Destructor Documentation

QgsFileDownloader::QgsFileDownloader ( QUrl  url,
QString  outputFileName,
bool  guiNotificationsEnabled = true 
)

QgsFileDownloader.

Parameters
urlthe download url
outputFileNamefile name where the downloaded content will be stored
guiNotificationsEnabledif false, the downloader will not display any progress bar or error message

Definition at line 27 of file qgsfiledownloader.cpp.

Member Function Documentation

void QgsFileDownloader::downloadCanceled ( )
signal

Emitted when the download was canceled by the user.

void QgsFileDownloader::downloadCompleted ( )
signal

Emitted when the download has completed successfully.

void QgsFileDownloader::downloadError ( QStringList  errorMessages)
signal

Emitted when an error makes the download fail.

void QgsFileDownloader::downloadExited ( )
signal

Emitted always when the downloader exits.

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

Emitted when data ready to be processed.

void QgsFileDownloader::onDownloadCanceled ( )
slot

Called when a download is canceled by the user this slot aborts the download and deletes the object.

Definition at line 79 of file qgsfiledownloader.cpp.


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