QgsProcessingParameterWidgetContext Class Reference

Contains settings which reflect the context in which a Processing parameter widget 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. More...

#include <qgsprocessingwidgetwrapper.h>

Public Member Functions
	QgsProcessingParameterWidgetContext ()=default
	Constructor for QgsProcessingParameterWidgetContext. More...
QgsMapCanvas *	mapCanvas () const
	Returns the map canvas associated with the widget. More...
QgsProcessingModelAlgorithm *	model () const
	Returns the model which the parameter widget is associated with. More...
QString	modelChildAlgorithmId () const
	Returns the child algorithm ID within the model which the parameter widget is associated with. More...
void	setMapCanvas (QgsMapCanvas *canvas)
	Sets the map canvas associated with the widget. More...
void	setModel (QgsProcessingModelAlgorithm *model)
	Sets the model which the parameter widget is associated with. More...
void	setModelChildAlgorithmId (const QString &id)
	Sets the child algorithm id within the model which the parameter widget is associated with. More...

Detailed Description

Contains settings which reflect the context in which a Processing parameter widget 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.

Since

QGIS 3.4

Definition at line 73 of file qgsprocessingwidgetwrapper.h.

Constructor & Destructor Documentation

QgsProcessingParameterWidgetContext::QgsProcessingParameterWidgetContext ( )

default

Constructor for QgsProcessingParameterWidgetContext.

Member Function Documentation

QgsMapCanvas * QgsProcessingParameterWidgetContext::mapCanvas

(

)

const

Returns the map canvas associated with the widget.

See also

setMapCanvas()

Definition at line 37 of file qgsprocessingwidgetwrapper.cpp.

QgsProcessingModelAlgorithm * QgsProcessingParameterWidgetContext::model

(

)

const

Returns the model which the parameter widget is associated with.

See also

setModel()

modelChildAlgorithmId()

Definition at line 52 of file qgsprocessingwidgetwrapper.cpp.

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 42 of file qgsprocessingwidgetwrapper.cpp.

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 qgsprocessingwidgetwrapper.cpp.

void QgsProcessingParameterWidgetContext::setModel

(

QgsProcessingModelAlgorithm *

model

)

Sets the model which the parameter widget is associated with.

See also

model()

setModelChildAlgorithmId()

Definition at line 57 of file qgsprocessingwidgetwrapper.cpp.

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 47 of file qgsprocessingwidgetwrapper.cpp.

---

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

• /build/qgis-3.4.15+24xenial/src/gui/processing/qgsprocessingwidgetwrapper.h
• /build/qgis-3.4.15+24xenial/src/gui/processing/qgsprocessingwidgetwrapper.cpp