A panel widget which allows users to specify the properties of a Processing parameter. More...

#include <qgsprocessingparameterdefinitionwidget.h>

Inheritance diagram for QgsProcessingParameterDefinitionPanelWidget:

[legend]

Public Member Functions
	QgsProcessingParameterDefinitionPanelWidget (const QString &type, QgsProcessingContext &context, const QgsProcessingParameterWidgetContext &widgetContext, const QgsProcessingParameterDefinition definition=nullptr, const QgsProcessingAlgorithm algorithm=nullptr, QWidget *parent=nullptr)
	Constructor for QgsProcessingParameterDefinitionPanelWidget, 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 widget to the comments 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	QgsProcessingParameterDefinitionDialog

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 widget which allows users to specify the properties of a Processing parameter.

Since: QGIS 4.0

Definition at line 194 of file qgsprocessingparameterdefinitionwidget.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterDefinitionPanelWidget()

QgsProcessingParameterDefinitionPanelWidget::QgsProcessingParameterDefinitionPanelWidget	(	const QString &	type,
		QgsProcessingContext &	context,
		const QgsProcessingParameterWidgetContext &	widgetContext,
		const QgsProcessingParameterDefinition *	definition = nullptr,
		const QgsProcessingAlgorithm *	algorithm = nullptr,
		QWidget *	parent = nullptr )

Constructor for QgsProcessingParameterDefinitionPanelWidget, 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 widget's state.

Additionally, the optional algorithm parameter may be used to specify the algorithm or model associated with the parameter.

Definition at line 163 of file qgsprocessingparameterdefinitionwidget.cpp.

Member Function Documentation

◆ commentColor()

QColor QgsProcessingParameterDefinitionPanelWidget::commentColor ( ) const

Returns the color for the comments for the parameter.

See also: setCommentColor()

Definition at line 232 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ comments()

QString QgsProcessingParameterDefinitionPanelWidget::comments ( ) const

Returns the comments for the parameter.

See also: setComments()

Definition at line 219 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ createParameter()

QgsProcessingParameterDefinition * QgsProcessingParameterDefinitionPanelWidget::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 209 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ registerProcessingContextGenerator()

void QgsProcessingParameterDefinitionPanelWidget::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 244 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ setCommentColor()

void QgsProcessingParameterDefinitionPanelWidget::setCommentColor ( const QColor & color )

Sets the color for the comments for the parameter.

See also: commentColor()

Definition at line 224 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ setComments()

void QgsProcessingParameterDefinitionPanelWidget::setComments ( const QString & comments )

Sets the comments for the parameter.

See also: comments()

Definition at line 214 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ switchToCommentTab()

void QgsProcessingParameterDefinitionPanelWidget::switchToCommentTab ( )

Switches the widget to the comments tab.

Definition at line 237 of file qgsprocessingparameterdefinitionwidget.cpp.

◆ QgsProcessingParameterDefinitionDialog

friend class QgsProcessingParameterDefinitionDialog

friend

Definition at line 263 of file qgsprocessingparameterdefinitionwidget.h.

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

/build/qgis-3.99.0+git20260219+a8f284845db+99sid/src/gui/processing/qgsprocessingparameterdefinitionwidget.h
/build/qgis-3.99.0+git20260219+a8f284845db+99sid/src/gui/processing/qgsprocessingparameterdefinitionwidget.cpp

Public Member Functions

Friends

Additional Inherited Members