File: qgsfiledownloaderdialog.sip.in

package info (click to toggle)
qgis 3.22.16%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,186,020 kB
  • sloc: cpp: 1,275,562; python: 194,091; xml: 15,597; perl: 3,471; sh: 3,368; sql: 2,485; ansic: 2,219; yacc: 1,056; lex: 574; javascript: 504; lisp: 411; makefile: 227
file content (73 lines) | stat: -rw-r--r-- 2,460 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/************************************************************************
 * 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(signature="appended")
:py:class:`QgsFileDownloaderDialog` is a QProgressDialog subclass which
handles file downloads and user feedback.

Internally, it uses :py:class:`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 :py:class:`QgsFileDownloader`.

.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgsfiledownloaderdialog.h"
%End
  public:

    QgsFileDownloaderDialog( const QUrl &url, const QString &outputFileName, const QString &authcfg = QString() );
%Docstring
:py:class:`QgsFileDownloader`

: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   *
 ************************************************************************/