qgsprocessingwidgetcontext.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingwidgetcontext.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 QGSPROCESSINGWIDGETCONTEXT_H
#define QGSPROCESSINGWIDGETCONTEXT_H
 
#include <memory>
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QPointer>
 
class QgsMapCanvas;
class QgsMessageBar;
class QgsBrowserGuiModel;
class QgsProject;
class QgsProcessingModelAlgorithm;
class QgsMapLayer;
class QgsProcessingContextGenerator;
class QgsModelDesignerDialog;
 
// TODO QGIS 5: rename to QgsProcessingWidgetContext

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 );

    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );

    QgsProcessingContextGenerator *processingContextGenerator();

    QgsModelDesignerDialog *modelDesignerDialog() const;

    void setModelDesignerDialog( QgsModelDesignerDialog *dialog );
 
  private:
    QgsProcessingModelAlgorithm *mModel = nullptr;
 
    QString mModelChildAlgorithmId;
 
    QPointer< QgsMapCanvas > mMapCanvas;
 
    QPointer< QgsMessageBar > mMessageBar;
 
    QPointer< QgsProject > mProject;
 
    QPointer< QgsBrowserGuiModel > mBrowserModel;
 
    QPointer< QgsMapLayer > mActiveLayer;
 
    QgsProcessingContextGenerator *mProcessingContextGenerator = nullptr;
 
    QPointer< QgsModelDesignerDialog > mModelDialog;
};

class GUI_EXPORT QgsProcessingWidgetContextGenerator
{
  public:
    virtual QgsProcessingParameterWidgetContext createWidgetContext() = 0;
 
    virtual ~QgsProcessingWidgetContextGenerator() = default;
};
 
 
#endif // QGSPROCESSINGWIDGETCONTEXT_H