qgsprocessingwidgetwrapper.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingwidgetwrapper.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 QGSPROCESSINGWIDGETWRAPPER_H
#define QGSPROCESSINGWIDGETWRAPPER_H

#include <QObject>
#include <QWidget>
#include <QPointer>
#include <memory>
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsprocessinggui.h"
#include "qgsvectorlayer.h"

class QgsProcessingParameterDefinition;
class QgsProcessingContext;
class QgsProcessingModelerParameterWidget;
class QgsProcessingModelAlgorithm;
class QLabel;
class QgsPropertyOverrideButton;
class QgsVectorLayer;
class QgsProcessingModelAlgorithm;
class QgsMapCanvas;
class QgsProcessingAlgorithm;
class QgsProcessingAbstractParameterDefinitionWidget;
class QgsMessageBar;
class QgsBrowserGuiModel;

class GUI_EXPORT QgsProcessingContextGenerator
{
  public:

    virtual QgsProcessingContext *processingContext() = 0;

    virtual ~QgsProcessingContextGenerator() = default;
};

class GUI_EXPORT QgsProcessingParametersGenerator
{
  public:

    virtual QVariantMap createProcessingParameters() = 0;

    virtual ~QgsProcessingParametersGenerator() = default;
};


class GUI_EXPORT QgsProcessingParameterWidgetContext
{
  public:

    QgsProcessingParameterWidgetContext() = default;

    void setMapCanvas( QgsMapCanvas *canvas );

    QgsMapCanvas *mapCanvas() const;

    void setMessageBar( QgsMessageBar *bar );

    QgsMessageBar *messageBar() const;

    void setBrowserModel( QgsBrowserGuiModel *model );

    QgsBrowserGuiModel *browserModel() const;

    void setProject( QgsProject *project );

    QgsProject *project() const;

    QgsProcessingModelAlgorithm *model() const;

    void setModel( QgsProcessingModelAlgorithm *model );

    QString modelChildAlgorithmId() const;

    void setModelChildAlgorithmId( const QString &id );

    QgsMapLayer *activeLayer() const;

    void setActiveLayer( QgsMapLayer *layer );

  private:

    QgsProcessingModelAlgorithm *mModel = nullptr;

    QString mModelChildAlgorithmId;

    QgsMapCanvas *mMapCanvas = nullptr;

    QgsMessageBar *mMessageBar = nullptr;

    QgsProject *mProject = nullptr;

    QgsBrowserGuiModel *mBrowserModel = nullptr;

    QgsMapLayer *mActiveLayer = nullptr;

};

#ifndef SIP_RUN
class GUI_EXPORT QgsProcessingGuiUtils
{
  public:

    static QgsExpressionContext createExpressionContext( QgsProcessingContextGenerator *processingContextGenerator = nullptr,
        const QgsProcessingParameterWidgetContext &widgetContext = QgsProcessingParameterWidgetContext(),
        const QgsProcessingAlgorithm *algorithm = nullptr,
        const QgsVectorLayer *linkedLayer = nullptr );


};
#endif

class GUI_EXPORT QgsAbstractProcessingParameterWidgetWrapper : public QObject, public QgsExpressionContextGenerator
{
    Q_OBJECT

  public:

    QgsAbstractProcessingParameterWidgetWrapper( const QgsProcessingParameterDefinition *parameter = nullptr,
        QgsProcessingGui::WidgetType type = QgsProcessingGui::Standard, QObject *parent SIP_TRANSFERTHIS = nullptr );

    QgsProcessingGui::WidgetType type() const;

    virtual void setWidgetContext( const QgsProcessingParameterWidgetContext &context );

    const QgsProcessingParameterWidgetContext &widgetContext() const;

    QWidget *createWrappedWidget( QgsProcessingContext &context ) SIP_FACTORY;

    QLabel *createWrappedLabel() SIP_FACTORY;

    QWidget *wrappedWidget();

    QLabel *wrappedLabel();

    const QgsProcessingParameterDefinition *parameterDefinition() const;

    // TODO QGIS 4.0 -- remove
#ifdef SIP_RUN
    % Property( name = param, get = parameterDefinition )
#endif

    void setParameterValue( const QVariant &value, QgsProcessingContext &context );

    QVariant parameterValue() const;

    virtual QVariantMap customProperties() const;

    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );

    void registerProcessingParametersGenerator( QgsProcessingParametersGenerator *generator );

    virtual void postInitialize( const QList< QgsAbstractProcessingParameterWidgetWrapper * > &wrappers );

    virtual int stretch() const;

    QgsExpressionContext createExpressionContext() const override;

    virtual void setDialog( QDialog *dialog );

  signals:

    // TODO QGIS 4.0 - remove wrapper parameter - this is kept for compatibility with 3.x API,
    // yet can easily be retrieved by checking the sender()

    void widgetValueHasChanged( QgsAbstractProcessingParameterWidgetWrapper *wrapper );

  protected:

    virtual QWidget *createWidget() = 0 SIP_FACTORY;

    virtual QLabel *createLabel() SIP_FACTORY;

    virtual void setWidgetValue( const QVariant &value, QgsProcessingContext &context ) = 0;

    virtual QVariant widgetValue() const = 0;

    virtual const QgsVectorLayer *linkedVectorLayer() const;

  protected:

    QgsProcessingContextGenerator *mProcessingContextGenerator = nullptr;
    QgsProcessingParametersGenerator *mParametersGenerator = nullptr;
    QgsProcessingParameterWidgetContext mWidgetContext;

  private slots:

    void parentLayerChanged( QgsAbstractProcessingParameterWidgetWrapper *wrapper );

  private:

    QgsProcessingGui::WidgetType mType = QgsProcessingGui::Standard;
    const QgsProcessingParameterDefinition *mParameterDefinition = nullptr;

    void setDynamicParentLayerParameter( const QgsAbstractProcessingParameterWidgetWrapper *parentWrapper );

    QPointer< QWidget > mWidget;
    QPointer< QgsPropertyOverrideButton > mPropertyButton;
    QPointer< QLabel > mLabel;
    std::unique_ptr< QgsVectorLayer > mDynamicLayer;

    friend class TestProcessingGui;

};


class GUI_EXPORT QgsProcessingParameterWidgetFactoryInterface
{

  public:

    virtual ~QgsProcessingParameterWidgetFactoryInterface() = default;

    virtual QString parameterType() const = 0;

    virtual QgsAbstractProcessingParameterWidgetWrapper *createWidgetWrapper( const QgsProcessingParameterDefinition *parameter,
        QgsProcessingGui::WidgetType type ) = 0 SIP_FACTORY;

    virtual QgsProcessingModelerParameterWidget *createModelerWidgetWrapper( QgsProcessingModelAlgorithm *model,
        const QString &childId,
        const QgsProcessingParameterDefinition *parameter,
        QgsProcessingContext &context );

    virtual QgsProcessingAbstractParameterDefinitionWidget *createParameterDefinitionWidget(
      QgsProcessingContext &context,
      const QgsProcessingParameterWidgetContext &widgetContext,
      const QgsProcessingParameterDefinition *definition = nullptr,
      const QgsProcessingAlgorithm *algorithm = nullptr ) SIP_FACTORY;

  protected:

    virtual QStringList compatibleParameterTypes() const = 0;

    virtual QStringList compatibleOutputTypes() const = 0;

    virtual QList< int > compatibleDataTypes( const QgsProcessingParameterDefinition *parameter ) const;

    virtual QString modelerExpressionFormatString() const;

};

class GUI_EXPORT QgsProcessingHiddenWidgetWrapper: public QgsAbstractProcessingParameterWidgetWrapper
{
  public:

    QgsProcessingHiddenWidgetWrapper( const QgsProcessingParameterDefinition *parameter = nullptr,
                                      QgsProcessingGui::WidgetType type = QgsProcessingGui::Standard,
                                      QObject *parent SIP_TRANSFERTHIS = nullptr );

    void setWidgetValue( const QVariant &value, QgsProcessingContext &context ) override;
    QVariant widgetValue() const override;

    const QgsVectorLayer *linkedVectorLayer() const override;

    void setLinkedVectorLayer( const QgsVectorLayer *layer );

  protected:
    QWidget *createWidget() override;
    QLabel *createLabel() override;

  private:

    QVariant mValue;
    QPointer < const QgsVectorLayer > mLayer;

};

#endif // QGSPROCESSINGWIDGETWRAPPER_H