QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A dialog which allow users to specify the properties of a Processing parameter. More...
#include <qgsprocessingparameterdefinitionwidget.h>
Public Slots | |
void | accept () override |
Public Member Functions | |
QgsProcessingParameterDefinitionDialog (const QString &type, QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext, const QgsProcessingParameterDefinition *definition=nullptr, const QgsProcessingAlgorithm *algorithm=nullptr, QWidget *parent=nullptr) | |
Constructor for QgsProcessingParameterDefinitionDialog, for a parameter of the specified type. | |
QColor | commentColor () const |
Returns the color for the comments for the parameter. | |
QString | comments () const |
Returns the comments for the parameter. | |
QgsProcessingParameterDefinition * | createParameter (const QString &name=QString()) const |
Returns a new instance of a parameter definition, using the current settings defined in the dialog. | |
void | registerProcessingContextGenerator (QgsProcessingContextGenerator *generator) |
Registers a Processing context generator class that will be used to retrieve a Processing context for the widget when required. | |
void | setCommentColor (const QColor &color) |
Sets the color for the comments for the parameter. | |
void | setComments (const QString &comments) |
Sets the comments for the parameter. | |
void | switchToCommentTab () |
Switches the dialog to the comments tab. | |
A dialog which allow users to specify the properties of a Processing parameter.
Definition at line 186 of file qgsprocessingparameterdefinitionwidget.h.
QgsProcessingParameterDefinitionDialog::QgsProcessingParameterDefinitionDialog | ( | const QString & | type, |
QgsProcessingContext & | context, | ||
const QgsProcessingParameterWidgetContext & | widgetContext, | ||
const QgsProcessingParameterDefinition * | definition = nullptr , |
||
const QgsProcessingAlgorithm * | algorithm = nullptr , |
||
QWidget * | parent = nullptr |
||
) |
Constructor for QgsProcessingParameterDefinitionDialog, for a parameter of the specified type.
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 dialog's state.
Additionally, the optional algorithm parameter may be used to specify the algorithm or model associated with the parameter.
Definition at line 156 of file qgsprocessingparameterdefinitionwidget.cpp.
|
overrideslot |
Definition at line 250 of file qgsprocessingparameterdefinitionwidget.cpp.
QColor QgsProcessingParameterDefinitionDialog::commentColor | ( | ) | const |
Returns the color for the comments for the parameter.
Definition at line 230 of file qgsprocessingparameterdefinitionwidget.cpp.
QString QgsProcessingParameterDefinitionDialog::comments | ( | ) | const |
Returns the comments for the parameter.
Definition at line 217 of file qgsprocessingparameterdefinitionwidget.cpp.
QgsProcessingParameterDefinition * QgsProcessingParameterDefinitionDialog::createParameter | ( | const QString & | name = QString() | ) | const |
Returns a new instance of a parameter definition, using the current settings defined in the dialog.
The name parameter specifies the name for the newly created parameter.
Definition at line 207 of file qgsprocessingparameterdefinitionwidget.cpp.
void QgsProcessingParameterDefinitionDialog::registerProcessingContextGenerator | ( | QgsProcessingContextGenerator * | generator | ) |
Registers a Processing context generator class that will be used to retrieve a Processing context for the widget when required.
Definition at line 242 of file qgsprocessingparameterdefinitionwidget.cpp.
void QgsProcessingParameterDefinitionDialog::setCommentColor | ( | const QColor & | color | ) |
Sets the color for the comments for the parameter.
Definition at line 222 of file qgsprocessingparameterdefinitionwidget.cpp.
void QgsProcessingParameterDefinitionDialog::setComments | ( | const QString & | comments | ) |
Sets the comments for the parameter.
Definition at line 212 of file qgsprocessingparameterdefinitionwidget.cpp.
void QgsProcessingParameterDefinitionDialog::switchToCommentTab | ( | ) |
Switches the dialog to the comments tab.
Definition at line 235 of file qgsprocessingparameterdefinitionwidget.cpp.