QGIS/python/gui/auto_generated/processing/qgsprocessingguiutils.sip.in
Nyall Dawson b8c4eb0425 Add since
2025-06-06 09:43:35 +10:00

84 lines
2.7 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingguiutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProcessingGuiUtils
{
%Docstring(signature="appended")
Contains utility functions relating to Processing GUI components.
.. warning::
This is not considered stable API, and is exposed to Python for internal use only.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsprocessingguiutils.h"
%End
public:
class ResultLayerDetails
{
%Docstring(signature="appended")
Contains details of a layer result from running an algorithm.
.. versionadded:: 3.44
%End
%TypeHeaderCode
#include "qgsprocessingguiutils.h"
%End
public:
ResultLayerDetails( QgsMapLayer *layer /Transfer/ );
%Docstring
Constructor for ResultLayerDetails.
Takes ownership of ``layer``.
%End
QgsMapLayer *layer;
QgsLayerTreeGroup *targetLayerTreeGroup;
int sortKey;
QgsProject *destinationProject;
};
static void configureResultLayerTreeLayer( QgsLayerTreeLayer *layerTreeLayer );
%Docstring
Applies post-processing steps to the :py:class:`QgsLayerTreeLayer`
created for an algorithm's output.
%End
static QgsLayerTreeGroup *layerTreeResultsGroup( const QgsProcessingContext::LayerDetails &layerDetails, const QgsProcessingContext &context );
%Docstring
Returns the destination layer tree group to store results in, or
``None`` if there is no specific destination tree group associated with
the layer.
%End
static void addResultLayers( const QVector< QgsProcessingGuiUtils::ResultLayerDetails > &layers, const QgsProcessingContext &context, QgsLayerTreeView *view = 0 );
%Docstring
Responsible for adding layers created by an algorithm to a project and
the project's layer tree in the correct location.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingguiutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/