QGIS API Documentation  3.4.15-Madeira (e83d02e274)
qgsprocessingparametertype.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsprocessingparametertype.h
3  ------------------------
4  begin : March 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 
18 
19 #ifndef QGSPROCESSINGPARAMETERTYPE_H
20 #define QGSPROCESSINGPARAMETERTYPE_H
21 
23 #include "qgis.h"
24 #include "qgis_sip.h"
25 #include <QObject>
26 
33 class CORE_EXPORT QgsProcessingParameterType
34 {
35  public:
36 
42  {
43  ExposeToModeler = 1
44  };
45  Q_DECLARE_FLAGS( ParameterFlags, ParameterFlag )
46 
47 
48 
51  virtual QgsProcessingParameterDefinition *create( const QString &name ) const = 0 SIP_FACTORY;
52 
56  virtual ~QgsProcessingParameterType() = default;
57 
63  virtual QString description() const = 0;
64 
69  virtual QString name() const = 0;
70 
74  virtual QString id() const = 0;
75 
80  virtual ParameterFlags flags() const;
81 
86  virtual QVariantMap metadata() const;
87 
96  virtual QStringList acceptedPythonTypes() const;
97 };
98 
99 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsProcessingParameterType::ParameterFlags )
100 
101 #endif // QGSPROCESSINGPARAMETERTYPE_H
ParameterFlag
Each parameter type can offer a number of additional flags to finetune its behavior and capabilities...
#define SIP_FACTORY
Definition: qgis_sip.h:69
Makes metadata of processing parameters available.
Base class for the definition of processing parameters.