qgsprocessingparameterdefinitionwidget.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingparameterdefinitionwidget.h
                         ----------------------------------------
    begin                : July 2019
    copyright            : (C) 2019 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 QGSPROCESSINGPARAMETERDEFINITIONWIDGET_H
#define QGSPROCESSINGPARAMETERDEFINITIONWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsexpressioncontextgenerator.h"
#include "qgsmodeldesignerconfigwidget.h"
#include "qgspanelwidget.h"
#include "qgsprocessingparameters.h"
#include "qgsprocessingwidgetwrapper.h"
 
#include <QDialog>
#include <QWidget>
 
class QgsProcessingContextGenerator;
 
class QLineEdit;
class QCheckBox;
class QTabWidget;
class QTextEdit;
class QgsColorButton;

class GUI_EXPORT QgsProcessingAbstractParameterDefinitionWidget : public QWidget, public QgsExpressionContextGenerator
{
    Q_OBJECT
 
  public:
    QgsProcessingAbstractParameterDefinitionWidget(
      QgsProcessingContext &context,
      const QgsProcessingParameterWidgetContext &widgetContext,
      const QgsProcessingParameterDefinition *definition = nullptr,
      const QgsProcessingAlgorithm *algorithm = nullptr,
      QWidget *parent SIP_TRANSFERTHIS = nullptr
    );

    virtual QgsProcessingParameterDefinition *createParameter( const QString &name, const QString &description, Qgis::ProcessingParameterFlags flags ) const = 0 SIP_FACTORY;

    virtual void setWidgetContext( const QgsProcessingParameterWidgetContext &context );

    const QgsProcessingParameterWidgetContext &widgetContext() const;

    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
 
    QgsExpressionContext createExpressionContext() const override;
 
  signals:

    void changed();
 
  private:
    QgsProcessingContextGenerator *mContextGenerator = nullptr;
    QgsProcessingParameterWidgetContext mWidgetContext;
};
 

class GUI_EXPORT QgsProcessingParameterDefinitionWidget : public QWidget
{
    Q_OBJECT
  public:
    QgsProcessingParameterDefinitionWidget(
      const QString &type,
      QgsProcessingContext &context,
      const QgsProcessingParameterWidgetContext &widgetContext,
      const QgsProcessingParameterDefinition *definition = nullptr,
      const QgsProcessingAlgorithm *algorithm = nullptr,
      QWidget *parent SIP_TRANSFERTHIS = nullptr
    );

    QgsProcessingParameterDefinition *createParameter( const QString &name = QString() ) const SIP_FACTORY;

    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
 
  signals:

    void changed();
 
  private:
    QString mType;
    QgsProcessingAbstractParameterDefinitionWidget *mDefinitionWidget = nullptr;
    QLineEdit *mDescriptionLineEdit = nullptr;
    QCheckBox *mRequiredCheckBox = nullptr;
    QCheckBox *mAdvancedCheckBox = nullptr;
 
    friend class QgsProcessingParameterDefinitionDialog;
};
 

class GUI_EXPORT QgsProcessingParameterDefinitionPanelWidget : public QgsProcessingModelConfigWidget
{
    Q_OBJECT
  public:
    QgsProcessingParameterDefinitionPanelWidget(
      const QString &type,
      QgsProcessingContext &context,
      const QgsProcessingParameterWidgetContext &widgetContext,
      const QgsProcessingParameterDefinition *definition = nullptr,
      const QgsProcessingAlgorithm *algorithm = nullptr,
      QWidget *parent SIP_TRANSFERTHIS = nullptr
    );

    QgsProcessingParameterDefinition *createParameter( const QString &name = QString() ) const SIP_FACTORY;

    void setComments( const QString &comments );

    QString comments() const;

    void setCommentColor( const QColor &color );

    QColor commentColor() const;

    void switchToCommentTab();

    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
 
  private:
    QTabWidget *mTabWidget = nullptr;
    QTextEdit *mCommentEdit = nullptr;
    QgsColorButton *mCommentColorButton = nullptr;
    QgsProcessingParameterDefinitionWidget *mWidget = nullptr;
 
    friend class QgsProcessingParameterDefinitionDialog;
};

class GUI_EXPORT QgsProcessingParameterDefinitionDialog : public QDialog
{
    Q_OBJECT
  public:
    QgsProcessingParameterDefinitionDialog(
      const QString &type,
      QgsProcessingContext &context,
      const QgsProcessingParameterWidgetContext &widgetContext,
      const QgsProcessingParameterDefinition *definition = nullptr,
      const QgsProcessingAlgorithm *algorithm = nullptr,
      QWidget *parent SIP_TRANSFERTHIS = nullptr
    );

    QgsProcessingParameterDefinition *createParameter( const QString &name = QString() ) const SIP_FACTORY;

    void setComments( const QString &comments );

    QString comments() const;

    void setCommentColor( const QColor &color );

    QColor commentColor() const;

    void switchToCommentTab();

    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
 
  public slots:
    void accept() override;
 
  private:
    QgsProcessingParameterDefinitionPanelWidget *mWidget = nullptr;
};
 
 
#endif // QGSPROCESSINGPARAMETERDEFINITIONWIDGET_H