QGIS/python/gui/auto_generated/qgsfiledownloaderdialog.sip.in

74 lines
2.3 KiB
Plaintext
Raw Normal View History

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsfiledownloaderdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsFileDownloaderDialog : QProgressDialog
{
%Docstring
2017-12-15 10:36:55 -04:00
QgsFileDownloaderDialog is a QProgressDialog subclass which
handles file downloads and user feedback.
2017-12-15 10:36:55 -04:00
Internally, it uses QgsFileDownloader to handle the download,
while showing progress via a progress dialog and supporting
cancelation.
.. note::
Until QGIS 3.0 this functionality was available via QgsFileDownloader.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsfiledownloaderdialog.h"
%End
public:
QgsFileDownloaderDialog( const QUrl &url, const QString &outputFileName, const QString &authcfg = QString() );
%Docstring
2017-12-19 11:43:52 -04:00
:py:class:`QgsFileDownloader`
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param url: the download url
:param outputFileName: file name where the downloaded content will be stored
:param authcfg: optionally apply this authentication configuration
%End
signals:
void downloadCompleted();
%Docstring
Emitted when the download has completed successfully
%End
void downloadExited();
%Docstring
Emitted always when the downloader exits
%End
void downloadCanceled();
%Docstring
Emitted when the download was canceled by the user
%End
void downloadError( QStringList errorMessages );
%Docstring
Emitted when an error makes the download fail
%End
void downloadProgress( qint64 bytesReceived, qint64 bytesTotal );
%Docstring
Emitted when data are ready to be processed
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsfiledownloaderdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/