QGIS API Documentation 3.43.0-Master (6c62b930b02)
qgsprocessingfieldmapwidgetwrapper.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessingfieldmapwidgetwrapper.h
3 ---------------------
4 Date : June 2020
5 Copyright : (C) 2020 by Nyall Dawson
6 Email : nyall dot dawson at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSPROCESSINGFIELDMAPWIDGETWRAPPER_H
17#define QGSPROCESSINGFIELDMAPWIDGETWRAPPER_H
18
19#define SIP_NO_FILE
20
23
24#include "ui_qgsprocessingfieldsmappingpanelbase.h"
25
26class QLineEdit;
27class QToolButton;
28
30
31
32class GUI_EXPORT QgsProcessingFieldMapPanelWidget : public QgsPanelWidget, private Ui::QgsProcessingFieldMapPanelBase
33{
34 Q_OBJECT
35
36 public:
37 QgsProcessingFieldMapPanelWidget( QWidget *parent = nullptr );
38
39 void setLayer( QgsVectorLayer *layer );
40 QgsVectorLayer *layer();
41 QVariant value() const;
42 void setValue( const QVariant &value );
43
48 void registerExpressionContextGenerator( const QgsExpressionContextGenerator *generator );
49
50 signals:
51
52 void changed();
53
54 private slots:
55 void loadFieldsFromLayer();
56 void addField();
57 void loadLayerFields();
58
59 private:
60 QgsFieldMappingModel *mModel = nullptr;
61
62 QgsVectorLayer *mLayer = nullptr;
63 bool mBlockChangedSignal = false;
64 friend class TestProcessingGui;
65};
66
67
68class GUI_EXPORT QgsProcessingFieldMapParameterDefinitionWidget : public QgsProcessingAbstractParameterDefinitionWidget
69{
70 Q_OBJECT
71 public:
72 QgsProcessingFieldMapParameterDefinitionWidget( QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext, const QgsProcessingParameterDefinition *definition = nullptr, const QgsProcessingAlgorithm *algorithm = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr );
73 QgsProcessingParameterDefinition *createParameter( const QString &name, const QString &description, Qgis::ProcessingParameterFlags flags ) const override;
74
75 private:
76 QComboBox *mParentLayerComboBox = nullptr;
77};
78
79
80class GUI_EXPORT QgsProcessingFieldMapWidgetWrapper : public QgsAbstractProcessingParameterWidgetWrapper, public QgsProcessingParameterWidgetFactoryInterface
81{
82 Q_OBJECT
83
84 public:
85 QgsProcessingFieldMapWidgetWrapper( const QgsProcessingParameterDefinition *parameter = nullptr, Qgis::ProcessingMode type = Qgis::ProcessingMode::Standard, QWidget *parent = nullptr );
86
87 // QgsProcessingParameterWidgetFactoryInterface
88 QString parameterType() const override;
90
91 // QgsProcessingParameterWidgetWrapper interface
92 QWidget *createWidget() override SIP_FACTORY;
93 QgsProcessingAbstractParameterDefinitionWidget *createParameterDefinitionWidget(
94 QgsProcessingContext &context,
95 const QgsProcessingParameterWidgetContext &widgetContext,
96 const QgsProcessingParameterDefinition *definition = nullptr,
97 const QgsProcessingAlgorithm *algorithm = nullptr
98 ) override;
99
100 void postInitialize( const QList<QgsAbstractProcessingParameterWidgetWrapper *> &wrappers ) override;
101 int stretch() const override;
102
103 public slots:
104 void setParentLayerWrapperValue( const QgsAbstractProcessingParameterWidgetWrapper *parentWrapper );
105
106 protected:
107 void setWidgetValue( const QVariant &value, QgsProcessingContext &context ) override;
108 QVariant widgetValue() const override;
109
110 QString modelerExpressionFormatString() const override;
111 const QgsVectorLayer *linkedVectorLayer() const override;
112
113 private:
114 QgsProcessingFieldMapPanelWidget *mPanel = nullptr;
115 std::unique_ptr<QgsVectorLayer> mParentLayer;
116
117 friend class TestProcessingGui;
118};
119
120
122
123#endif // QGSPROCESSINGFIELDMAPWIDGETWRAPPER_H
ProcessingMode
Types of modes which Processing widgets can be created for.
Definition qgis.h:3553
@ Standard
Standard (single-run) algorithm mode.
QFlags< ProcessingParameterFlag > ProcessingParameterFlags
Flags which dictate the behavior of Processing parameters.
Definition qgis.h:3659
A widget wrapper for Processing parameter value widgets.
Abstract interface for generating an expression context.
Holds mapping information for mapping from one set of QgsFields to another.
Base class for any widget that can be shown as an inline panel.
Abstract base class for widgets which allow users to specify the properties of a Processing parameter...
Abstract base class for processing algorithms.
Contains information about the context in which a processing algorithm is executed.
Base class for the definition of processing parameters.
Contains settings which reflect the context in which a Processing parameter widget is shown.
An interface for Processing widget wrapper factories.
Represents a vector layer which manages a vector based dataset.
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
#define SIP_TRANSFERTHIS
Definition qgis_sip.h:53
#define SIP_FACTORY
Definition qgis_sip.h:76