QGIS API Documentation  3.21.0-Master (909859188c)
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 
26 class QLineEdit;
27 class QToolButton;
28 
30 
31 
32 class 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 };
65 
66 
67 class GUI_EXPORT QgsProcessingFieldMapParameterDefinitionWidget : public QgsProcessingAbstractParameterDefinitionWidget
68 {
69  Q_OBJECT
70  public:
71 
72  QgsProcessingFieldMapParameterDefinitionWidget( QgsProcessingContext &context,
73  const QgsProcessingParameterWidgetContext &widgetContext,
74  const QgsProcessingParameterDefinition *definition = nullptr,
75  const QgsProcessingAlgorithm *algorithm = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr );
76  QgsProcessingParameterDefinition *createParameter( const QString &name, const QString &description, QgsProcessingParameterDefinition::Flags flags ) const override;
77 
78  private:
79 
80  QComboBox *mParentLayerComboBox = nullptr;
81 
82 };
83 
84 
85 class GUI_EXPORT QgsProcessingFieldMapWidgetWrapper : public QgsAbstractProcessingParameterWidgetWrapper, public QgsProcessingParameterWidgetFactoryInterface
86 {
87  Q_OBJECT
88 
89  public:
90 
91  QgsProcessingFieldMapWidgetWrapper( const QgsProcessingParameterDefinition *parameter = nullptr,
92  QgsProcessingGui::WidgetType type = QgsProcessingGui::Standard, QWidget *parent = nullptr );
93 
94  // QgsProcessingParameterWidgetFactoryInterface
95  QString parameterType() const override;
97 
98  // QgsProcessingParameterWidgetWrapper interface
99  QWidget *createWidget() override SIP_FACTORY;
100  QgsProcessingAbstractParameterDefinitionWidget *createParameterDefinitionWidget(
101  QgsProcessingContext &context,
102  const QgsProcessingParameterWidgetContext &widgetContext,
103  const QgsProcessingParameterDefinition *definition = nullptr,
104  const QgsProcessingAlgorithm *algorithm = nullptr ) override;
105 
106  void postInitialize( const QList< QgsAbstractProcessingParameterWidgetWrapper * > &wrappers ) override;
107  int stretch() const override;
108 
109  public slots:
110  void setParentLayerWrapperValue( const QgsAbstractProcessingParameterWidgetWrapper *parentWrapper );
111 
112  protected:
113 
114  void setWidgetValue( const QVariant &value, QgsProcessingContext &context ) override;
115  QVariant widgetValue() const override;
116 
117  QStringList compatibleParameterTypes() const override;
118  QStringList compatibleOutputTypes() const override;
119  QString modelerExpressionFormatString() const override;
120  const QgsVectorLayer *linkedVectorLayer() const override;
121  private:
122 
123  QgsProcessingFieldMapPanelWidget *mPanel = nullptr;
124  std::unique_ptr< QgsVectorLayer > mParentLayer;
125 
126  friend class TestProcessingGui;
127 };
128 
129 
131 
132 #endif // QGSPROCESSINGFIELDMAPWIDGETWRAPPER_H
A widget wrapper for Processing parameter value widgets.
Abstract interface for generating an expression context.
The QgsFieldMappingModel holds mapping information for mapping from one set of QgsFields to another,...
Base class for any widget that can be shown as a 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.
WidgetType
Types of dialogs which Processing widgets can be created for.
@ Standard
Standard algorithm dialog.
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 data sets.
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
Definition: qgsgeos.h:79
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