A panel config widget combining parameter settings and comments for a child algorithm in a Processing model. More...

#include <qgsmodelchildalgorithmwidgets.h>

Inheritance diagram for QgsProcessingModelerParametersWidget:

[legend]

Public Member Functions
	QgsProcessingModelerParametersWidget (const QgsProcessingAlgorithm childAlgorithm, QgsProcessingModelAlgorithm model, QgsProcessingContext &context, const QString &childId=QString(), const QVariantMap &configuration=QVariantMap(), QWidget parent=nullptr, QWidget dialog=nullptr)
	Constructor for QgsProcessingModelerParametersWidget.
	~QgsProcessingModelerParametersWidget () override
const QgsProcessingAlgorithm *	algorithm () const
	Returns the algorithm associated with the widget.
QColor	commentColor () const
	Returns the comment's color.
QString	comments () const
	Returns the comment text.
std::unique_ptr< QgsProcessingModelChildAlgorithm >	createAlgorithm ()
	Creates the child algorithm instance, populated with the current widget parameter values and comments.
void	setCommentColor (const QColor &color)
	Sets the comment's color.
void	setComments (const QString &text)
	Sets the comment text.
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 panel 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 widget on the comment editing tab.
Public Member Functions inherited from QgsProcessingModelConfigWidget
	QgsProcessingModelConfigWidget (QWidget *parent=nullptr)
	Constructor for QgsProcessingModelConfigWidget().
Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as an inline panel.
virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.
bool	autoDelete () const
	The the auto delete property on the widget.
void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
bool	dockMode () const
	Returns the dock mode state.
virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required.
virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.
QString	panelTitle () const
	The title of the panel.
void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.
virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.

Friends
class	TestQgsProcessingModelGui

Additional Inherited Members
Public Slots inherited from QgsProcessingModelConfigWidget
void	apply ()
	Applies the widget state to the model component.
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.
void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is `true` this method will emit the showPanel signal for connected slots to handle the open event.
Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.
void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.
void	widgetChanged ()
	Emitted when the widget state changes.
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.
Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

A panel config widget combining 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 134 of file qgsmodelchildalgorithmwidgets.h.

Constructor & Destructor Documentation

◆ QgsProcessingModelerParametersWidget()

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

Constructor for QgsProcessingModelerParametersWidget.

Definition at line 506 of file qgsmodelchildalgorithmwidgets.cpp.

◆ ~QgsProcessingModelerParametersWidget()

QgsProcessingModelerParametersWidget::~QgsProcessingModelerParametersWidget ( )

overridedefault

Member Function Documentation

◆ algorithm()

const QgsProcessingAlgorithm * QgsProcessingModelerParametersWidget::algorithm ( ) const

Returns the algorithm associated with the widget.

Definition at line 519 of file qgsmodelchildalgorithmwidgets.cpp.

◆ commentColor()

QColor QgsProcessingModelerParametersWidget::commentColor ( ) const

Returns the comment's color.

See also: setCommentColor()

Definition at line 593 of file qgsmodelchildalgorithmwidgets.cpp.

◆ comments()

QString QgsProcessingModelerParametersWidget::comments ( ) const

Returns the comment text.

See also: setComments()

Definition at line 580 of file qgsmodelchildalgorithmwidgets.cpp.

◆ createAlgorithm()

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

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

Definition at line 603 of file qgsmodelchildalgorithmwidgets.cpp.

◆ setCommentColor()

void QgsProcessingModelerParametersWidget::setCommentColor ( const QColor & color )

Sets the comment's color.

See also: commentColor()

Definition at line 585 of file qgsmodelchildalgorithmwidgets.cpp.

◆ setComments()

void QgsProcessingModelerParametersWidget::setComments ( const QString & text )

Sets the comment text.

See also: comments()

Definition at line 575 of file qgsmodelchildalgorithmwidgets.cpp.

◆ setStateFromChildAlgorithm()

void QgsProcessingModelerParametersWidget::setStateFromChildAlgorithm ( )

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

Definition at line 598 of file qgsmodelchildalgorithmwidgets.cpp.

◆ setWidgetContext()

void QgsProcessingModelerParametersWidget::setWidgetContext ( const QgsProcessingParameterWidgetContext & context )

Sets the context in which the panel 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 531 of file qgsmodelchildalgorithmwidgets.cpp.

◆ switchToCommentTab()

void QgsProcessingModelerParametersWidget::switchToCommentTab ( )

Focuses the widget on the comment editing tab.

Definition at line 524 of file qgsmodelchildalgorithmwidgets.cpp.

◆ TestQgsProcessingModelGui

friend class TestQgsProcessingModelGui

friend

Definition at line 218 of file qgsmodelchildalgorithmwidgets.h.

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

/build/qgis-4.3.0+git20260902+d57cc4a041c+99sid/src/gui/processing/models/qgsmodelchildalgorithmwidgets.h
/build/qgis-4.3.0+git20260902+d57cc4a041c+99sid/src/gui/processing/models/qgsmodelchildalgorithmwidgets.cpp

Public Member Functions

Friends

Additional Inherited Members