QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Details for layers to load into projects. More...
#include <qgsprocessingcontext.h>
Public Member Functions | |
LayerDetails ()=default | |
LayerDetails (const QString &name, QgsProject *project, const QString &outputName=QString(), QgsProcessingUtils::LayerHint layerTypeHint=QgsProcessingUtils::LayerHint::UnknownType) | |
Constructor for LayerDetails. | |
QgsProcessingLayerPostProcessorInterface * | postProcessor () const |
Layer post-processor. | |
void | setOutputLayerName (QgsMapLayer *layer) const |
Sets a layer name to match this output, respecting any local user settings which affect this name. | |
void | setPostProcessor (QgsProcessingLayerPostProcessorInterface *processor) |
Sets the layer post-processor. | |
Public Attributes | |
bool | forceName = false |
Set to true if LayerDetails::name should always be used as the loaded layer name, regardless of the user's local Processing settings. | |
QString | groupName |
Optional name for a layer tree group under which to place the layer when loading it into a project. | |
int | layerSortKey = 0 |
Optional sorting key for sorting output layers when loading them into a project. | |
QgsProcessingUtils::LayerHint | layerTypeHint = QgsProcessingUtils::LayerHint::UnknownType |
Layer type hint. | |
QString | name |
Friendly name for layer, possibly for use when loading layer into project. | |
QString | outputName |
Associated output name from algorithm which generated the layer. | |
QgsProject * | project = nullptr |
Destination project. | |
Details for layers to load into projects.
Definition at line 247 of file qgsprocessingcontext.h.
|
inline |
Constructor for LayerDetails.
Definition at line 254 of file qgsprocessingcontext.h.
|
default |
QgsProcessingLayerPostProcessorInterface * QgsProcessingContext::LayerDetails::postProcessor | ( | ) | const |
Layer post-processor.
May be nullptr
if no post-processing is required.
Definition at line 264 of file qgsprocessingcontext.cpp.
void QgsProcessingContext::LayerDetails::setOutputLayerName | ( | QgsMapLayer * | layer | ) | const |
Sets a layer name to match this output, respecting any local user settings which affect this name.
Definition at line 277 of file qgsprocessingcontext.cpp.
void QgsProcessingContext::LayerDetails::setPostProcessor | ( | QgsProcessingLayerPostProcessorInterface * | processor | ) |
Sets the layer post-processor.
May be nullptr
if no post-processing is required.
Ownership of processor is transferred.
Definition at line 269 of file qgsprocessingcontext.cpp.
bool QgsProcessingContext::LayerDetails::forceName = false |
Set to true
if LayerDetails::name should always be used as the loaded layer name, regardless of the user's local Processing settings.
Definition at line 276 of file qgsprocessingcontext.h.
QString QgsProcessingContext::LayerDetails::groupName |
Optional name for a layer tree group under which to place the layer when loading it into a project.
Definition at line 288 of file qgsprocessingcontext.h.
int QgsProcessingContext::LayerDetails::layerSortKey = 0 |
Optional sorting key for sorting output layers when loading them into a project.
Layers with a greater sort key will be placed over layers with a lesser sort key.
Definition at line 297 of file qgsprocessingcontext.h.
QgsProcessingUtils::LayerHint QgsProcessingContext::LayerDetails::layerTypeHint = QgsProcessingUtils::LayerHint::UnknownType |
QString QgsProcessingContext::LayerDetails::name |
Friendly name for layer, possibly for use when loading layer into project.
Definition at line 269 of file qgsprocessingcontext.h.
QString QgsProcessingContext::LayerDetails::outputName |
Associated output name from algorithm which generated the layer.
Definition at line 281 of file qgsprocessingcontext.h.
QgsProject* QgsProcessingContext::LayerDetails::project = nullptr |
Destination project.
Definition at line 331 of file qgsprocessingcontext.h.