qgsmodelchildalgorithmwidgets.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmodelchildalgorithmwidgets.h
                         ----------------------------------------
    begin                : August 2026
    copyright            : (C) 2026 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 QGSPROCESSINGMODELCHILDALGORITHMNWIDGETS_H
#define QGSPROCESSINGMODELCHILDALGORITHMNWIDGETS_H
 
#include <memory>
 
#include "qgis_gui.h"
#include "qgsmodeldesignerconfigwidget.h"
#include "qgspanelwidget.h"
#include "qgsprocessingwidgetwrapper.h"
 
#include <QDialog>
 
#define SIP_NO_FILE
 
class QgsProcessingAlgorithm;
class QgsProcessingModelAlgorithm;
class QgsProcessingContext;
class QgsProcessingModelChildAlgorithm;
class QgsProcessingModelOutput;
class QLineEdit;
class QgsMessageBar;
class QgsProcessingAlgorithmConfigurationWidget;
class QgsProcessingModelerParameterWidget;
class QgsModelChildDependenciesWidget;
class QgsProcessingContextGenerator;
class QTabWidget;
class QgsPanelWidgetStack;
class QTextEdit;
class QgsColorButton;
class QDialogButtonBox;
 

class GUI_EXPORT QgsProcessingModelerParametersPanelWidget : public QgsPanelWidget, public QgsProcessingContextGenerator
{
    Q_OBJECT
 
  public:
    QgsProcessingModelerParametersPanelWidget(
      const QgsProcessingAlgorithm *childAlgorithm,
      QgsProcessingModelAlgorithm *model,
      QgsProcessingContext &context,
      const QString &childId = QString(),
      const QVariantMap &configuration = QVariantMap(),
      QWidget *parent = nullptr,
      QWidget *dialog = nullptr
    );
 
    ~QgsProcessingModelerParametersPanelWidget() override;

    const QgsProcessingAlgorithm *algorithm() const;

    std::unique_ptr< QgsProcessingModelChildAlgorithm > createAlgorithm();
 
    QgsProcessingContext *processingContext() const override;

    void setWidgetContext( const QgsProcessingParameterWidgetContext &context );

    void setStateFromChildAlgorithm();
 
  private:
    void setupUi();
    void emitChangedSignal();
 
    std::unique_ptr< QgsProcessingAlgorithm > mAlgorithm;
    QgsProcessingModelAlgorithm *mModel = nullptr;
    QString mChildId;
    QVariantMap mConfiguration;
    QgsProcessingContext &mContext;
    QWidget *mDialog = nullptr;
 
    QMap< QString, QgsProcessingModelOutput > mPreviousOutputDefinitions;
    int mBlockChangesSignal = 0;
 
    QLineEdit *mDescriptionBox = nullptr;
    QgsMessageBar *mMessageBar = nullptr;
    QgsProcessingAlgorithmConfigurationWidget *mAlgorithmItem = nullptr;
    QMap< QString, QgsProcessingModelerParameterWidget * > mWrappers;
    QgsModelChildDependenciesWidget *mDependenciesPanel = nullptr;
 
    friend class TestQgsProcessingModelGui;
};

class GUI_EXPORT QgsProcessingModelerParametersWidget : public QgsProcessingModelConfigWidget
{
    Q_OBJECT
 
  public:
    QgsProcessingModelerParametersWidget(
      const QgsProcessingAlgorithm *childAlgorithm,
      QgsProcessingModelAlgorithm *model,
      QgsProcessingContext &context,
      const QString &childId = QString(),
      const QVariantMap &configuration = QVariantMap(),
      QWidget *parent = nullptr,
      QWidget *dialog = nullptr
    );
 
    ~QgsProcessingModelerParametersWidget() override;

    const QgsProcessingAlgorithm *algorithm() const;

    void setComments( const QString &text );

    QString comments() const;

    void setCommentColor( const QColor &color );

    QColor commentColor() const;

    void switchToCommentTab();

    void setWidgetContext( const QgsProcessingParameterWidgetContext &context );

    void setStateFromChildAlgorithm();

    std::unique_ptr< QgsProcessingModelChildAlgorithm > createAlgorithm();
 
  private:
    void setupUi();
 
    QTabWidget *mTabWidget = nullptr;
    QgsPanelWidgetStack *mPanelWidgetStack = nullptr;
    QgsProcessingModelerParametersPanelWidget *mParametersPanel = nullptr;
    QTextEdit *mCommentEdit = nullptr;
    QgsColorButton *mCommentColorButton = nullptr;
 
    friend class TestQgsProcessingModelGui;
};

class GUI_EXPORT QgsProcessingModelerParametersDialog : public QDialog
{
    Q_OBJECT
 
  public:
    QgsProcessingModelerParametersDialog(
      const QgsProcessingAlgorithm *childAlgorithm,
      QgsProcessingModelAlgorithm *model,
      QgsProcessingContext &context,
      const QString &childId = QString(),
      const QVariantMap &configuration = QVariantMap(),
      QWidget *parent = nullptr
    );
 
    ~QgsProcessingModelerParametersDialog() override;

    const QgsProcessingAlgorithm *algorithm() const;

    void setComments( const QString &comments );

    QString comments() const;

    void setCommentColor( const QColor &color );

    QColor commentColor() const;

    void switchToCommentTab();

    void setWidgetContext( const QgsProcessingParameterWidgetContext &context );

    void setStateFromChildAlgorithm();

    std::unique_ptr< QgsProcessingModelChildAlgorithm > createAlgorithm();
 
  private slots:
    void okPressed();
    void openHelp();
 
  private:
    QgsProcessingModelerParametersWidget *mWidget = nullptr;
    QDialogButtonBox *mButtonBox = nullptr;
};
 
 
#endif // QGSPROCESSINGMODELCHILDALGORITHMNWIDGETS_H