QGIS API Documentation  3.21.0-Master (909859188c)
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
6  email : [email protected]
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 }
85 
87 {
88  const QList< QgsProcessingAlgorithmConfigurationWidgetFactory * > factories = mAlgorithmConfigurationWidgetFactories;
89  for ( QgsProcessingAlgorithmConfigurationWidgetFactory *factory : factories )
91  const QMap< QString, QgsProcessingParameterWidgetFactoryInterface * > paramFactories = mParameterWidgetFactories;
92  for ( auto it = paramFactories.constBegin(); it != paramFactories.constEnd(); ++it )
93  removeParameterWidgetFactory( it.value() );
94 }
95 
97 {
98  mAlgorithmConfigurationWidgetFactories.append( factory );
99 }
100 
102 {
103  mAlgorithmConfigurationWidgetFactories.removeAll( factory );
104  delete factory;
105 }
106 
108 {
109  for ( const auto *factory : mAlgorithmConfigurationWidgetFactories )
110  {
111  if ( factory->canCreateFor( algorithm ) )
112  {
113  std::unique_ptr< QgsProcessingAlgorithmConfigurationWidget > widget( factory->create( algorithm ) );
114  if ( widget )
115  widget->setAlgorithm( algorithm );
116  return widget.release();
117  }
118  }
119 
120  return nullptr;
121 }
122 
124 {
125  if ( !factory )
126  return false;
127 
128  if ( mParameterWidgetFactories.contains( factory->parameterType() ) )
129  {
130  QgsLogger::warning( QStringLiteral( "Duplicate parameter factory for %1 registered" ).arg( factory->parameterType() ) );
131  return false;
132  }
133 
134  mParameterWidgetFactories.insert( factory->parameterType(), factory );
135  return true;
136 }
137 
139 {
140  if ( !factory )
141  return;
142 
143  mParameterWidgetFactories.remove( factory->parameterType() );
144  delete factory;
145 }
146 
148 {
149  if ( !parameter )
150  return nullptr;
151 
152  const QString parameterType = parameter->type();
153  if ( !mParameterWidgetFactories.contains( parameterType ) )
154  return nullptr;
155 
156  return mParameterWidgetFactories.value( parameterType )->createWidgetWrapper( parameter, type );
157 }
158 
160 {
161  if ( !parameter )
162  return nullptr;
163 
164  const QString parameterType = parameter->type();
165  if ( !mParameterWidgetFactories.contains( parameterType ) )
166  return nullptr;
167 
168  return mParameterWidgetFactories.value( parameterType )->createModelerWidgetWrapper( model, childId, parameter, context );
169 }
170 
172  QgsProcessingContext &context,
173  const QgsProcessingParameterWidgetContext &widgetContext,
174  const QgsProcessingParameterDefinition *definition,
176 {
177  if ( !mParameterWidgetFactories.contains( type ) )
178  return nullptr;
179 
180  return mParameterWidgetFactories.value( type )->createParameterDefinitionWidget( context, widgetContext, definition, algorithm );
181 }
182 
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