qgsprocessingparametertype.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingparametertype.h
                         ------------------------
    begin                : March 2018
    copyright            : (C) 2018 by Matthias Kuhn
    email                : [email protected]
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
 
#ifndef QGSPROCESSINGPARAMETERTYPE_H
#define QGSPROCESSINGPARAMETERTYPE_H
 
#include "qgsprocessingparameters.h"
#include "qgis.h"
#include "qgis_sip.h"
#include <QObject>
 
class CORE_EXPORT QgsProcessingParameterType
{
  public:
 
    enum ParameterFlag
    {
      ExposeToModeler = 1 
    };
    Q_DECLARE_FLAGS( ParameterFlags, ParameterFlag )
 
 
    
    virtual QgsProcessingParameterDefinition *create( const QString &name ) const = 0 SIP_FACTORY;
 
    virtual ~QgsProcessingParameterType() = default;
 
    virtual QString description() const = 0;
 
    virtual QString name() const = 0;
 
    // TODO QGIS 4.0 -- make pure virtual
 
    virtual QString pythonImportString() const { return QString(); }
 
    // TODO QGIS 4.0 -- make pure virtual
 
    virtual QString className() const
    {
      return name(); // this is wrong, but it's better than nothing for subclasses which don't implement this method
    }
 
    virtual QString id() const = 0;
 
    virtual ParameterFlags flags() const;
 
    virtual QVariantMap metadata() const;
 
    virtual QStringList acceptedPythonTypes() const;
 
    virtual QStringList acceptedStringValues() const;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsProcessingParameterType::ParameterFlags )
 
#endif // QGSPROCESSINGPARAMETERTYPE_H