api/3.4/qgsprocessingalgorithmconfigurationwidget_8h_source.html

 /***************************************************************************
                          qgsprocessingalgorithmconfig.h
                          --------------------------
     begin                : April 2018
     copyright            : (C) 2018 by Matthias Kuhn
     email                : [email protected]
  ***************************************************************************/

 /***************************************************************************
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
  *   (at your option) any later version.                                   *
  *                                                                         *
  ***************************************************************************/


 #ifndef QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H
 #define QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H

 #include <QWidget>
 #include <QVariantMap>

 #include "qgis_gui.h"
 #include "qgis_sip.h"

 class QgsProcessingAlgorithm;
 class QgsProcessingAlgorithmConfigurationWidget;

 class GUI_EXPORT QgsProcessingAlgorithmConfigurationWidget : public QWidget
 {
     Q_OBJECT

   public:

     QgsProcessingAlgorithmConfigurationWidget( QWidget *parent = nullptr );
     ~QgsProcessingAlgorithmConfigurationWidget() override = default;

     virtual QVariantMap configuration() const = 0;

     virtual void setConfiguration( const QVariantMap &configuration ) = 0;
 };


 class GUI_EXPORT QgsProcessingAlgorithmConfigurationWidgetFactory
 {
   public:
     virtual ~QgsProcessingAlgorithmConfigurationWidgetFactory() = default;

     virtual QgsProcessingAlgorithmConfigurationWidget *create( const QgsProcessingAlgorithm *algorithm ) const = 0 SIP_FACTORY;

     virtual bool canCreateFor( const QgsProcessingAlgorithm *algorithm ) const = 0;
 };


 #endif // QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition: qgsprocessingalgorithm.h:50

qgis_sip.h

SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:69

QgsProcessingAlgorithmConfigurationWidgetFactory
Interface base class for factories for algorithm configuration widgets.
Definition: qgsprocessingalgorithmconfigurationwidget.h:68

QgsProcessingAlgorithmConfigurationWidget
A configuration widget for processing algorithms allows providing additional configuration options di...
Definition: qgsprocessingalgorithmconfigurationwidget.h:38

algorithm
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm's parent class) implements the new pure virtual createInstance(self) call