QgsDxfExport::DxfLayer Struct Reference

Encapsulates the properties of a vector layer containing features that will be exported to the DXF file. More...

#include <qgsdxfexport.h>

Public Member Functions
	DxfLayer (QgsVectorLayer *vl, int layerOutputAttributeIndex=-1, bool buildDDBlocks=DEFAULT_DXF_DATA_DEFINED_BLOCKS, int ddBlocksMaxNumberOfClasses=-1, QString overriddenName=QString())
	Constructor for DxfLayer.
bool	buildDataDefinedBlocks () const
	Returns true if data defined point block symbols should be created.
int	dataDefinedBlocksMaximumNumberOfClasses () const
	Returns the maximum number of data defined symbol classes for which blocks are created.
QgsVectorLayer *	layer () const
	Returns the source vector layer.
int	layerOutputAttributeIndex () const
	Returns the attribute index used to split the source layer's features into multiple exported DXF layers.
QString	overriddenName () const
	Returns the overridden layer name to be used in the exported DXF.
QString	splitLayerAttribute () const
	Returns the name of the field used to split the source layer's features into multiple exported DXF layers.

Detailed Description

Encapsulates the properties of a vector layer containing features that will be exported to the DXF file.

Definition at line 76 of file qgsdxfexport.h.

Constructor & Destructor Documentation

DxfLayer()

QgsDxfExport::DxfLayer::DxfLayer ( QgsVectorLayer * vl, int layerOutputAttributeIndex = -1, bool buildDDBlocks = DEFAULT_DXF_DATA_DEFINED_BLOCKS, int ddBlocksMaxNumberOfClasses = -1, QString overriddenName = QString() )

inline

Constructor for DxfLayer.

Parameters

vl	source vector layer
layerOutputAttributeIndex	attribute index used to split the source layer into multiple exported DXF layers, or -1 if no splitting should occur
buildDDBlocks	set to true if data defined point block symbols should be created (since QGIS 3.38)
ddBlocksMaxNumberOfClasses	the maximum number of data defined symbol classes for which blocks are created, or -1 if there is no such limitation (since QGIS 3.38)
overriddenName	the overridden layer name to be used in the exported DXF. If not set, the source vector layer's name will be used. (since QGIS 3.38)

Definition at line 87 of file qgsdxfexport.h.

Member Function Documentation

buildDataDefinedBlocks()

bool QgsDxfExport::DxfLayer::buildDataDefinedBlocks ( ) const

inline

Returns true if data defined point block symbols should be created.

See also

dataDefinedBlocksMaximumNumberOfClasses()

Since

QGIS 3.38

Definition at line 123 of file qgsdxfexport.h.

dataDefinedBlocksMaximumNumberOfClasses()

int QgsDxfExport::DxfLayer::dataDefinedBlocksMaximumNumberOfClasses ( ) const

inline

Returns the maximum number of data defined symbol classes for which blocks are created.

Returns

-1 if there is no such limitation

See also

buildDataDefinedBlocks()

Since

QGIS 3.38

Definition at line 133 of file qgsdxfexport.h.

layer()

QgsVectorLayer * QgsDxfExport::DxfLayer::layer ( ) const

inline

Returns the source vector layer.

Definition at line 96 of file qgsdxfexport.h.

layerOutputAttributeIndex()

int QgsDxfExport::DxfLayer::layerOutputAttributeIndex ( ) const

inline

Returns the attribute index used to split the source layer's features into multiple exported DXF layers.

Each unique value from the associated attribute will form a separate layer in the exported DXF. The attribute value is used for the DXF layer names.

See also

splitLayerAttribute()

Definition at line 105 of file qgsdxfexport.h.

overriddenName()

QString QgsDxfExport::DxfLayer::overriddenName ( ) const

inline

Returns the overridden layer name to be used in the exported DXF.

If not set the source layer's name will be used.

Since

QGIS 3.38

Definition at line 142 of file qgsdxfexport.h.

splitLayerAttribute()

QString QgsDxfExport::DxfLayer::splitLayerAttribute

(

)

const

Returns the name of the field used to split the source layer's features into multiple exported DXF layers.

Each unique value from the associated attribute will form a separate layer in the exported DXF. The attribute value is used for the DXF layer names.

See also

layerOutputAttributeIndex()

Since

QGIS 3.12

Definition at line 2596 of file qgsdxfexport.cpp.

---

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

• /build/qgis-3.99.0+git20260208+357b655ed83+99sid/src/core/dxf/qgsdxfexport.h
• /build/qgis-3.99.0+git20260208+357b655ed83+99sid/src/core/dxf/qgsdxfexport.cpp