QGIS API Documentation 4.3.0-Master (6a28b93578f)
Loading...
Searching...
No Matches
QgsProcessingDialogFactory Class Referenceabstract

A factory for creating widgets and dialogs for Processing components. More...

#include <qgsprocessingguiregistry.h>

Public Member Functions

virtual ~QgsProcessingDialogFactory ()
virtual QgsProcessingScriptEditorDialog * createScriptEditorDialog (const QString &filePath=QString(), QWidget *parent=nullptr)=0
 Creates a new script editor dialog.
virtual QgsProcessingAlgorithmWidgetBase * createWidget (QgsProcessingAlgorithm *algorithm, bool inPlace=false, QMainWindow *parent=nullptr, QgsProcessingAlgorithmWidgetBase::WidgetFlags flags=QgsProcessingAlgorithmWidgetBase::WidgetFlags(), Qgis::DockableWidgetInitialState initialState=Qgis::DockableWidgetInitialState::RestorePreviousState)=0
 Creates a new widget for executing the specified algorithm.

Detailed Description

A factory for creating widgets and dialogs for Processing components.

Warning
This is not stable API, it is in place for temporary compatibility with Python code only.
Since
QGIS 4.4

Definition at line 54 of file qgsprocessingguiregistry.h.

Constructor & Destructor Documentation

◆ ~QgsProcessingDialogFactory()

QgsProcessingDialogFactory::~QgsProcessingDialogFactory ( )
virtualdefault

Member Function Documentation

◆ createScriptEditorDialog()

virtual QgsProcessingScriptEditorDialog * QgsProcessingDialogFactory::createScriptEditorDialog ( const QString & filePath = QString(),
QWidget * parent = nullptr )
pure virtual

Creates a new script editor dialog.

◆ createWidget()

virtual QgsProcessingAlgorithmWidgetBase * QgsProcessingDialogFactory::createWidget ( QgsProcessingAlgorithm * algorithm,
bool inPlace = false,
QMainWindow * parent = nullptr,
QgsProcessingAlgorithmWidgetBase::WidgetFlags flags = QgsProcessingAlgorithmWidgetBase::WidgetFlags(),
Qgis::DockableWidgetInitialState initialState = Qgis::DockableWidgetInitialState::RestorePreviousState )
pure virtual

Creates a new widget for executing the specified algorithm.


The documentation for this class was generated from the following files: