Contains settings which reflect the context in which a Processing parameter widget is shown. More...

#include <qgsprocessingwidgetcontext.h>

Public Member Functions
	QgsProcessingParameterWidgetContext ()=default
QgsMapLayer *	activeLayer () const
	Returns the current active layer.
QgsBrowserGuiModel *	browserModel () const
	Returns the browser model associated with the widget.
QgsMapCanvas *	mapCanvas () const
	Returns the map canvas associated with the widget.
QgsMessageBar *	messageBar () const
	Returns the message bar associated with the widget.
QgsProcessingModelAlgorithm *	model () const
	Returns the model which the parameter widget is associated with.
QString	modelChildAlgorithmId () const
	Returns the child algorithm ID within the model which the parameter widget is associated with.
QgsModelDesignerDialog *	modelDesignerDialog () const
	Returns the associated model designer dialog, if applicable.
QgsProcessingContextGenerator *	processingContextGenerator ()
	Returns the Processing context generator class that will be used to retrieve a Processing context for the widget when required.
QgsProject *	project () const
	Returns the project associated with the widget.
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	setActiveLayer (QgsMapLayer *layer)
	Sets the current active layer.
void	setBrowserModel (QgsBrowserGuiModel *model)
	Sets the browser model associated with the widget.
void	setMapCanvas (QgsMapCanvas *canvas)
	Sets the map canvas associated with the widget.
void	setMessageBar (QgsMessageBar *bar)
	Sets the message bar associated with the widget.
void	setModel (QgsProcessingModelAlgorithm *model)
	Sets the model which the parameter widget is associated with.
void	setModelChildAlgorithmId (const QString &id)
	Sets the child algorithm id within the model which the parameter widget is associated with.
void	setModelDesignerDialog (QgsModelDesignerDialog *dialog)
	Sets the associated model designer dialog, if applicable.
void	setProject (QgsProject *project)
	Sets the project associated with the widget.

Detailed Description

Contains settings which reflect the context in which a Processing parameter widget is shown.

For instance, the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior.

Since: QGIS 3.4

Definition at line 49 of file qgsprocessingwidgetcontext.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterWidgetContext()

QgsProcessingParameterWidgetContext::QgsProcessingParameterWidgetContext ( )

default

Member Function Documentation

◆ activeLayer()

QgsMapLayer * QgsProcessingParameterWidgetContext::activeLayer ( ) const

Returns the current active layer.

See also: setActiveLayer()

Since: QGIS 3.14

Definition at line 82 of file qgsprocessingwidgetcontext.cpp.

◆ browserModel()

QgsBrowserGuiModel * QgsProcessingParameterWidgetContext::browserModel ( ) const

Returns the browser model associated with the widget.

See also: setBrowserModel()

Since: QGIS 3.12

Definition at line 57 of file qgsprocessingwidgetcontext.cpp.

◆ mapCanvas()

QgsMapCanvas * QgsProcessingParameterWidgetContext::mapCanvas ( ) const

Returns the map canvas associated with the widget.

See also: setMapCanvas()

Definition at line 37 of file qgsprocessingwidgetcontext.cpp.

◆ messageBar()

QgsMessageBar * QgsProcessingParameterWidgetContext::messageBar ( ) const

Returns the message bar associated with the widget.

This allows the widget to push feedback messages to the user.

See also: setMessageBar()

Since: QGIS 3.12

Definition at line 47 of file qgsprocessingwidgetcontext.cpp.

◆ model()

QgsProcessingModelAlgorithm * QgsProcessingParameterWidgetContext::model ( ) const

Returns the model which the parameter widget is associated with.

See also: setModel(); modelChildAlgorithmId()

Definition at line 112 of file qgsprocessingwidgetcontext.cpp.

◆ modelChildAlgorithmId()

QString QgsProcessingParameterWidgetContext::modelChildAlgorithmId ( ) const

Returns the child algorithm ID within the model which the parameter widget is associated with.

See also: setModelChildAlgorithmId(); model()

Definition at line 72 of file qgsprocessingwidgetcontext.cpp.

◆ modelDesignerDialog()

QgsModelDesignerDialog * QgsProcessingParameterWidgetContext::modelDesignerDialog ( ) const

Returns the associated model designer dialog, if applicable.

Warning: This method is not considered stable API

See also: setModelDesignerDialog()

Since: QGIS 4.0

Definition at line 102 of file qgsprocessingwidgetcontext.cpp.

◆ processingContextGenerator()

QgsProcessingContextGenerator * QgsProcessingParameterWidgetContext::processingContextGenerator ( )

Returns the Processing context generator class that will be used to retrieve a Processing context for the widget when required.

See also: registerProcessingContextGenerator()

Since: QGIS 4.0

Definition at line 97 of file qgsprocessingwidgetcontext.cpp.

◆ project()

QgsProject * QgsProcessingParameterWidgetContext::project ( ) const

Returns the project associated with the widget.

See also: setProject()

Definition at line 67 of file qgsprocessingwidgetcontext.cpp.

◆ registerProcessingContextGenerator()

void QgsProcessingParameterWidgetContext::registerProcessingContextGenerator ( QgsProcessingContextGenerator * generator )

Registers a Processing context generator class that will be used to retrieve a Processing context for the widget when required.

The generator must exist for the lifetime of the widget, ownership is not transferred.

See also: processingContextGenerator()

Since: QGIS 4.0

Definition at line 92 of file qgsprocessingwidgetcontext.cpp.

◆ setActiveLayer()

void QgsProcessingParameterWidgetContext::setActiveLayer ( QgsMapLayer * layer )

Sets the current active layer.

See also: activeLayer()

Since: QGIS 3.14

Definition at line 87 of file qgsprocessingwidgetcontext.cpp.

◆ setBrowserModel()

void QgsProcessingParameterWidgetContext::setBrowserModel ( QgsBrowserGuiModel * model )

Sets the browser model associated with the widget.

This will usually be the shared app instance of the browser model

See also: browserModel()

Since: QGIS 3.14

Definition at line 52 of file qgsprocessingwidgetcontext.cpp.

◆ setMapCanvas()

void QgsProcessingParameterWidgetContext::setMapCanvas ( QgsMapCanvas * canvas )

Sets the map canvas associated with the widget.

This allows the widget to retrieve the current map scale and other properties from the canvas.

See also: mapCanvas()

Definition at line 32 of file qgsprocessingwidgetcontext.cpp.

◆ setMessageBar()

void QgsProcessingParameterWidgetContext::setMessageBar ( QgsMessageBar * bar )

Sets the message bar associated with the widget.

This allows the widget to push feedback messages to the user.

See also: messageBar()

Since: QGIS 3.12

Definition at line 42 of file qgsprocessingwidgetcontext.cpp.

◆ setModel()

void QgsProcessingParameterWidgetContext::setModel ( QgsProcessingModelAlgorithm * model )

Sets the model which the parameter widget is associated with.

See also: model(); setModelChildAlgorithmId()

Definition at line 117 of file qgsprocessingwidgetcontext.cpp.

◆ setModelChildAlgorithmId()

void QgsProcessingParameterWidgetContext::setModelChildAlgorithmId ( const QString & id )

Sets the child algorithm id within the model which the parameter widget is associated with.

See also: modelChildAlgorithmId(); setModel()

Definition at line 77 of file qgsprocessingwidgetcontext.cpp.

◆ setModelDesignerDialog()

void QgsProcessingParameterWidgetContext::setModelDesignerDialog ( QgsModelDesignerDialog * dialog )

Sets the associated model designer dialog, if applicable.

Warning: This method is not considered stable API

See also: modelDesignerDialog()

Since: QGIS 4.0

Definition at line 107 of file qgsprocessingwidgetcontext.cpp.

◆ setProject()

void QgsProcessingParameterWidgetContext::setProject ( QgsProject * project )

Sets the project associated with the widget.

This allows the widget to retrieve the map layers and other properties from the correct project.

See also: project()

Since: QGIS 3.8

Definition at line 62 of file qgsprocessingwidgetcontext.cpp.

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

/build/qgis-4.3.0+git20260828+4a47d6a9bb1+99sid/src/gui/processing/qgsprocessingwidgetcontext.h
/build/qgis-4.3.0+git20260828+4a47d6a9bb1+99sid/src/gui/processing/qgsprocessingwidgetcontext.cpp

Public Member Functions