A dialog which allow users to specify the properties of a Processing parameter. More...

#include <qgsprocessingparameterdefinitionwidget.h>

Inheritance diagram for QgsProcessingParameterDefinitionDialog:

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.

Detailed Description

A dialog which allow users to specify the properties of a Processing parameter.

Since: QGIS 3.10

Definition at line 173 of file qgsprocessingparameterdefinitionwidget.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterDefinitionDialog()

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 149 of file qgsprocessingparameterdefinitionwidget.cpp.

Member Function Documentation

◆ accept

void QgsProcessingParameterDefinitionDialog::accept ( )

overrideslot

Definition at line 237 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ commentColor()

QColor QgsProcessingParameterDefinitionDialog::commentColor ( ) const

Returns the color for the comments for the parameter.

See also: setCommentColor()

Since: QGIS 3.14

Definition at line 217 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ comments()

QString QgsProcessingParameterDefinitionDialog::comments ( ) const

Returns the comments for the parameter.

See also: setComments()

Since: QGIS 3.14

Definition at line 204 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ createParameter()

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 194 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ registerProcessingContextGenerator()

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.

Since: QGIS 3.18

Definition at line 229 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ setCommentColor()

void QgsProcessingParameterDefinitionDialog::setCommentColor ( const QColor & color )

Sets the color for the comments for the parameter.

See also: commentColor()

Since: QGIS 3.14

Definition at line 209 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ setComments()

void QgsProcessingParameterDefinitionDialog::setComments ( const QString & comments )

Sets the comments for the parameter.

See also: comments()

Since: QGIS 3.14

Definition at line 199 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ switchToCommentTab()

void QgsProcessingParameterDefinitionDialog::switchToCommentTab ( )

Switches the dialog to the comments tab.

Definition at line 222 of file qgsprocessingparameterdefinitionwidget.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/processing/qgsprocessingparameterdefinitionwidget.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/processing/qgsprocessingparameterdefinitionwidget.cpp

Public Slots

Public Member Functions