A dialog for configuring parameter settings and comments for a child algorithm in a Processing model. More...

#include <qgsmodelchildalgorithmwidgets.h>

Inheritance diagram for QgsProcessingModelerParametersDialog:

Public Member Functions
	QgsProcessingModelerParametersDialog (const QgsProcessingAlgorithm childAlgorithm, QgsProcessingModelAlgorithm model, QgsProcessingContext &context, const QString &childId=QString(), const QVariantMap &configuration=QVariantMap(), QWidget *parent=nullptr)
	Constructor for QgsProcessingModelerParametersDialog.
	~QgsProcessingModelerParametersDialog () override
const QgsProcessingAlgorithm *	algorithm () const
	Returns the algorithm associated with the dialog.
QColor	commentColor () const
	Returns the algorithm's comment color.
QString	comments () const
	Returns the algorithm's comments.
std::unique_ptr< QgsProcessingModelChildAlgorithm >	createAlgorithm ()
	Creates the child algorithm instance, populated with the current dialog parameter values and comments.
void	setCommentColor (const QColor &color)
	Sets the algorithm's comment color.
void	setComments (const QString &comments)
	Sets the algorithm's comments.
void	setStateFromChildAlgorithm ()
	Sets widget state from the existing child algorithm definition in the model.
void	setWidgetContext (const QgsProcessingParameterWidgetContext &context)
	Sets the context in which the dialog is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior.
void	switchToCommentTab ()
	Focuses the dialog on the comment editing tab.

Detailed Description

A dialog for configuring parameter settings and comments for a child algorithm in a Processing model.

Note: Not available in Python bindings

Since: QGIS 4.4

Definition at line 227 of file qgsmodelchildalgorithmwidgets.h.

Constructor & Destructor Documentation

◆ QgsProcessingModelerParametersDialog()

QgsProcessingModelerParametersDialog::QgsProcessingModelerParametersDialog	(	const QgsProcessingAlgorithm *	childAlgorithm,
		QgsProcessingModelAlgorithm *	model,
		QgsProcessingContext &	context,
		const QString &	childId = QString(),
		const QVariantMap &	configuration = QVariantMap(),
		QWidget *	parent = nullptr )

Constructor for QgsProcessingModelerParametersDialog.

Definition at line 618 of file qgsmodelchildalgorithmwidgets.cpp.

◆ ~QgsProcessingModelerParametersDialog()

QgsProcessingModelerParametersDialog::~QgsProcessingModelerParametersDialog ( )

overridedefault

Member Function Documentation

◆ algorithm()

const QgsProcessingAlgorithm * QgsProcessingModelerParametersDialog::algorithm ( ) const

Returns the algorithm associated with the dialog.

Definition at line 650 of file qgsmodelchildalgorithmwidgets.cpp.

◆ commentColor()

QColor QgsProcessingModelerParametersDialog::commentColor ( ) const

Returns the algorithm's comment color.

See also: setCommentColor()

Definition at line 670 of file qgsmodelchildalgorithmwidgets.cpp.

◆ comments()

QString QgsProcessingModelerParametersDialog::comments ( ) const

Returns the algorithm's comments.

See also: setComments()

Definition at line 660 of file qgsmodelchildalgorithmwidgets.cpp.

◆ createAlgorithm()

std::unique_ptr< QgsProcessingModelChildAlgorithm > QgsProcessingModelerParametersDialog::createAlgorithm ( )

Creates the child algorithm instance, populated with the current dialog parameter values and comments.

Definition at line 690 of file qgsmodelchildalgorithmwidgets.cpp.

◆ setCommentColor()

void QgsProcessingModelerParametersDialog::setCommentColor ( const QColor & color )

Sets the algorithm's comment color.

See also: commentColor()

Definition at line 665 of file qgsmodelchildalgorithmwidgets.cpp.

◆ setComments()

void QgsProcessingModelerParametersDialog::setComments ( const QString & comments )

Sets the algorithm's comments.

See also: comments()

Definition at line 655 of file qgsmodelchildalgorithmwidgets.cpp.

◆ setStateFromChildAlgorithm()

void QgsProcessingModelerParametersDialog::setStateFromChildAlgorithm ( )

Sets widget state from the existing child algorithm definition in the model.

Definition at line 685 of file qgsmodelchildalgorithmwidgets.cpp.

◆ setWidgetContext()

void QgsProcessingModelerParametersDialog::setWidgetContext ( const QgsProcessingParameterWidgetContext & context )

Sets the context in which the dialog is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior.

Definition at line 680 of file qgsmodelchildalgorithmwidgets.cpp.

◆ switchToCommentTab()

void QgsProcessingModelerParametersDialog::switchToCommentTab ( )

Focuses the dialog on the comment editing tab.

Definition at line 675 of file qgsmodelchildalgorithmwidgets.cpp.

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

/build/qgis-4.3.0+git20260925+16649ce5cc6+99sid/src/gui/processing/models/qgsmodelchildalgorithmwidgets.h
/build/qgis-4.3.0+git20260925+16649ce5cc6+99sid/src/gui/processing/models/qgsmodelchildalgorithmwidgets.cpp

Public Member Functions