qgsprocessingparameterswidget.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprocessingparameterswidget.h
                             ----------------------------------
    Date                 : March 2020
    Copyright            : (C) 2020 Nyall Dawson
    Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSPROCESSINGPARAMETERSWIDGET_H
#define QGSPROCESSINGPARAMETERSWIDGET_H
 
#include "ui_qgsprocessingparameterswidgetbase.h"
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsprocessingcontext.h"
#include "qgsprocessingwidgetwrapper.h"
 
#include <QPointer>
#include <QWidget>
 
class QgsProcessingAlgorithm;
class QgsProcessingParameterDefinition;


class GUI_EXPORT QgsProcessingParametersWidget : public QgsPanelWidget, public QgsProcessingParametersGenerator, public QgsProcessingContextGenerator, private Ui::QgsProcessingParametersWidgetBase
{
    Q_OBJECT
 
  public:
    QgsProcessingParametersWidget( const QgsProcessingAlgorithm *algorithm, bool inPlace, QgsMapLayer *activeLayer, QgsMessageBar *messageBar, QWidget *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsProcessingParametersWidget() override;

    void initWidgets();
 
    const QgsProcessingAlgorithm *algorithm() const;
    QgsProcessingContext *processingContext() const override;
    QVariantMap createProcessingParameters( QgsProcessingParametersGenerator::Flags flags = QgsProcessingParametersGenerator::Flags() ) override;

    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );

    QList< QgsProcessingParametersGenerator::ParameterValidationResult > validate() const;

    QVariantMap createAndValidateParameters( QgsProcessingParametersGenerator::Flags flags, QList< QgsProcessingParametersGenerator::ParameterValidationResult > &validationResults SIP_OUT ) const;

    void setParameters( const QVariantMap &parameters );

    QgsAbstractProcessingParameterWidgetWrapper *wrapper( const QString &name ) const;

    QList< QgsAbstractProcessingParameterWidgetWrapper * > wrappers() const;
 
  protected:
    void addParameterWidget( const QgsProcessingParameterDefinition *parameter, QWidget *widget SIP_TRANSFER, int stretch = 0 );
    void addParameterLabel( const QgsProcessingParameterDefinition *parameter, QWidget *label SIP_TRANSFER );
 
    void addOutputLabel( QWidget *label SIP_TRANSFER );
    void addOutputWidget( QWidget *widget SIP_TRANSFER, int stretch = 0 );
 
    void addExtraWidget( QWidget *widget SIP_TRANSFER );
 
  private slots:
 
    void parameterChanged();
 
  private:
    QgsProcessingContextGenerator *mContextGenerator = nullptr;
 
    const QgsProcessingAlgorithm *mAlgorithm = nullptr;
    bool mInPlace = false;
    QPointer< QgsMapLayer > mActiveLayer;
    QgsMessageBar *mMessageBar = nullptr;
 
    QVariantMap mExtraParameters;
 
    QMap< QString, QgsAbstractProcessingParameterWidgetWrapper * > mWrappers;
 
    friend class TestProcessingGui;
};

 
#endif // QGSPROCESSINGPARAMETERSWIDGET_H