qgsprocessingguiregistry.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingguiregistry.h
                         ---------------------
    begin                : April 2018
    copyright            : (C) 2018 by Matthias Kuhn
    email                : matthias@opengis.ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSPROCESSINGGUIREGISTRY_H
#define QGSPROCESSINGGUIREGISTRY_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsmodeldesignerconfigwidget.h"
#include "qgsprocessingalgorithmwidgetbase.h"
#include "qgsprocessingwidgetcontext.h"
#include "qgsprocessingwidgetwrapper.h"
 
#include <QList>
#include <QMap>
 
class QgsProcessingAlgorithm;
class QgsProcessingAlgorithmConfigurationWidget;
class QgsProcessingAlgorithmConfigurationWidgetFactory;
class QgsProcessingModelerParameterWidget;
class QgsProcessingParameterWidgetContext;
class QgsProcessingModelConfigWidgetFactory;
class QgsProcessingModelConfigWidget;
class QgsProcessingModelComponent;
class QgsProcessingGuiInternalModelConfigWidgetFactory;
class QgsProcessingToolboxAction;
class QgsProcessingToolboxContextAction;
class QgsProcessingAlgorithmWidgetBase;
class QgsProcessingScriptEditorDialog;
class QMainWindow;

class GUI_EXPORT QgsProcessingDialogFactory
{
  public:
    virtual ~QgsProcessingDialogFactory();

    virtual QgsProcessingAlgorithmWidgetBase *createWidget(
      QgsProcessingAlgorithm *algorithm SIP_TRANSFER,
      bool inPlace = false,
      QMainWindow *parent = nullptr,
      QgsProcessingAlgorithmWidgetBase::WidgetFlags flags = QgsProcessingAlgorithmWidgetBase::WidgetFlags(),
      Qgis::DockableWidgetInitialState initialState = Qgis::DockableWidgetInitialState::RestorePreviousState
    ) = 0 SIP_TRANSFERBACK;
 

    virtual QgsProcessingScriptEditorDialog *createScriptEditorDialog( const QString &filePath = QString(), QWidget *parent = nullptr ) = 0 SIP_TRANSFERBACK;
};

class GUI_EXPORT QgsProcessingContextFactory
{
  public:
    virtual ~QgsProcessingContextFactory();

    virtual QgsProcessingContext *createContext( QgsProcessingFeedback *feedback = nullptr ) = 0 SIP_TRANSFERBACK;
};

class GUI_EXPORT QgsProcessingGuiRegistry : public QgsProcessingWidgetContextGenerator
{
  public:
    QgsProcessingGuiRegistry();
    ~QgsProcessingGuiRegistry() override;

    void addAlgorithmConfigurationWidgetFactory( QgsProcessingAlgorithmConfigurationWidgetFactory *factory SIP_TRANSFER );

    void removeAlgorithmConfigurationWidgetFactory( QgsProcessingAlgorithmConfigurationWidgetFactory *factory );

    QgsProcessingAlgorithmConfigurationWidget *algorithmConfigurationWidget( const QgsProcessingAlgorithm *algorithm ) const;

    bool addParameterWidgetFactory( QgsProcessingParameterWidgetFactoryInterface *factory SIP_TRANSFER );

    void removeParameterWidgetFactory( QgsProcessingParameterWidgetFactoryInterface *factory );

    void registerModelConfigWidgetFactory( QgsProcessingModelConfigWidgetFactory *factory );

    void unregisterModelConfigWidgetFactory( QgsProcessingModelConfigWidgetFactory *factory );

    QgsAbstractProcessingParameterWidgetWrapper *createParameterWidgetWrapper( const QgsProcessingParameterDefinition *parameter, Qgis::ProcessingMode type ) SIP_TRANSFERBACK;

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

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

    QgsProcessingModelConfigWidget *createModelConfigWidgetForComponent( QgsProcessingModelComponent *component, QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext ) const
      SIP_FACTORY;

    void registerWidgetContextGenerator( QgsProcessingWidgetContextGenerator *generator );

    QgsProcessingParameterWidgetContext createWidgetContext() override;

    void registerProviderToolboxAction( const QString &providerId, QgsProcessingToolboxAction *action SIP_TRANSFER );

    void deregisterProviderToolboxActions( const QString &providerId );

    QList< QgsProcessingToolboxAction * > toolboxActionsForProvider( const QString &providerId ) const;

    void registerProviderToolboxContextAction( const QString &providerId, QgsProcessingToolboxContextAction *action SIP_TRANSFER );

    void deregisterProviderToolboxContextActions( const QString &providerId );

    Q_DECL_DEPRECATED void deregisterProviderToolboxContextAction( QgsProcessingToolboxContextAction *action SIP_TRANSFERBACK ) SIP_DEPRECATED;

    QList< QgsProcessingToolboxContextAction * > toolboxContextActionsForProvider( const QString &providerId ) const;

    QList< QgsProcessingToolboxContextAction * > toolboxContextActions() const;

    void setDialogFactory( QgsProcessingDialogFactory *factory SIP_TRANSFER );

    QgsProcessingDialogFactory *dialogFactory();

    void setContextFactory( QgsProcessingContextFactory *factory SIP_TRANSFER );

    QgsProcessingContextFactory *contextFactory();
 
  private:
#ifdef SIP_RUN
    QgsProcessingGuiRegistry( const QgsProcessingGuiRegistry &other );
#endif
    QList<QgsProcessingAlgorithmConfigurationWidgetFactory *> mAlgorithmConfigurationWidgetFactories;
    QMap<QString, QgsProcessingParameterWidgetFactoryInterface *> mParameterWidgetFactories;
 
    QList<QPointer<QgsProcessingModelConfigWidgetFactory>> mModelConfigWidgetFactories;
    std::unique_ptr< QgsProcessingGuiInternalModelConfigWidgetFactory > mModelConfigWidgetFactory;
 
    QgsProcessingWidgetContextGenerator *mWidgetContextGenerator = nullptr;
 
    QMap< QString, QList< QgsProcessingToolboxAction * > > mProviderToolboxActions;
    QMap< QString, QList< QgsProcessingToolboxContextAction * > > mProviderToolboxContextActions;
    std::unique_ptr< QgsProcessingDialogFactory > mProcessingDialogFactory;
    std::unique_ptr< QgsProcessingContextFactory > mContextFactory;
};
 
 
#ifndef SIP_RUN
class GUI_EXPORT QgsProcessingGuiInternalModelConfigWidgetFactory : public QgsProcessingModelConfigWidgetFactory
{
    Q_OBJECT
  public:
    bool supportsComponent( QgsProcessingModelComponent *component ) const final;
    QgsProcessingModelConfigWidget *createWidget( QgsProcessingModelComponent *component, QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext ) const final;
};
#endif
#endif // QGSPROCESSINGGUIREGISTRY_H