move QgsNetworkContentFetcherRegistry::FetchingMode to Qgis (#44397)

qgis · Jul 27, 2021 · 6967406 · 6967406
1 parent 6b993f6
commit 6967406
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 20 deletions.
diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -349,6 +349,17 @@
 Qgis.DriveType.__doc__ = 'Drive types\n\n.. versionadded:: 3.20\n\n' + '* ``Unknown``: ' + Qgis.DriveType.Unknown.__doc__ + '\n' + '* ``Invalid``: ' + Qgis.DriveType.Invalid.__doc__ + '\n' + '* ``Removable``: ' + Qgis.DriveType.Removable.__doc__ + '\n' + '* ``Fixed``: ' + Qgis.DriveType.Fixed.__doc__ + '\n' + '* ``Remote``: ' + Qgis.DriveType.Remote.__doc__ + '\n' + '* ``CdRom``: ' + Qgis.DriveType.CdRom.__doc__ + '\n' + '* ``RamDisk``: ' + Qgis.DriveType.RamDisk.__doc__
 # --
 Qgis.DriveType.baseClass = Qgis
+QgsNetworkContentFetcherRegistry.FetchingMode = Qgis.FetchingMode
+# monkey patching scoped based enum
+QgsNetworkContentFetcherRegistry.DownloadLater = Qgis.FetchingMode.FetchLater
+QgsNetworkContentFetcherRegistry.DownloadLater.is_monkey_patched = True
+QgsNetworkContentFetcherRegistry.DownloadLater.__doc__ = "Do not start immediately the fetching"
+QgsNetworkContentFetcherRegistry.DownloadImmediately = Qgis.FetchingMode.FetchImmediately
+QgsNetworkContentFetcherRegistry.DownloadImmediately.is_monkey_patched = True
+QgsNetworkContentFetcherRegistry.DownloadImmediately.__doc__ = "The fetching will start immediately"
+Qgis.FetchingMode.__doc__ = 'Enum to determine when a fetching operation would begin\n\n.. versionadded:: 3.22\n\n' + '* ``DownloadLater``: ' + Qgis.FetchingMode.FetchLater.__doc__ + '\n' + '* ``DownloadImmediately``: ' + Qgis.FetchingMode.FetchImmediately.__doc__
+# --
+Qgis.FetchingMode.baseClass = Qgis
 # monkey patching scoped based enum
 Qgis.UnplacedLabelVisibility.FollowEngineSetting.__doc__ = "Respect the label engine setting"
 Qgis.UnplacedLabelVisibility.NeverShow.__doc__ = "Never show unplaced labels, regardless of the engine setting"

diff --git a/python/core/auto_additions/qgsnetworkcontentfetcherregistry.py b/python/core/auto_additions/qgsnetworkcontentfetcherregistry.py
diff --git a/python/core/auto_generated/network/qgsnetworkcontentfetcherregistry.sip.in b/python/core/auto_generated/network/qgsnetworkcontentfetcherregistry.sip.in
@@ -95,11 +95,6 @@ remote files during QGIS application running.
 #include "qgsnetworkcontentfetcherregistry.h"
 %End
   public:
-    enum FetchingMode
-    {
-      DownloadLater,
-      DownloadImmediately,
-    };
 
     explicit QgsNetworkContentFetcherRegistry();
 %Docstring
@@ -108,7 +103,7 @@ Create the registry for temporary downloaded files
 
     ~QgsNetworkContentFetcherRegistry();
 
-    const QgsFetchedContent *fetch( const QString &url, FetchingMode fetchingMode = DownloadLater );
+    const QgsFetchedContent *fetch( const QString &url, Qgis::FetchingMode fetchingMode = Qgis::FetchingMode::FetchLater );
 %Docstring
 Initialize a download for the given URL
 

diff --git a/python/core/auto_generated/qgis.sip.in b/python/core/auto_generated/qgis.sip.in
@@ -261,6 +261,12 @@ The development version
       RamDisk,
     };
 
+    enum class FetchingMode
+      {
+      FetchLater,
+      FetchImmediately,
+    };
+
     enum class UnplacedLabelVisibility
     {
       FollowEngineSetting,

diff --git a/src/core/editform/qgseditformconfig.cpp b/src/core/editform/qgseditformconfig.cpp
@@ -217,7 +217,7 @@ void QgsEditFormConfig::setUiForm( const QString &ui )
   if ( !ui.isEmpty() && !QUrl::fromUserInput( ui ).isLocalFile() )
   {
     // any existing download will not be restarted!
-    QgsApplication::instance()->networkContentFetcherRegistry()->fetch( ui, QgsNetworkContentFetcherRegistry::DownloadImmediately );
+    QgsApplication::instance()->networkContentFetcherRegistry()->fetch( ui, Qgis::FetchingMode::FetchImmediately );
   }
 
   if ( ui.isEmpty() )
@@ -323,7 +323,7 @@ void QgsEditFormConfig::setInitFilePath( const QString &filePath )
   if ( !filePath.isEmpty() && !QUrl::fromUserInput( filePath ).isLocalFile() )
   {
     // any existing download will not be restarted!
-    QgsApplication::instance()->networkContentFetcherRegistry()->fetch( filePath, QgsNetworkContentFetcherRegistry::DownloadImmediately );
+    QgsApplication::instance()->networkContentFetcherRegistry()->fetch( filePath, Qgis::FetchingMode::FetchImmediately );
   }
 }
 

diff --git a/src/core/network/qgsnetworkcontentfetcherregistry.cpp b/src/core/network/qgsnetworkcontentfetcherregistry.cpp
@@ -31,7 +31,7 @@ QgsNetworkContentFetcherRegistry::~QgsNetworkContentFetcherRegistry()
   mFileRegistry.clear();
 }
 
-const QgsFetchedContent *QgsNetworkContentFetcherRegistry::fetch( const QString &url, const FetchingMode fetchingMode )
+const QgsFetchedContent *QgsNetworkContentFetcherRegistry::fetch( const QString &url, const Qgis::FetchingMode fetchingMode )
 {
 
   if ( mFileRegistry.contains( url ) )
@@ -43,7 +43,7 @@ const QgsFetchedContent *QgsNetworkContentFetcherRegistry::fetch( const QString
 
   mFileRegistry.insert( url, content );
 
-  if ( fetchingMode == DownloadImmediately )
+  if ( fetchingMode == Qgis::FetchingMode::FetchImmediately )
     content->download();
 
 

diff --git a/src/core/network/qgsnetworkcontentfetcherregistry.h b/src/core/network/qgsnetworkcontentfetcherregistry.h
@@ -124,13 +124,6 @@ class CORE_EXPORT QgsNetworkContentFetcherRegistry : public QObject
 {
     Q_OBJECT
   public:
-    //! Enum to determine when the download should start
-    enum FetchingMode
-    {
-      DownloadLater,       //!< Do not start immediately the download to properly connect the fetched signal
-      DownloadImmediately, //!< The download will start immediately, not need to run QgsFecthedContent::download()
-    };
-    Q_ENUM( FetchingMode )
 
     //! Create the registry for temporary downloaded files
     explicit QgsNetworkContentFetcherRegistry() = default;
@@ -143,7 +136,7 @@ class CORE_EXPORT QgsNetworkContentFetcherRegistry : public QObject
      * \param fetchingMode defines if the download will start immediately or shall be manually triggered
      * \note If the download starts immediately, it will not redownload any already fetched or currently fetching file.
      */
-    const QgsFetchedContent *fetch( const QString &url, FetchingMode fetchingMode = DownloadLater );
+    const QgsFetchedContent *fetch( const QString &url, Qgis::FetchingMode fetchingMode = Qgis::FetchingMode::FetchLater );
 
 #ifndef SIP_RUN
 

diff --git a/src/core/qgis.h b/src/core/qgis.h
@@ -380,6 +380,17 @@ class CORE_EXPORT Qgis
     };
     Q_ENUM( DriveType )
 
+    /**
+     * Enum to determine when a fetching operation would begin
+     * \since QGIS 3.22
+     */
+    enum class FetchingMode SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsNetworkContentFetcherRegistry, FetchingMode ) : int
+      {
+      FetchLater SIP_MONKEYPATCH_COMPAT_NAME( DownloadLater ), //!< Do not start immediately the fetching
+      FetchImmediately SIP_MONKEYPATCH_COMPAT_NAME( DownloadImmediately ), //!< The fetching will start immediately
+    };
+    Q_ENUM( FetchingMode )
+
     /**
      * Unplaced label visibility.
      *