QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
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
31#include "qgis.h"
32#include "qgslogger.h"
33
35{
36 addAlgorithmConfigurationWidgetFactory( new QgsFilterAlgorithmConfigurationWidgetFactory() );
37 addAlgorithmConfigurationWidgetFactory( new QgsConditionalBranchAlgorithmConfigurationWidgetFactory() );
38
39 addParameterWidgetFactory( new QgsProcessingAlignRasterLayersWidgetWrapper() );
40 addParameterWidgetFactory( new QgsProcessingBooleanWidgetWrapper() );
41 addParameterWidgetFactory( new QgsProcessingCrsWidgetWrapper() );
42 addParameterWidgetFactory( new QgsProcessingStringWidgetWrapper() );
43 addParameterWidgetFactory( new QgsProcessingNumericWidgetWrapper() );
44 addParameterWidgetFactory( new QgsProcessingDistanceWidgetWrapper() );
45 addParameterWidgetFactory( new QgsProcessingAreaWidgetWrapper() );
46 addParameterWidgetFactory( new QgsProcessingVolumeWidgetWrapper() );
47 addParameterWidgetFactory( new QgsProcessingDurationWidgetWrapper() );
48 addParameterWidgetFactory( new QgsProcessingScaleWidgetWrapper() );
49 addParameterWidgetFactory( new QgsProcessingRangeWidgetWrapper() );
50 addParameterWidgetFactory( new QgsProcessingAuthConfigWidgetWrapper() );
51 addParameterWidgetFactory( new QgsProcessingMatrixWidgetWrapper() );
52 addParameterWidgetFactory( new QgsProcessingFileWidgetWrapper() );
53 addParameterWidgetFactory( new QgsProcessingExpressionWidgetWrapper() );
54 addParameterWidgetFactory( new QgsProcessingEnumWidgetWrapper() );
55 addParameterWidgetFactory( new QgsProcessingLayoutWidgetWrapper() );
56 addParameterWidgetFactory( new QgsProcessingLayoutItemWidgetWrapper() );
57 addParameterWidgetFactory( new QgsProcessingPointWidgetWrapper() );
58 addParameterWidgetFactory( new QgsProcessingGeometryWidgetWrapper() );
59 addParameterWidgetFactory( new QgsProcessingColorWidgetWrapper() );
60 addParameterWidgetFactory( new QgsProcessingCoordinateOperationWidgetWrapper() );
61 addParameterWidgetFactory( new QgsProcessingFieldWidgetWrapper() );
62 addParameterWidgetFactory( new QgsProcessingMapThemeWidgetWrapper() );
63 addParameterWidgetFactory( new QgsProcessingDateTimeWidgetWrapper() );
64 addParameterWidgetFactory( new QgsProcessingProviderConnectionWidgetWrapper() );
65 addParameterWidgetFactory( new QgsProcessingDatabaseSchemaWidgetWrapper() );
66 addParameterWidgetFactory( new QgsProcessingDatabaseTableWidgetWrapper() );
67 addParameterWidgetFactory( new QgsProcessingExtentWidgetWrapper() );
68 addParameterWidgetFactory( new QgsProcessingMapLayerWidgetWrapper() );
69 addParameterWidgetFactory( new QgsProcessingVectorLayerWidgetWrapper() );
70 addParameterWidgetFactory( new QgsProcessingFeatureSourceWidgetWrapper() );
71 addParameterWidgetFactory( new QgsProcessingRasterLayerWidgetWrapper() );
72 addParameterWidgetFactory( new QgsProcessingMeshLayerWidgetWrapper() );
73 addParameterWidgetFactory( new QgsProcessingBandWidgetWrapper() );
74 addParameterWidgetFactory( new QgsProcessingMultipleLayerWidgetWrapper() );
75 addParameterWidgetFactory( new QgsProcessingVectorTileWriterLayersWidgetWrapper() );
76 addParameterWidgetFactory( new QgsProcessingFeatureSinkWidgetWrapper() );
77 addParameterWidgetFactory( new QgsProcessingVectorDestinationWidgetWrapper() );
78 addParameterWidgetFactory( new QgsProcessingRasterDestinationWidgetWrapper() );
79 addParameterWidgetFactory( new QgsProcessingFileDestinationWidgetWrapper() );
80 addParameterWidgetFactory( new QgsProcessingFolderDestinationWidgetWrapper() );
81 addParameterWidgetFactory( new QgsProcessingFieldMapWidgetWrapper() );
82 addParameterWidgetFactory( new QgsProcessingAggregateWidgetWrapper() );
83 addParameterWidgetFactory( new QgsProcessingTinInputLayersWidgetWrapper() );
84 addParameterWidgetFactory( new QgsProcessingDxfLayersWidgetWrapper() );
85 addParameterWidgetFactory( new QgsProcessingMeshDatasetGroupsWidgetWrapper() );
86 addParameterWidgetFactory( new QgsProcessingMeshDatasetTimeWidgetWrapper() );
87 addParameterWidgetFactory( new QgsProcessingPointCloudLayerWidgetWrapper() );
88 addParameterWidgetFactory( new QgsProcessingAnnotationLayerWidgetWrapper() );
89 addParameterWidgetFactory( new QgsProcessingPointCloudDestinationWidgetWrapper() );
90 addParameterWidgetFactory( new QgsProcessingPointCloudAttributeWidgetWrapper() );
91 addParameterWidgetFactory( new QgsProcessingVectorTileDestinationWidgetWrapper() );
92 addParameterWidgetFactory( new QgsProcessingRasterOptionsWidgetWrapper() );
93}
94
96{
97 const QList< QgsProcessingAlgorithmConfigurationWidgetFactory * > factories = mAlgorithmConfigurationWidgetFactories;
98 for ( QgsProcessingAlgorithmConfigurationWidgetFactory *factory : factories )
100 const QMap< QString, QgsProcessingParameterWidgetFactoryInterface * > paramFactories = mParameterWidgetFactories;
101 for ( auto it = paramFactories.constBegin(); it != paramFactories.constEnd(); ++it )
102 removeParameterWidgetFactory( it.value() );
103}
104
106{
107 mAlgorithmConfigurationWidgetFactories.append( factory );
108}
109
111{
112 mAlgorithmConfigurationWidgetFactories.removeAll( factory );
113 delete factory;
114}
115
117{
118 for ( const auto *factory : mAlgorithmConfigurationWidgetFactories )
119 {
120 if ( factory->canCreateFor( algorithm ) )
121 {
122 std::unique_ptr< QgsProcessingAlgorithmConfigurationWidget > widget( factory->create( algorithm ) );
123 if ( widget )
124 widget->setAlgorithm( algorithm );
125 return widget.release();
126 }
127 }
128
129 return nullptr;
130}
131
133{
134 if ( !factory )
135 return false;
136
137 if ( mParameterWidgetFactories.contains( factory->parameterType() ) )
138 {
139 QgsLogger::warning( QStringLiteral( "Duplicate parameter factory for %1 registered" ).arg( factory->parameterType() ) );
140 return false;
141 }
142
143 mParameterWidgetFactories.insert( factory->parameterType(), factory );
144 return true;
145}
146
148{
149 if ( !factory )
150 return;
151
152 mParameterWidgetFactories.remove( factory->parameterType() );
153 delete factory;
154}
155
157{
158 if ( !parameter )
159 return nullptr;
160
161 const QVariantMap metadata = parameter->metadata();
162 const QString widgetType = metadata.value( QStringLiteral( "widget_wrapper" ) ).toMap().value( QStringLiteral( "widget_type" ) ).toString();
163 const QString parameterType = !widgetType.isEmpty() ? widgetType : parameter->type();
164 if ( !mParameterWidgetFactories.contains( parameterType ) )
165 return nullptr;
166
167 return mParameterWidgetFactories.value( parameterType )->createWidgetWrapper( parameter, type );
168}
169
171{
172 if ( !parameter )
173 return nullptr;
174
175 const QString parameterType = parameter->type();
176 if ( !mParameterWidgetFactories.contains( parameterType ) )
177 return nullptr;
178
179 return mParameterWidgetFactories.value( parameterType )->createModelerWidgetWrapper( model, childId, parameter, context );
180}
181
183 QgsProcessingContext &context,
184 const QgsProcessingParameterWidgetContext &widgetContext,
185 const QgsProcessingParameterDefinition *definition,
187{
188 if ( !mParameterWidgetFactories.contains( type ) )
189 return nullptr;
190
191 return mParameterWidgetFactories.value( type )->createParameterDefinitionWidget( context, widgetContext, definition, algorithm );
192}
193
A widget wrapper for Processing parameter value widgets.
static void warning(const QString &msg)
Goes to qWarning.
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.
QVariantMap metadata() const
Returns the parameter's freeform metadata.
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