QGIS API Documentation  3.6.0-Noosa (5873452)
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 
23 #include "qgis.h"
24 #include "qgslogger.h"
25 
27 {
28  addAlgorithmConfigurationWidgetFactory( new QgsFilterAlgorithmConfigurationWidgetFactory() );
29 
30  addParameterWidgetFactory( new QgsProcessingBooleanWidgetWrapper() );
31  addParameterWidgetFactory( new QgsProcessingCrsWidgetWrapper() );
32  addParameterWidgetFactory( new QgsProcessingStringWidgetWrapper() );
33  addParameterWidgetFactory( new QgsProcessingNumericWidgetWrapper() );
34  addParameterWidgetFactory( new QgsProcessingDistanceWidgetWrapper() );
35  addParameterWidgetFactory( new QgsProcessingRangeWidgetWrapper() );
36  addParameterWidgetFactory( new QgsProcessingAuthConfigWidgetWrapper() );
37  addParameterWidgetFactory( new QgsProcessingMatrixWidgetWrapper() );
38  addParameterWidgetFactory( new QgsProcessingFileWidgetWrapper() );
39  addParameterWidgetFactory( new QgsProcessingExpressionWidgetWrapper() );
40 }
41 
43 {
44  const QList< QgsProcessingAlgorithmConfigurationWidgetFactory * > factories = mAlgorithmConfigurationWidgetFactories;
45  for ( QgsProcessingAlgorithmConfigurationWidgetFactory *factory : factories )
47  const QMap< QString, QgsProcessingParameterWidgetFactoryInterface * > paramFactories = mParameterWidgetFactories;
48  for ( auto it = paramFactories.constBegin(); it != paramFactories.constEnd(); ++it )
49  removeParameterWidgetFactory( it.value() );
50 }
51 
53 {
54  mAlgorithmConfigurationWidgetFactories.append( factory );
55 }
56 
58 {
59  mAlgorithmConfigurationWidgetFactories.removeAll( factory );
60  delete factory;
61 }
62 
64 {
65  for ( const auto *factory : mAlgorithmConfigurationWidgetFactories )
66  {
67  if ( factory->canCreateFor( algorithm ) )
68  {
69  std::unique_ptr< QgsProcessingAlgorithmConfigurationWidget > widget( factory->create( algorithm ) );
70  if ( widget )
71  widget->setAlgorithm( algorithm );
72  return widget.release();
73  }
74  }
75 
76  return nullptr;
77 }
78 
80 {
81  if ( !factory )
82  return false;
83 
84  if ( mParameterWidgetFactories.contains( factory->parameterType() ) )
85  {
86  QgsLogger::warning( QStringLiteral( "Duplicate parameter factory for %1 registered" ).arg( factory->parameterType() ) );
87  return false;
88  }
89 
90  mParameterWidgetFactories.insert( factory->parameterType(), factory );
91  return true;
92 }
93 
95 {
96  if ( !factory )
97  return;
98 
99  mParameterWidgetFactories.remove( factory->parameterType() );
100  delete factory;
101 }
102 
104 {
105  if ( !parameter )
106  return nullptr;
107 
108  const QString parameterType = parameter->type();
109  if ( !mParameterWidgetFactories.contains( parameterType ) )
110  return nullptr;
111 
112  return mParameterWidgetFactories.value( parameterType )->createWidgetWrapper( parameter, type );
113 }
114 
116 {
117  if ( !parameter )
118  return nullptr;
119 
120  const QString parameterType = parameter->type();
121  if ( !mParameterWidgetFactories.contains( parameterType ) )
122  return nullptr;
123 
124  return mParameterWidgetFactories.value( parameterType )->createModelerWidgetWrapper( model, childId, parameter, context );
125 }
126 
A widget wrapper for Processing parameter value widgets.
WidgetType
Types of dialogs which Processing widgets can be created for.
static void warning(const QString &msg)
Goes to qWarning.
Definition: qgslogger.cpp:121
QgsProcessingModelerParameterWidget * createModelerParameterWidget(QgsProcessingModelAlgorithm *model, const QString &childId, const QgsProcessingParameterDefinition *parameter, QgsProcessingContext &context)
Creates a new modeler parameter widget for the given parameter.
An interface for Processing widget wrapper factories.
A widget for customising the value of Processing algorithm parameter inside a Processing model...
Abstract base class for processing algorithms.
virtual QString type() const =0
Unique parameter type name.
QgsAbstractProcessingParameterWidgetWrapper * createParameterWidgetWrapper(const QgsProcessingParameterDefinition *parameter, QgsProcessingGui::WidgetType type)
Creates a new parameter widget wrapper for the given parameter.
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
QgsProcessingAlgorithmConfigurationWidget * algorithmConfigurationWidget(const QgsProcessingAlgorithm *algorithm) const
Gets the configuration widget for an algorithm.
void setAlgorithm(const QgsProcessingAlgorithm *algorithm)
Sets the algorithm instance associated with the widget.
void addAlgorithmConfigurationWidgetFactory(QgsProcessingAlgorithmConfigurationWidgetFactory *factory)
Add a new configuration widget factory for customized algorithm configuration widgets.
virtual QString parameterType() const =0
Returns the type string for the parameter type the factory is associated with.
Interface base class for factories for algorithm configuration widgets.
A configuration widget for processing algorithms allows providing additional configuration options di...
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.
Base class for the definition of processing parameters.
void removeParameterWidgetFactory(QgsProcessingParameterWidgetFactoryInterface *factory)
Removes a parameter widget factory from the registry.
Contains information about the context in which a processing algorithm is executed.