Port getCustomParametersDialog to QgsProcessingAlgorithm

qgis · Jun 5, 2017 · 1e78855 · 1e78855
1 parent fb81176
commit 1e78855
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 11 deletions.
diff --git a/python/core/processing/qgsprocessingalgorithm.sip b/python/core/processing/qgsprocessingalgorithm.sip
@@ -184,6 +184,15 @@ class QgsProcessingAlgorithm
  :rtype: QVariantMap
 %End
 
+    virtual QWidget *createCustomParametersWidget( QWidget *parent = 0 ) const /Factory/;
+%Docstring
+ If an algorithm subclass implements a custom parameters widget, a copy of this widget
+ should be constructed and returned by this method.
+ The base class implementation returns None, which indicates that an autogenerated
+ parameters widget should be used.
+ :rtype: QWidget
+%End
+
   protected:
 
     bool addParameter( QgsProcessingParameterDefinition *parameterDefinition /Transfer/ );

diff --git a/python/plugins/processing/algs/gdal/GdalAlgorithm.py b/python/plugins/processing/algs/gdal/GdalAlgorithm.py
@@ -55,7 +55,7 @@ def icon(self):
     def svgIconPath(self):
         return QgsApplication.iconPath("providerGdal.svg")
 
-    def getCustomParametersDialog(self):
+    def createCustomParametersWidget(self, parent):
         return GdalAlgorithmDialog(self)
 
     def processAlgorithm(self, context, feedback):

diff --git a/python/plugins/processing/algs/qgis/FieldsCalculator.py b/python/plugins/processing/algs/qgis/FieldsCalculator.py
@@ -169,5 +169,5 @@ def checkParameterValuesBeforeExecuting(self):
         if newField and len(fieldName) == 0:
             return self.tr('Field name is not set. Please enter a field name')
 
-    def getCustomParametersDialog(self):
+    def createCustomParametersWidget(self, parent):
         return FieldsCalculatorDialog(self)
diff --git a/python/plugins/processing/core/GeoAlgorithm.py b/python/plugins/processing/core/GeoAlgorithm.py
@@ -106,12 +106,6 @@ def defineCharacteristics(self):
     def getParametersPanel(self, parent):
         return ParametersPanel(parent, self)
 
-    def getCustomParametersDialog(self):
-        """If the algorithm has a custom parameters dialog, it should
-        be returned here, ready to be executed.
-        """
-        return None
-
     def getCustomModelerParametersDialog(self, modelAlg, algName=None):
         """If the algorithm has a custom parameters dialog when called
         from the modeler, it should be returned here, ready to be

diff --git a/python/plugins/processing/gui/ProcessingToolbox.py b/python/plugins/processing/gui/ProcessingToolbox.py
@@ -266,7 +266,7 @@ def executeAlgorithm(self):
                 return
 
             if alg.countVisibleParameters() > 0:
-                dlg = alg.getCustomParametersDialog()
+                dlg = alg.createCustomParametersWidget(self)
                 if not dlg:
                     dlg = AlgorithmDialog(alg)
                 canvas = iface.mapCanvas()

diff --git a/python/plugins/processing/gui/ScriptEditorDialog.py b/python/plugins/processing/gui/ScriptEditorDialog.py
@@ -269,7 +269,7 @@ def runAlgorithm(self):
         if self.algType == self.SCRIPT_PYTHON:
             alg = ScriptAlgorithm(None, self.editor.text())
 
-        dlg = alg.getCustomParametersDialog()
+        dlg = alg.createCustomParametersWidget(self)
         if not dlg:
             dlg = AlgorithmDialog(alg)
 

diff --git a/python/plugins/processing/gui/menus.py b/python/plugins/processing/gui/menus.py
@@ -205,7 +205,7 @@ def _executeAlgorithm(alg):
 
     context = dataobjects.createContext()
     if (alg.countVisibleParameters()) > 0:
-        dlg = alg.getCustomParametersDialog()
+        dlg = alg.createCustomParametersWidget(None)
         if not dlg:
             dlg = AlgorithmDialog(alg)
         canvas = iface.mapCanvas()

diff --git a/src/core/processing/qgsprocessingalgorithm.cpp b/src/core/processing/qgsprocessingalgorithm.cpp
@@ -71,6 +71,11 @@ QVariantMap QgsProcessingAlgorithm::run( const QVariantMap &, QgsProcessingConte
   return QVariantMap();
 }
 
+QWidget *QgsProcessingAlgorithm::createCustomParametersWidget( QWidget * ) const
+{
+  return nullptr;
+}
+
 bool QgsProcessingAlgorithm::addParameter( QgsProcessingParameterDefinition *definition )
 {
   if ( !definition )

diff --git a/src/core/processing/qgsprocessingalgorithm.h b/src/core/processing/qgsprocessingalgorithm.h
@@ -29,6 +29,7 @@
 class QgsProcessingProvider;
 class QgsProcessingContext;
 class QgsProcessingFeedback;
+class QWidget;
 
 /**
  * \class QgsProcessingAlgorithm
@@ -189,6 +190,14 @@ class CORE_EXPORT QgsProcessingAlgorithm
     virtual QVariantMap run( const QVariantMap &parameters,
                              QgsProcessingContext &context, QgsProcessingFeedback *feedback ) const;
 
+    /**
+     * If an algorithm subclass implements a custom parameters widget, a copy of this widget
+     * should be constructed and returned by this method.
+     * The base class implementation returns nullptr, which indicates that an autogenerated
+     * parameters widget should be used.
+     */
+    virtual QWidget *createCustomParametersWidget( QWidget *parent = nullptr ) const SIP_FACTORY;
+
   protected:
 
     /**