QGIS API Documentation 3.27.0-Master (c6eca784ad)
qgsprocessingguiregistry.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessingguiregistry.cpp
3 ---------------------
4 begin : April 2018
5 copyright : (C) 2018 by Matthias Kuhn
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
29#include "qgis.h"
30#include "qgslogger.h"
31
33{
34 addAlgorithmConfigurationWidgetFactory( new QgsFilterAlgorithmConfigurationWidgetFactory() );
35 addAlgorithmConfigurationWidgetFactory( new QgsConditionalBranchAlgorithmConfigurationWidgetFactory() );
36
37 addParameterWidgetFactory( new QgsProcessingBooleanWidgetWrapper() );
38 addParameterWidgetFactory( new QgsProcessingCrsWidgetWrapper() );
39 addParameterWidgetFactory( new QgsProcessingStringWidgetWrapper() );
40 addParameterWidgetFactory( new QgsProcessingNumericWidgetWrapper() );
41 addParameterWidgetFactory( new QgsProcessingDistanceWidgetWrapper() );
42 addParameterWidgetFactory( new QgsProcessingDurationWidgetWrapper() );
43 addParameterWidgetFactory( new QgsProcessingScaleWidgetWrapper() );
44 addParameterWidgetFactory( new QgsProcessingRangeWidgetWrapper() );
45 addParameterWidgetFactory( new QgsProcessingAuthConfigWidgetWrapper() );
46 addParameterWidgetFactory( new QgsProcessingMatrixWidgetWrapper() );
47 addParameterWidgetFactory( new QgsProcessingFileWidgetWrapper() );
48 addParameterWidgetFactory( new QgsProcessingExpressionWidgetWrapper() );
49 addParameterWidgetFactory( new QgsProcessingEnumWidgetWrapper() );
50 addParameterWidgetFactory( new QgsProcessingLayoutWidgetWrapper() );
51 addParameterWidgetFactory( new QgsProcessingLayoutItemWidgetWrapper() );
52 addParameterWidgetFactory( new QgsProcessingPointWidgetWrapper() );
53 addParameterWidgetFactory( new QgsProcessingGeometryWidgetWrapper() );
54 addParameterWidgetFactory( new QgsProcessingColorWidgetWrapper() );
55 addParameterWidgetFactory( new QgsProcessingCoordinateOperationWidgetWrapper() );
56 addParameterWidgetFactory( new QgsProcessingFieldWidgetWrapper() );
57 addParameterWidgetFactory( new QgsProcessingMapThemeWidgetWrapper() );
58 addParameterWidgetFactory( new QgsProcessingDateTimeWidgetWrapper() );
59 addParameterWidgetFactory( new QgsProcessingProviderConnectionWidgetWrapper() );
60 addParameterWidgetFactory( new QgsProcessingDatabaseSchemaWidgetWrapper() );
61 addParameterWidgetFactory( new QgsProcessingDatabaseTableWidgetWrapper() );
62 addParameterWidgetFactory( new QgsProcessingExtentWidgetWrapper() );
63 addParameterWidgetFactory( new QgsProcessingMapLayerWidgetWrapper() );
64 addParameterWidgetFactory( new QgsProcessingVectorLayerWidgetWrapper() );
65 addParameterWidgetFactory( new QgsProcessingFeatureSourceWidgetWrapper() );
66 addParameterWidgetFactory( new QgsProcessingRasterLayerWidgetWrapper() );
67 addParameterWidgetFactory( new QgsProcessingMeshLayerWidgetWrapper() );
68 addParameterWidgetFactory( new QgsProcessingBandWidgetWrapper() );
69 addParameterWidgetFactory( new QgsProcessingMultipleLayerWidgetWrapper() );
70 addParameterWidgetFactory( new QgsProcessingVectorTileWriterLayersWidgetWrapper() );
71 addParameterWidgetFactory( new QgsProcessingFeatureSinkWidgetWrapper() );
72 addParameterWidgetFactory( new QgsProcessingVectorDestinationWidgetWrapper() );
73 addParameterWidgetFactory( new QgsProcessingRasterDestinationWidgetWrapper() );
74 addParameterWidgetFactory( new QgsProcessingFileDestinationWidgetWrapper() );
75 addParameterWidgetFactory( new QgsProcessingFolderDestinationWidgetWrapper() );
76 addParameterWidgetFactory( new QgsProcessingFieldMapWidgetWrapper() );
77 addParameterWidgetFactory( new QgsProcessingAggregateWidgetWrapper() );
78 addParameterWidgetFactory( new QgsProcessingTinInputLayersWidgetWrapper() );
79 addParameterWidgetFactory( new QgsProcessingDxfLayersWidgetWrapper() );
80 addParameterWidgetFactory( new QgsProcessingMeshDatasetGroupsWidgetWrapper() );
81 addParameterWidgetFactory( new QgsProcessingMeshDatasetTimeWidgetWrapper() );
82 addParameterWidgetFactory( new QgsProcessingPointCloudLayerWidgetWrapper() );
83 addParameterWidgetFactory( new QgsProcessingAnnotationLayerWidgetWrapper() );
84 addParameterWidgetFactory( new QgsProcessingPointCloudDestinationWidgetWrapper() );
85}
86
88{
89 const QList< QgsProcessingAlgorithmConfigurationWidgetFactory * > factories = mAlgorithmConfigurationWidgetFactories;
90 for ( QgsProcessingAlgorithmConfigurationWidgetFactory *factory : factories )
92 const QMap< QString, QgsProcessingParameterWidgetFactoryInterface * > paramFactories = mParameterWidgetFactories;
93 for ( auto it = paramFactories.constBegin(); it != paramFactories.constEnd(); ++it )
94 removeParameterWidgetFactory( it.value() );
95}
96
98{
99 mAlgorithmConfigurationWidgetFactories.append( factory );
100}
101
103{
104 mAlgorithmConfigurationWidgetFactories.removeAll( factory );
105 delete factory;
106}
107
109{
110 for ( const auto *factory : mAlgorithmConfigurationWidgetFactories )
111 {
112 if ( factory->canCreateFor( algorithm ) )
113 {
114 std::unique_ptr< QgsProcessingAlgorithmConfigurationWidget > widget( factory->create( algorithm ) );
115 if ( widget )
116 widget->setAlgorithm( algorithm );
117 return widget.release();
118 }
119 }
120
121 return nullptr;
122}
123
125{
126 if ( !factory )
127 return false;
128
129 if ( mParameterWidgetFactories.contains( factory->parameterType() ) )
130 {
131 QgsLogger::warning( QStringLiteral( "Duplicate parameter factory for %1 registered" ).arg( factory->parameterType() ) );
132 return false;
133 }
134
135 mParameterWidgetFactories.insert( factory->parameterType(), factory );
136 return true;
137}
138
140{
141 if ( !factory )
142 return;
143
144 mParameterWidgetFactories.remove( factory->parameterType() );
145 delete factory;
146}
147
149{
150 if ( !parameter )
151 return nullptr;
152
153 const QString parameterType = parameter->type();
154 if ( !mParameterWidgetFactories.contains( parameterType ) )
155 return nullptr;
156
157 return mParameterWidgetFactories.value( parameterType )->createWidgetWrapper( parameter, type );
158}
159
161{
162 if ( !parameter )
163 return nullptr;
164
165 const QString parameterType = parameter->type();
166 if ( !mParameterWidgetFactories.contains( parameterType ) )
167 return nullptr;
168
169 return mParameterWidgetFactories.value( parameterType )->createModelerWidgetWrapper( model, childId, parameter, context );
170}
171
173 QgsProcessingContext &context,
174 const QgsProcessingParameterWidgetContext &widgetContext,
175 const QgsProcessingParameterDefinition *definition,
177{
178 if ( !mParameterWidgetFactories.contains( type ) )
179 return nullptr;
180
181 return mParameterWidgetFactories.value( type )->createParameterDefinitionWidget( context, widgetContext, definition, algorithm );
182}
183
A widget wrapper for Processing parameter value widgets.
static void warning(const QString &msg)
Goes to qWarning.
Definition: qgslogger.cpp:122
Abstract base class for widgets which allow users to specify the properties of a Processing parameter...
Interface base class for factories for algorithm configuration widgets.
A configuration widget for processing algorithms allows providing additional configuration options di...
Abstract base class for processing algorithms.
Contains information about the context in which a processing algorithm is executed.
void addAlgorithmConfigurationWidgetFactory(QgsProcessingAlgorithmConfigurationWidgetFactory *factory)
Add a new configuration widget factory for customized algorithm configuration widgets.
QgsAbstractProcessingParameterWidgetWrapper * createParameterWidgetWrapper(const QgsProcessingParameterDefinition *parameter, QgsProcessingGui::WidgetType type)
Creates a new parameter widget wrapper for the given parameter.
bool addParameterWidgetFactory(QgsProcessingParameterWidgetFactoryInterface *factory)
Adds a parameter widget factory to the registry, allowing widget creation for parameters of the match...
void removeAlgorithmConfigurationWidgetFactory(QgsProcessingAlgorithmConfigurationWidgetFactory *factory)
Remove a configuration widget factory for customized algorithm configuration widgets.
QgsProcessingAlgorithmConfigurationWidget * algorithmConfigurationWidget(const QgsProcessingAlgorithm *algorithm) const
Gets the configuration widget for an algorithm.
QgsProcessingAbstractParameterDefinitionWidget * createParameterDefinitionWidget(const QString &type, QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext, const QgsProcessingParameterDefinition *definition=nullptr, const QgsProcessingAlgorithm *algorithm=nullptr)
Creates a new parameter definition widget allowing for configuration of an instance of a specific par...
QgsProcessingModelerParameterWidget * createModelerParameterWidget(QgsProcessingModelAlgorithm *model, const QString &childId, const QgsProcessingParameterDefinition *parameter, QgsProcessingContext &context)
Creates a new modeler parameter widget for the given parameter.
void removeParameterWidgetFactory(QgsProcessingParameterWidgetFactoryInterface *factory)
Removes a parameter widget factory from the registry.
WidgetType
Types of dialogs which Processing widgets can be created for.
A widget for customising the value of Processing algorithm parameter inside a Processing model.
Base class for the definition of processing parameters.
virtual QString type() const =0
Unique parameter type name.
Contains settings which reflect the context in which a Processing parameter widget is shown,...
An interface for Processing widget wrapper factories.
virtual QString parameterType() const =0
Returns the type string for the parameter type the factory is associated with.
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