QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
Go to the documentation of this file.
18 #ifndef QGSPROCESSINGWIDGETWRAPPER_H
19 #define QGSPROCESSINGWIDGETWRAPPER_H
33 class QgsProcessingModelAlgorithm;
37 class QgsProcessingModelAlgorithm;
171 QgsProcessingModelAlgorithm *model()
const;
179 void setModel( QgsProcessingModelAlgorithm *model );
187 QString modelChildAlgorithmId()
const;
195 void setModelChildAlgorithmId(
const QString &
id );
215 QgsProcessingModelAlgorithm *mModel =
nullptr;
217 QString mModelChildAlgorithmId;
232 class GUI_EXPORT QgsProcessingGuiUtils
334 QWidget *wrappedWidget();
340 QLabel *wrappedLabel();
349 % Property( name = param, get = parameterDefinition )
367 QVariant parameterValue()
const;
372 virtual QVariantMap customProperties()
const;
393 virtual void postInitialize(
const QList< QgsAbstractProcessingParameterWidgetWrapper * > &wrappers );
402 virtual int stretch()
const;
411 virtual void setDialog( QDialog *dialog );
461 virtual QVariant widgetValue() const = 0;
491 QPointer< QWidget > mWidget;
493 QPointer< QLabel > mLabel;
496 friend class TestProcessingGui;
552 const QString &childId,
602 virtual QStringList compatibleParameterTypes() const = 0;
618 virtual QStringList compatibleOutputTypes() const = 0;
645 virtual QString modelerExpressionFormatString() const;
674 QVariant widgetValue()
const override;
684 QWidget *createWidget()
override;
685 QLabel *createLabel()
override;
690 QPointer < const QgsVectorLayer > mLayer;
694 #endif // QGSPROCESSINGWIDGETWRAPPER_H
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Contains settings which reflect the context in which a Processing parameter widget is shown,...
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
Map canvas is a class for displaying all GIS data types on a canvas.
Base class for the definition of processing parameters.
virtual QVariantMap createProcessingParameters()=0
This method needs to be reimplemented in all classes which implement this interface and return a algo...
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
@ Standard
Standard algorithm dialog.
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
Contains information about the context in which a processing algorithm is executed.
A bar for displaying non-blocking messages to the user.
QgsProcessingParameterWidgetContext()=default
Constructor for QgsProcessingParameterWidgetContext.
virtual QgsExpressionContext createExpressionContext() const =0
This method needs to be reimplemented in all classes which implement this interface and return an exp...
An interface for objects which can create sets of parameter values for processing algorithms.
WidgetType
Types of dialogs which Processing widgets can be created for.
Abstract base class for processing algorithms.
Contains general functions and values related to Processing GUI components.
virtual ~QgsProcessingContextGenerator()=default
Represents a vector layer which manages a vector based data sets.
Base class for all map layer types.
virtual QgsProcessingContext * processingContext()=0
This method needs to be reimplemented in all classes which implement this interface and return a Proc...
Abstract interface for generating an expression context.
A model for showing available data sources and other items in a structured tree.
An interface for objects which can create Processing contexts.
virtual ~QgsProcessingParametersGenerator()=default