qgsprocessingalgorithmconfigurationwidget.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingalgorithmconfig.h
                         --------------------------
    begin                : April 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 QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H
#define QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H

#include <QWidget>
#include <QVariantMap>

#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsprocessingwidgetwrapper.h"

class QgsProcessingAlgorithm;
class QgsProcessingAlgorithmConfigurationWidget;


class GUI_EXPORT QgsProcessingAlgorithmConfigurationWidget : public QWidget, public QgsExpressionContextGenerator
{
    Q_OBJECT

  public:

    QgsProcessingAlgorithmConfigurationWidget( QWidget *parent = nullptr );
    ~QgsProcessingAlgorithmConfigurationWidget() override = default;

    virtual QVariantMap configuration() const = 0;

    virtual void setConfiguration( const QVariantMap &configuration ) = 0;

    virtual void setWidgetContext( const QgsProcessingParameterWidgetContext &context );

    const QgsProcessingParameterWidgetContext &widgetContext() const;

    void setAlgorithm( const QgsProcessingAlgorithm *algorithm );

    const QgsProcessingAlgorithm *algorithm() const { return mAlgorithm; }

    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );

    QgsExpressionContext createExpressionContext() const override;

  private:

    QgsProcessingContextGenerator *mContextGenerator = nullptr;
    const QgsProcessingAlgorithm *mAlgorithm = nullptr;
    QgsProcessingParameterWidgetContext mWidgetContext;
};


class GUI_EXPORT QgsProcessingAlgorithmConfigurationWidgetFactory
{
  public:
    virtual ~QgsProcessingAlgorithmConfigurationWidgetFactory() = default;

    virtual QgsProcessingAlgorithmConfigurationWidget *create( const QgsProcessingAlgorithm *algorithm ) const = 0 SIP_FACTORY;

    virtual bool canCreateFor( const QgsProcessingAlgorithm *algorithm ) const = 0;
};


#endif // QGSPROCESSINGALGORITHMCONFIGURATIONWIDGET_H