Allow processing providers to specify a long name, and show it in tooltips

Add version number to gdal provider long name

Author: nyalldawson

python/core/processing/qgsprocessingprovider.sip

@@ -56,8 +56,22 @@ class QgsProcessingProvider : QObject
 
     virtual QString name() const = 0;
 %Docstring
- Returns the full provider name, which is used to describe the provider within the GUI.
+ Returns the provider name, which is used to describe the provider within the GUI.
+ This string should be short (e.g. "Lastools") and localised.
+.. seealso:: longName()
+.. seealso:: id()
+ :rtype: str
+%End
+
+    virtual QString longName() const;
+%Docstring
+ Returns the a longer version of the provider name, which can include extra details
+ such as version numbers. E.g. "Lastools LIDAR tools (version 2.2.1)".
  This string should be localised.
+
+ The default implementation returns the same string as name().
+
+.. seealso:: name()
 .. seealso:: id()
  :rtype: str
 %End

python/plugins/processing/algs/gdal/GdalAlgorithmProvider.py

@@ -124,6 +124,10 @@ def setActive(self, active):
     def name(self):
         return 'GDAL'
 
+    def longName(self):
+        version = GdalUtils.readableVersion()
+        return 'GDAL ({})'.format(version)
+
     def id(self):
         return 'gdal'
 

python/plugins/processing/gui/ProcessingToolbox.py

@@ -454,7 +454,6 @@ def activateProvider():
                 self.algorithmTree.setItemWidget(parent, 0, label)
             else:
                 parent.setText(0, text)
-            parent.setToolTip(0, parent.text(0))
 
         for groupItem in list(groups.values()):
             parent.addChild(groupItem)
@@ -512,6 +511,7 @@ def __init__(self, provider, tree, toolbox):
         self.provider = provider
         self.setIcon(0, self.provider.icon())
         self.setData(0, ProcessingToolbox.TYPE_ROLE, ProcessingToolbox.PROVIDER_ITEM)
+        self.setToolTip(0, self.provider.longName())
         self.populate()
 
     def refresh(self):

src/core/processing/qgsprocessingprovider.cpp

@@ -39,6 +39,11 @@ QString QgsProcessingProvider::svgIconPath() const
   return QgsApplication::iconPath( QStringLiteral( "processingAlgorithm.svg" ) );
 }
 
+QString QgsProcessingProvider::longName() const
+{
+  return name();
+}
+
 void QgsProcessingProvider::refreshAlgorithms()
 {
   qDeleteAll( mAlgorithms );

src/core/processing/qgsprocessingprovider.h

@@ -70,12 +70,25 @@ class CORE_EXPORT QgsProcessingProvider : public QObject
     virtual QString id() const = 0;
 
     /**
-     * Returns the full provider name, which is used to describe the provider within the GUI.
-     * This string should be localised.
+     * Returns the provider name, which is used to describe the provider within the GUI.
+     * This string should be short (e.g. "Lastools") and localised.
+     * \see longName()
      * \see id()
      */
     virtual QString name() const = 0;
 
+    /**
+     * Returns the a longer version of the provider name, which can include extra details
+     * such as version numbers. E.g. "Lastools LIDAR tools (version 2.2.1)".
+     * This string should be localised.
+     *
+     * The default implementation returns the same string as name().
+     *
+     * \see name()
+     * \see id()
+     */
+    virtual QString longName() const;
+
     /**
      * Returns true if the provider can be activated, or false if it cannot be activated (e.g. due to
      * missing external dependencies).