qgsmodeldesignerdialog.h

Go to the documentation of this file.

/***************************************************************************
                             qgsmodeldesignerdialog.h
                             ------------------------
    Date                 : March 2020
    Copyright            : (C) 2020 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 QGSMODELDESIGNERDIALOG_H
#define QGSMODELDESIGNERDIALOG_H
 
#include "ui_qgsmodeldesignerdialogbase.h"
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsmodelundocommand.h"
#include "qgsprocessingalgorithmwidgetbase.h"
#include "qgsprocessingmodelchilddependency.h"
#include "qgsprocessingtoolboxmodel.h"
#include "qobjectuniqueptr.h"
 
class QgsMessageBar;
class QgsProcessingModelAlgorithm;
class QgsModelUndoCommand;
class QUndoView;
class QgsModelViewToolPan;
class QgsModelViewToolSelect;
class QgsScreenHelper;
class QgsProcessingAlgorithmWidgetBase;
class QgsModelDesignerConfigDockWidget;
class QgsProcessingParameterWidgetContext;
class QgsProcessingContextGenerator;

 
#ifndef SIP_RUN
 
class GUI_EXPORT QgsModelerToolboxModel : public QgsProcessingToolboxProxyModel
{
    Q_OBJECT
  public:
    explicit QgsModelerToolboxModel( QObject *parent = nullptr );
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    Qt::DropActions supportedDragActions() const override;
};
 
#endif

class GUI_EXPORT QgsModelDesignerDialog : public QMainWindow,
                                          public QgsProcessingFeedbackGenerator,
                                          public QgsProcessingContextGenerator,
                                          public QgsProcessingWidgetContextGenerator,
                                          public Ui::QgsModelDesignerDialogBase
{
    Q_OBJECT
  public:
    QgsModelDesignerDialog( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = Qt::WindowFlags() );
    ~QgsModelDesignerDialog() override;
 
    void closeEvent( QCloseEvent *event ) override;

    void beginUndoCommand( const QString &text, const QString &id = QString(), QgsModelUndoCommand::CommandOperation operation SIP_PYARGREMOVE = QgsModelUndoCommand::CommandOperation::Unknown );

    void endUndoCommand();

    void abortUndoCommand();

    QgsProcessingModelAlgorithm *model();

    void setModel( QgsProcessingModelAlgorithm *model SIP_TRANSFER );

    void loadModel( const QString &path );

    void setModelScene( QgsModelGraphicsScene *scene SIP_TRANSFER );

    QgsModelGraphicsScene *modelScene();
 
    QgsProcessingFeedback *createFeedback() override SIP_FACTORY;
    QgsProcessingParameterWidgetContext createWidgetContext() override;

    enum class SaveAction
    {
      SaveAsFile,    
      SaveInProject, 
    };
 
  public slots:

    void activate();
 
  protected:
    // cppcheck-suppress pureVirtualCall
    virtual void repaintModel( bool showControls = true ) = 0;
    virtual void addAlgorithm( const QString &algorithmId, const QPointF &pos ) = 0;
    // cppcheck-suppress pureVirtualCall
    virtual void addInput( const QString &inputId, const QPointF &pos ) = 0;
    // cppcheck-suppress pureVirtualCall
    virtual void exportAsScriptAlgorithm() = 0;
    // cppcheck-suppress pureVirtualCall
    virtual bool saveModel( bool saveAs = false ) = 0;
    // cppcheck-suppress pureVirtualCall
    virtual QgsProcessingAlgorithmWidgetBase *createExecutionWidget() = 0 SIP_TRANSFERBACK;

    void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
    QgsProcessingContext *processingContext() const override;
 
    QToolBar *toolbar() { return mToolbar; }
    QAction *actionOpen() { return mActionOpen; }
    QAction *actionSaveInProject() { return mActionSaveInProject; }
    QAction *actionRun() { return mActionRun; }
    QgsMessageBar *messageBar() { return mMessageBar; }
 
#ifndef SIP_RUN
    QgsModelGraphicsView *view() { return mView; }
#endif
 
    void setDirty( bool dirty );

    bool validateSave( SaveAction action );

    bool checkForUnsavedChanges();

    void setLastRunResult( const QgsProcessingModelResult &result );

    void setModelName( const QString &name );
 
  private slots:
    void zoomIn();
    void zoomOut();
    void zoomActual();
    void zoomFull();
    void newModel();
    void exportToImage();
    void exportToPdf();
    void exportToSvg();
    void exportAsPython();
    void toggleComments( bool show );
    void toggleFeatureCount( bool show );
    void updateWindowTitle();
    void deleteSelected();
    void populateZoomToMenu();
    void validate();
    void reorderInputs();
    void reorderOutputs();
    void setPanelVisibility( bool hidden );
    void editHelp();
    void runSelectedSteps();
    void runFromChild( const QString &id );
    void run( const QSet<QString> &childAlgorithmSubset = QSet<QString>() );
    void showChildAlgorithmOutputs( const QString &childId );
    void showChildAlgorithmLog( const QString &childId );
    void onItemFocused( QgsModelComponentGraphicItem *item );
 
    void cancelRunningModel();
 
  private:
    std::unique_ptr<QgsProcessingModelAlgorithm> mModel;
 
    QgsScreenHelper *mScreenHelper = nullptr;
 
    QgsMessageBar *mMessageBar = nullptr;
    QgsModelerToolboxModel *mAlgorithmsModel = nullptr;
 
    QPointer<QgsProcessingAlgorithmWidgetBase> mAlgorithmWidget;
 
    QVector<QPointer<QgsProcessingAlgorithmWidgetBase>> mAlgorithmWidgetsToCleanUp;
 
    QActionGroup *mToolsActionGroup = nullptr;
 
    QgsModelViewToolPan *mPanTool = nullptr;
    QObjectUniquePtr<QgsModelViewToolSelect> mSelectTool;
    QgsModelGraphicsScene *mScene = nullptr;
 
    bool mHasChanged = false;
    QUndoStack *mUndoStack = nullptr;
    std::unique_ptr<QgsModelUndoCommand> mActiveCommand;
 
    QAction *mUndoAction = nullptr;
    QAction *mRedoAction = nullptr;
    QUndoView *mUndoView = nullptr;
    QgsDockWidget *mUndoDock = nullptr;
 
    QMenu *mGroupMenu = nullptr;
 
    QAction *mActionCut = nullptr;
    QAction *mActionCopy = nullptr;
    QAction *mActionPaste = nullptr;
    int mBlockUndoCommands = 0;
    int mIgnoreUndoStackChanges = 0;
 
    QgsDockWidget *mConfigWidgetDock = nullptr;
    QgsModelDesignerConfigDockWidget *mConfigWidget = nullptr;
 
    QgsProcessingContextGenerator *mProcessingContextGenerator = nullptr;
 
    QString mTitle;
 
    int mBlockRepaints = 0;
 
    QgsProcessingModelResult mLastResult;
    QSet< QString > mOutdatedChildResults;
 
    bool isDirty() const;
 
    void fillInputsTree();
    void updateVariablesGui();
 
    struct PanelStatus
    {
        PanelStatus( bool visible = true, bool active = false )
          : isVisible( visible )
          , isActive( active )
        {}
        bool isVisible;
        bool isActive;
    };
    QMap<QString, PanelStatus> mPanelStatus;
 
    QgsProcessingContext mLayerStore;
};
 
 
class GUI_EXPORT QgsModelChildDependenciesWidget : public QWidget
{
    Q_OBJECT
 
  public:
    QgsModelChildDependenciesWidget( QWidget *parent, QgsProcessingModelAlgorithm *model, const QString &childId );
    QList<QgsProcessingModelChildDependency> value() const { return mValue; }
    void setValue( const QList<QgsProcessingModelChildDependency> &value );
 
  signals:

    void changed();
 
  private slots:
 
    void showDialog();
 
  private:
    void updateSummaryText();
 
    QLineEdit *mLineEdit = nullptr;
    QToolButton *mToolButton = nullptr;
 
    QgsProcessingModelAlgorithm *mModel = nullptr;
    QString mChildId;
 
    QList<QgsProcessingModelChildDependency> mValue;
 
    friend class TestProcessingGui;
};
 
#endif // QGSMODELDESIGNERDIALOG_H