Contains utility functions relating to Processing GUI components. More...

Classes
class	ResultLayerDetails
	Contains details of a layer result from running an algorithm. More...

Static Public Member Functions
static void	addResultLayers (const QVector< QgsProcessingGuiUtils::ResultLayerDetails > &layers, const QgsProcessingContext &context, QgsLayerTreeView *view=nullptr)
	Responsible for adding layers created by an algorithm to a project and the project's layer tree in the correct location.

static void	configureResultLayerTreeLayer (QgsLayerTreeLayer *layerTreeLayer)
	Applies post-processing steps to the QgsLayerTreeLayer created for an algorithm's output.

static QgsLayerTreeGroup *	layerTreeResultsGroup (const QgsProcessingContext::LayerDetails &layerDetails, const QgsProcessingContext &context)
	Returns the destination layer tree group to store results in, or `nullptr` if there is no specific destination tree group associated with the layer.

Detailed Description

Contains utility functions relating to Processing GUI components.

Warning: This is not considered stable API, and is exposed to Python for internal use only.

Definition at line 36 of file qgsprocessingguiutils.h.

Member Function Documentation

void QgsProcessingGuiUtils::addResultLayers	(	const QVector< QgsProcessingGuiUtils::ResultLayerDetails > &	layers,
		const QgsProcessingContext &	context,
		QgsLayerTreeView *	view = `nullptr`
	)

static

Responsible for adding layers created by an algorithm to a project and the project's layer tree in the correct location.

Definition at line 87 of file qgsprocessingguiutils.cpp.

void QgsProcessingGuiUtils::configureResultLayerTreeLayer ( QgsLayerTreeLayer * layerTreeLayer )

static

Applies post-processing steps to the QgsLayerTreeLayer created for an algorithm's output.

Definition at line 23 of file qgsprocessingguiutils.cpp.

QgsLayerTreeGroup * QgsProcessingGuiUtils::layerTreeResultsGroup	(	const QgsProcessingContext::LayerDetails &	layerDetails,
		const QgsProcessingContext &	context
	)

static

Returns the destination layer tree group to store results in, or nullptr if there is no specific destination tree group associated with the layer.

Definition at line 37 of file qgsprocessingguiutils.cpp.

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

/build/qgis-3.99.0+git20250704+a26b91b364d+99sid/src/gui/processing/qgsprocessingguiutils.h
/build/qgis-3.99.0+git20250704+a26b91b364d+99sid/src/gui/processing/qgsprocessingguiutils.cpp