QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | List of all members
QgsProcessingAlgorithmConfigurationWidget Class Referenceabstract

A configuration widget for processing algorithms allows providing additional configuration options directly on algorithm level, in addition to parameters. More...

#include <qgsprocessingalgorithmconfigurationwidget.h>

Inheritance diagram for QgsProcessingAlgorithmConfigurationWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingAlgorithmConfigurationWidget (QWidget *parent=nullptr)
 Creates a new QgsProcessingAlgorithmConfigurationWidget. More...
 
 ~QgsProcessingAlgorithmConfigurationWidget () override=default
 
virtual QVariantMap configuration () const =0
 Read the current configuration from this widget. More...
 
virtual void setConfiguration (const QVariantMap &configuration)=0
 Set the configuration which this widget should represent. More...
 

Detailed Description

A configuration widget for processing algorithms allows providing additional configuration options directly on algorithm level, in addition to parameters.

Since
QGIS 3.2

Definition at line 38 of file qgsprocessingalgorithmconfigurationwidget.h.

Constructor & Destructor Documentation

◆ QgsProcessingAlgorithmConfigurationWidget()

QgsProcessingAlgorithmConfigurationWidget::QgsProcessingAlgorithmConfigurationWidget ( QWidget *  parent = nullptr)

◆ ~QgsProcessingAlgorithmConfigurationWidget()

QgsProcessingAlgorithmConfigurationWidget::~QgsProcessingAlgorithmConfigurationWidget ( )
overridedefault

Member Function Documentation

◆ configuration()

virtual QVariantMap QgsProcessingAlgorithmConfigurationWidget::configuration ( ) const
pure virtual

Read the current configuration from this widget.

◆ setConfiguration()

virtual void QgsProcessingAlgorithmConfigurationWidget::setConfiguration ( const QVariantMap &  configuration)
pure virtual

Set the configuration which this widget should represent.


The documentation for this class was generated from the following files: