Abstract base class for widgets which allow users to specify the properties of a Processing parameter. More...
#include <qgsprocessingparameterdefinitionwidget.h>
Public Member Functions | |
| QgsProcessingAbstractParameterDefinitionWidget (QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext, const QgsProcessingParameterDefinition *definition=nullptr, const QgsProcessingAlgorithm *algorithm=nullptr, QWidget *parent=nullptr) | |
| Creates a new QgsProcessingAbstractParameterDefinitionWidget, with the specified parent widget. More... | |
| virtual QgsProcessingParameterDefinition * | createParameter (const QString &name, const QString &description, QgsProcessingParameterDefinition::Flags flags) const =0 |
| Returns a new instance of a parameter definition, using the current settings defined in the dialog. More... | |
Detailed Description
Abstract base class for widgets which allow users to specify the properties of a Processing parameter.
- Since
- QGIS 3.10
Definition at line 40 of file qgsprocessingparameterdefinitionwidget.h.
Constructor & Destructor Documentation
◆ QgsProcessingAbstractParameterDefinitionWidget()
| QgsProcessingAbstractParameterDefinitionWidget::QgsProcessingAbstractParameterDefinitionWidget | ( | QgsProcessingContext & | context, |
| const QgsProcessingParameterWidgetContext & | widgetContext, | ||
| const QgsProcessingParameterDefinition * | definition = nullptr, |
||
| const QgsProcessingAlgorithm * | algorithm = nullptr, |
||
| QWidget * | parent = nullptr |
||
| ) |
Creates a new QgsProcessingAbstractParameterDefinitionWidget, with the specified parent widget.
The context argument must specify a Processing context, which will be used by the widget to evaluate existing definition properties such as default values. Similarly, the widgetContext argument specifies the wider GUI context in which the widget will be used.
The optional definition argument may be used to provide a parameter definition to use to initially populate the widget's state.
Additionally, the optional algorithm parameter may be used to specify the algorithm or model associated with the parameter.
Definition at line 33 of file qgsprocessingparameterdefinitionwidget.cpp.
Member Function Documentation
◆ createParameter()
|
pure virtual |
Returns a new instance of a parameter definition, using the current settings defined in the dialog.
Common properties for parameters, including the name, description, and parameter flags are passed to the method. Subclass implementations must use these properties when crafting a parameter definition which also respects the additional properties specific to the parameter type handled by the widget subclass.
The documentation for this class was generated from the following files:
- /build/qgis-3.10.0+15buster/src/gui/processing/qgsprocessingparameterdefinitionwidget.h
- /build/qgis-3.10.0+15buster/src/gui/processing/qgsprocessingparameterdefinitionwidget.cpp
