Add dataComment to data provider base class

qgis · Apr 6, 2020 · 59b0dc1 · 59b0dc1
1 parent cd32d11
commit 59b0dc1
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/python/core/auto_generated/qgsdataprovider.sip.in b/python/core/auto_generated/qgsdataprovider.sip.in
@@ -102,6 +102,18 @@ connection string
    only when needed within a provider
 %End
 
+    virtual QString dataComment() const;
+%Docstring
+Returns a short comment for the data that this provider is
+providing access to (e.g. the comment for postgres table).
+
+.. note::
+
+   The default implementation returns an empty string.
+
+.. versionadded:: 3.14
+%End
+
     void setUri( const QgsDataSourceUri &uri );
 %Docstring
 Set the data source specification.

diff --git a/src/core/qgsdataprovider.h b/src/core/qgsdataprovider.h
@@ -152,6 +152,16 @@ class CORE_EXPORT QgsDataProvider : public QObject
       }
     }
 
+    /**
+     * Returns a short comment for the data that this provider is
+     * providing access to (e.g. the comment for postgres table).
+     *
+     * \note The default implementation returns an empty string.
+     * \since QGIS 3.14
+     */
+    virtual QString dataComment() const { return QString(); };
+
+
     /**
      * Set the data source specification.
      *