[processing] Add version method to QgsProcessingProvider

Allows retrieving provider version
qgis · Apr 8, 2019 · 708bf44 · 708bf44
1 parent 67dabd7
commit 708bf44
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/python/core/auto_generated/processing/qgsprocessingprovider.sip.in b/python/core/auto_generated/processing/qgsprocessingprovider.sip.in
@@ -87,6 +87,16 @@ The default implementation returns the same string as name().
 .. seealso:: :py:func:`name`
 
 .. seealso:: :py:func:`id`
+%End
+
+    virtual QString versionInfo() const;
+%Docstring
+Returns a version information string for the provider, or an empty string if this
+is not applicable (e.g. for inbuilt Processing providers).
+
+For plugin based providers, this should return the plugin's version identifier.
+
+.. versionadded:: 3.8
 %End
 
     virtual bool canBeActivated() const;

diff --git a/src/core/processing/qgsprocessingprovider.cpp b/src/core/processing/qgsprocessingprovider.cpp
@@ -51,6 +51,11 @@ QString QgsProcessingProvider::longName() const
   return name();
 }
 
+QString QgsProcessingProvider::versionInfo() const
+{
+  return QString();
+}
+
 QStringList QgsProcessingProvider::supportedOutputRasterLayerExtensions() const
 {
   return QgsRasterFileWriter::supportedFormatExtensions();

diff --git a/src/core/processing/qgsprocessingprovider.h b/src/core/processing/qgsprocessingprovider.h
@@ -98,6 +98,16 @@ class CORE_EXPORT QgsProcessingProvider : public QObject
      */
     virtual QString longName() const;
 
+    /**
+     * Returns a version information string for the provider, or an empty string if this
+     * is not applicable (e.g. for inbuilt Processing providers).
+     *
+     * For plugin based providers, this should return the plugin's version identifier.
+     *
+     * \since QGIS 3.8
+     */
+    virtual QString versionInfo() const;
+
     /**
      * Returns TRUE if the provider can be activated, or FALSE if it cannot be activated (e.g. due to
      * missing external dependencies).