Rename method, docs and api breaks documentation

doc/api_break.dox

@@ -1253,6 +1253,15 @@ QgsFieldProxyModel        {#qgis_api_break_3_0_QgsFieldProxyModel}
 - In QgsFieldProxyModel::Filter, All has been renamed to AllTypes
 
 
+QgsFileDownloader       {#qgis_api_break_3_0_QgsFileDownloader}
+-----------------
+
+- In 2.x QgsFileDownloader was a gui library class. In 3.0 its functionality has been split into
+two new classes - a core QgsFileDownloader class, which handles just the file download functionality
+and contains no GUI progress bar dialog, and a separate QgsFileDownloaderDialog class which
+incorporates a QgsFileDownloader together with a user-visible progress bar dialog
+
+
 QgsGeometry        {#qgis_api_break_3_0_QgsGeometry}
 -----------
 

python/core/qgsfiledownloader.sip

@@ -22,7 +22,10 @@ class QgsFileDownloader : QObject
  The object will destroy itself when the request completes, errors or is canceled.
  An optional authentication configuration can be specified.
 
-.. versionadded:: 2.18.1
+.. note::
+
+   This class was part of the GUI library from QGIS 2.18.1 until QGIS 3.0
+.. versionadded:: 3.0
 %End
 
 %TypeHeaderCode
@@ -51,10 +54,13 @@ Emitted when the download has completed successfully
 %Docstring
 Emitted always when the downloader exits
 %End
+
     void downloadCanceled();
 %Docstring
-Emitted when the download was canceled by the user
+ Emitted when the download was canceled by the user.
+.. seealso:: cancelDownload()
 %End
+
     void downloadError( QStringList errorMessages );
 %Docstring
 Emitted when an error makes the download fail
@@ -66,13 +72,11 @@ Emitted when data are ready to be processed
 
   public slots:
 
-    void onDownloadCanceled();
+    void cancelDownload();
 %Docstring
- Called when a download is canceled by the user
- this slot aborts the download and deletes
- the object.
- Never call this slot directly: this is meant to
- be managed by the signal-slot system.
+ Call to abort the download and delete this object after the cancelation
+ has been processed.
+.. seealso:: downloadCanceled()
 %End
 
     void startDownload();

python/gui/qgsfiledownloaderdialog.sip

@@ -19,6 +19,10 @@ class QgsFileDownloaderDialog : QProgressDialog
  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
 

src/core/qgsfiledownloader.cpp

@@ -80,7 +80,7 @@ void QgsFileDownloader::startDownload()
 #endif
 }
 
-void QgsFileDownloader::onDownloadCanceled()
+void QgsFileDownloader::cancelDownload()
 {
   mDownloadCanceled = true;
   emit downloadCanceled();

src/core/qgsfiledownloader.h

@@ -37,7 +37,8 @@
  * The object will destroy itself when the request completes, errors or is canceled.
  * An optional authentication configuration can be specified.
  *
- * \since QGIS 2.18.1
+ * \note This class was part of the GUI library from QGIS 2.18.1 until QGIS 3.0
+ * \since QGIS 3.0
  */
 class CORE_EXPORT QgsFileDownloader : public QObject
 {
@@ -61,8 +62,13 @@ class CORE_EXPORT QgsFileDownloader : public QObject
     void downloadCompleted();
     //! Emitted always when the downloader exits
     void downloadExited();
-    //! Emitted when the download was canceled by the user
+
+    /**
+     * Emitted when the download was canceled by the user.
+     * \see cancelDownload()
+     */
     void downloadCanceled();
+
     //! Emitted when an error makes the download fail
     void downloadError( QStringList errorMessages );
     //! Emitted when data are ready to be processed
@@ -71,13 +77,11 @@ class CORE_EXPORT QgsFileDownloader : public QObject
   public slots:
 
     /**
-     * Called when a download is canceled by the user
-     * this slot aborts the download and deletes
-     * the object.
-     * Never call this slot directly: this is meant to
-     * be managed by the signal-slot system.
+     * Call to abort the download and delete this object after the cancelation
+     * has been processed.
+     * \see downloadCanceled()
      */
-    void onDownloadCanceled();
+    void cancelDownload();
 
     //! Called to start the download
     void startDownload();

src/gui/qgsfiledownloaderdialog.cpp

@@ -24,7 +24,7 @@ QgsFileDownloaderDialog::QgsFileDownloaderDialog( const QUrl &url, const QString
   setLabelText( tr( "Downloading %1." ).arg( outputFileName ) );
   show();
 
-  connect( this, &QProgressDialog::canceled, mDownloader, &QgsFileDownloader::onDownloadCanceled );
+  connect( this, &QProgressDialog::canceled, mDownloader, &QgsFileDownloader::cancelDownload );
   connect( mDownloader, &QgsFileDownloader::downloadError, this, &QgsFileDownloaderDialog::onError );
   connect( mDownloader, &QgsFileDownloader::downloadProgress, this, &QgsFileDownloaderDialog::onDownloadProgress );
   connect( mDownloader, &QgsFileDownloader::downloadExited, this, &QgsFileDownloaderDialog::deleteLater );

src/gui/qgsfiledownloaderdialog.h

@@ -30,6 +30,8 @@ class QgsFileDownloader;
  * while showing progress via a progress dialog and supporting
  * cancelation.
  *
+ * \note Until QGIS 3.0 this functionality was available via QgsFileDownloader.
+ *
  * \since QGIS 3.0
  */
 class GUI_EXPORT QgsFileDownloaderDialog : public QProgressDialog

tests/src/gui/testqgsfiledownloader.cpp

@@ -104,7 +104,7 @@ void TestQgsFileDownloader::makeCall( QUrl url, QString fileName, bool cancel )
   connect( mFileDownloader, &QgsFileDownloader::downloadExited, &loop, &QEventLoop::quit );
 
   if ( cancel )
-    QTimer::singleShot( 1000, mFileDownloader, &QgsFileDownloader::onDownloadCanceled );
+    QTimer::singleShot( 1000, mFileDownloader, &QgsFileDownloader::cancelDownload );
 
   loop.exec();
 

tests/src/python/test_qgsfiledownloader.py

@@ -53,7 +53,7 @@ def _make_download(self, url, destination, cancel=False):
         downloader.downloadExited.connect(loop.quit)
 
         if cancel:
-            downloader.downloadProgress.connect(downloader.onDownloadCanceled)
+            downloader.downloadProgress.connect(downloader.cancelDownload)
 
         loop.exec_()