code layout, loop improvements, dox, const correction

qgis · Dec 5, 2019 · a3a7b5f · a3a7b5f
1 parent a4fda0a
commit a3a7b5f
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 12 deletions.
diff --git a/python/core/auto_generated/classification/qgsclassificationmethod.sip.in b/python/core/auto_generated/classification/qgsclassificationmethod.sip.in
@@ -297,7 +297,7 @@ Get parameter from its id
 .. versionadded:: 3.12
 %End
 
-    const QgsProcessingParameterDefinitions parameterDefinitions() const;
+    QgsProcessingParameterDefinitions parameterDefinitions() const;
 %Docstring
 List of parameters
 
@@ -328,9 +328,15 @@ Copy the parameters (shall be used in clone implementation)
 Format the number according to label properties
 %End
 
-    void addParameter( QgsProcessingParameterDefinition *definition );
+    void addParameter( QgsProcessingParameterDefinition *definition /Transfer/ );
 %Docstring
-Add parameter
+Add a parameter to the method.
+The paramaeter is a processing parameter which will allow its configuration in the GUI.
+
+.. note::
+
+   Only parameters having their widget implementation in C++ are supported. i.e. pure
+   Python parameters are not supported.
 
 .. versionadded:: 3.12
 %End

diff --git a/src/core/classification/qgsclassificationequalinterval.h b/src/core/classification/qgsclassificationequalinterval.h
@@ -35,7 +35,7 @@ class CORE_EXPORT QgsClassificationEqualInterval : public QgsClassificationMetho
     QgsClassificationMethod *clone() const override;
     QIcon icon() const override;
 
-    bool valuesRequired() const override {return false;}
+    bool valuesRequired() const override { return false; }
 
     static const QString METHOD_ID;
 

diff --git a/src/core/classification/qgsclassificationlogarithmic.cpp b/src/core/classification/qgsclassificationlogarithmic.cpp
@@ -22,7 +22,7 @@
 QgsClassificationLogarithmic::QgsClassificationLogarithmic()
   : QgsClassificationMethod( NoFlag, 0 )
 {
-  QgsProcessingParameterBoolean *param = new QgsProcessingParameterBoolean( QStringLiteral( "FILTER_ZERO_NEG_VALUES" ), QObject::tr( "Filter values <= 0" ), false );
+  QgsProcessingParameterBoolean *param = new QgsProcessingParameterBoolean( QStringLiteral( "FILTER_ZERO_NEG_VALUES" ), QObject::tr( "Filter values ≤ 0" ), false );
   addParameter( param );
 }
 

diff --git a/src/core/classification/qgsclassificationmethod.cpp b/src/core/classification/qgsclassificationmethod.cpp
@@ -188,11 +188,11 @@ const QgsProcessingParameterDefinition *QgsClassificationMethod::parameterDefini
 void QgsClassificationMethod::setParameterValues( const QVariantMap &values )
 {
   mParameterValues = values;
-  for ( const QString &paramName : mParameterValues.keys() ) // todo is this ok?
+  for ( auto it = mParameterValues.begin(); it != mParameterValues.end(); ++it  )
   {
-    if ( !parameterDefinition( paramName ) )
+    if ( !parameterDefinition( it.key() ) )
     {
-      QgsMessageLog::logMessage( name(), QObject::tr( "Parameter %1 does not exist in the method" ).arg( paramName ) );
+      QgsMessageLog::logMessage( name(), QObject::tr( "Parameter %1 does not exist in the method" ).arg( it.key() ) );
     }
   }
 }

diff --git a/src/core/classification/qgsclassificationmethod.h b/src/core/classification/qgsclassificationmethod.h
@@ -281,7 +281,7 @@ class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
      * List of parameters
      * \since QGIS 3.12
      */
-    const QgsProcessingParameterDefinitions parameterDefinitions() const {return mParameters;}
+    QgsProcessingParameterDefinitions parameterDefinitions() const {return mParameters;}
 
     /**
      * Set values of the additional parameters
@@ -303,10 +303,13 @@ class CORE_EXPORT QgsClassificationMethod SIP_ABSTRACT
     QString formatNumber( double value ) const;
 
     /**
-     * Add parameter
+     * Add a parameter to the method.
+     * The paramaeter is a processing parameter which will allow its configuration in the GUI.
+     * \note Only parameters having their widget implementation in C++ are supported. i.e. pure
+     * Python parameters are not supported.
      * \since QGIS 3.12
      */
-    void addParameter( QgsProcessingParameterDefinition *definition );
+    void addParameter( QgsProcessingParameterDefinition *definition SIP_TRANSFER );
 
     /**
      * Get the parameter value

diff --git a/src/gui/symbology/qgsgraduatedsymbolrendererwidget.cpp b/src/gui/symbology/qgsgraduatedsymbolrendererwidget.cpp
@@ -832,7 +832,7 @@ void QgsGraduatedSymbolRendererWidget::updateMethodParameters()
   // todo need more?
   QgsProcessingContext context;
 
-  for ( const auto *def : method->parameterDefinitions() )
+  for ( const QgsProcessingParameterDefinition *def : method->parameterDefinitions() )
   {
     QgsAbstractProcessingParameterWidgetWrapper *ppww = QgsGui::processingGuiRegistry()->createParameterWidgetWrapper( def, QgsProcessingGui::Standard );
     mParametersLayout->addRow( ppww->createWrappedLabel(), ppww->createWrappedWidget( context ) );