qgsprocessingmodelerparameterwidget.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingmodelerparameterwidget.h
                         -------------------------------------
    begin                : August 2018
    copyright            : (C) 2018 by 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 QGSPROCESSINGMODELERPARAMETERWIDGET_H
#define QGSPROCESSINGMODELERPARAMETERWIDGET_H
 
#include <QWidget>
#include "qgis_gui.h"
#include "qgis_sip.h"
#include <QPointer>
#include "qgsprocessingcontext.h"
#include "qgsprocessingmodelchildparametersource.h"
 
class QgsProcessingParameterDefinition;
class QgsAbstractProcessingParameterWidgetWrapper;
class QgsExpressionLineEdit;
class QgsProcessingModelAlgorithm;
class QgsProcessingParameterWidgetContext;
class QgsProcessingContextGenerator;
class QgsFilterLineEdit;
 
class QLabel;
class QToolButton;
class QMenu;
class QStackedWidget;
class QComboBox;
 
class GUI_EXPORT QgsProcessingModelerParameterWidget : public QWidget, public QgsExpressionContextGenerator
{
    Q_OBJECT
 
  public:
 
    QgsProcessingModelerParameterWidget( QgsProcessingModelAlgorithm *model,
                                         const QString &childId,
                                         const QgsProcessingParameterDefinition *parameter,
                                         QgsProcessingContext &context,
                                         QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsProcessingModelerParameterWidget() override;
 
    void setWidgetContext( const QgsProcessingParameterWidgetContext &context );
 
    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
 
    void populateSources( const QStringList &compatibleParameterTypes,
                          const QStringList &compatibleOutputTypes,
                          const QList< int > &compatibleDataTypes );
 
    void setExpressionHelpText( const QString &text );
 
    const QgsProcessingParameterDefinition *parameterDefinition() const;
 
    QLabel *createLabel() SIP_FACTORY;
 
    virtual void setWidgetValue( const QgsProcessingModelChildParameterSource &value );
 
    void setWidgetValue( const QList< QgsProcessingModelChildParameterSource > &values );
 
    void setToModelOutput( const QString &value );
 
    bool isModelOutput() const;
 
    QString modelOutputName() const;
 
    virtual QVariant value() const;
 
    void setDialog( QDialog *dialog );
 
    QgsExpressionContext createExpressionContext() const override;
 
    void setSourceType( Qgis::ProcessingModelChildParameterSource type );
 
  private slots:
 
    void sourceMenuAboutToShow();
    void sourceMenuActionTriggered( QAction *action );
 
  private:
 
    // IMPORTANT - must match order of widgets in the stacked widget!
    enum SourceType
    {
      StaticValue = 0,
      Expression = 1,
      ModelParameter = 2,
      ChildOutput = 3,
      ModelOutput = 4,
    };
 
    SourceType currentSourceType() const;
 
    void updateUi();
 
    QgsProcessingModelAlgorithm *mModel = nullptr;
    const QString mChildId;
    const QgsProcessingParameterDefinition *mParameterDefinition = nullptr;
    QgsProcessingContext &mContext;
 
    QVariant mStaticValue;
    QString mModelInputParameterName;
    QString mOutputChildId;
    QString mOutputName;
    QString mExpression;
 
    QToolButton *mSourceButton = nullptr;
    QMenu *mSourceMenu = nullptr;
    QStackedWidget *mStackedWidget = nullptr;
 
    bool mHasStaticWrapper = false;
    std::unique_ptr< QgsAbstractProcessingParameterWidgetWrapper > mStaticWidgetWrapper;
    QgsExpressionLineEdit *mExpressionWidget = nullptr;
    QComboBox *mModelInputCombo = nullptr;
    QComboBox *mChildOutputCombo = nullptr;
    QgsFilterLineEdit *mModelOutputName = nullptr;
 
    QList< Qgis::ProcessingModelChildParameterSource > mLimitedSources;
 
    friend class TestProcessingGui;
};
 
 
#endif // QGSPROCESSINGMODELERPARAMETERWIDGET_H