API to register new vector data providers

qgis · Jun 1, 2018 · 9d66eb8 · 9d66eb8
1 parent 222f3ad
commit 9d66eb8
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/python/core/auto_generated/qgsproviderregistry.sip.in b/python/core/auto_generated/qgsproviderregistry.sip.in
@@ -180,6 +180,19 @@ Returns a string containing the available protocol drivers
 
     void registerGuis( QWidget *widget );
 
+    void registerProvider( QgsProviderMetadata *providerMetadata /Transfer/ );
+%Docstring
+ register a new vector data provider from its ``providerMetadata``
+
+:param providerMetadata: QgsProviderMetadata instance describing the new provider
+
+.. note::
+
+   ownership of the QgsProviderMetadata instance is transferred to the registry
+
+.. versionadded:: 3.2
+%End
+
 
 
   private:

diff --git a/src/core/qgsproviderregistry.cpp b/src/core/qgsproviderregistry.cpp
@@ -525,6 +525,12 @@ void QgsProviderRegistry::registerGuis( QWidget *parent )
   }
 }
 
+void QgsProviderRegistry::registerProvider( QgsProviderMetadata *providerMetadata )
+{
+  if ( providerMetadata )
+    mProviders[ providerMetadata->key() ] = providerMetadata;
+}
+
 QString QgsProviderRegistry::fileVectorFilters() const
 {
   return mVectorFileFilters;

diff --git a/src/core/qgsproviderregistry.h b/src/core/qgsproviderregistry.h
@@ -179,6 +179,14 @@ class CORE_EXPORT QgsProviderRegistry
 
     void registerGuis( QWidget *widget );
 
+    /**
+     * \brief register a new vector data provider from its \a providerMetadata
+     * \param providerMetadata QgsProviderMetadata instance describing the new provider
+     * \note ownership of the QgsProviderMetadata instance is transferred to the registry
+     * \since QGIS 3.2
+     */
+    void registerProvider( QgsProviderMetadata *providerMetadata SIP_TRANSFER );
+
     /**
      * Open the given vector data source
      *