Contains settings relating to clipping a layout map by the current atlas feature. More...

#include <qgslayoutitemmap.h>

Inheritance diagram for QgsLayoutItemMapAtlasClippingSettings:

Signals
void	changed ()
	Emitted when the atlas clipping settings are changed.

Public Member Functions
	QgsLayoutItemMapAtlasClippingSettings (QgsLayoutItemMap *map=nullptr)
	Constructor for QgsLayoutItemMapAtlasClippingSettings, with the specified map parent.
bool	clipItemShape () const
	Returns `true` if the map item shape will be clipped to the atlas feature geometry.
bool	enabled () const
	Returns `true` if the map content should be clipped to the current atlas feature.
QgsMapClippingRegion::FeatureClippingType	featureClippingType () const
	Returns the feature clipping type to apply when clipping to the current atlas feature.
bool	forceLabelsInsideFeature () const
	Returns `true` if labels should only be placed inside the atlas feature geometry.
QList< QgsMapLayer * >	layersToClip () const
	Returns the list of map layers to clip to the atlas feature.
bool	readXml (const QDomElement &element, const QDomDocument &doc, const QgsReadWriteContext &context)
	Sets the setting's state from a DOM document, where element is the DOM node corresponding to a 'LayoutMap' tag.
bool	restrictToLayers () const
	Returns `true` if clipping should be restricted to a subset of layers.
void	setClipItemShape (bool clipItemShape)
	Sets whether the map item shape will be clipped to the atlas feature geometry.
void	setEnabled (bool enabled)
	Sets whether the map content should be clipped to the current atlas feature.
void	setFeatureClippingType (QgsMapClippingRegion::FeatureClippingType type)
	Sets the feature clipping type to apply when clipping to the current atlas feature.
void	setForceLabelsInsideFeature (bool forceInside)
	Sets whether labels should only be placed inside the atlas feature geometry.
void	setLayersToClip (const QList< QgsMapLayer * > &layers)
	Sets the list of map layers to clip to the atlas feature.
void	setRestrictToLayers (bool enabled)
	Sets whether clipping should be restricted to a subset of layers.
bool	writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
	Stores settings in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag.

Detailed Description

Contains settings relating to clipping a layout map by the current atlas feature.

Since: QGIS 3.16

Definition at line 41 of file qgslayoutitemmap.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemMapAtlasClippingSettings()

QgsLayoutItemMapAtlasClippingSettings::QgsLayoutItemMapAtlasClippingSettings ( QgsLayoutItemMap * map = nullptr )

Constructor for QgsLayoutItemMapAtlasClippingSettings, with the specified map parent.

Definition at line 3203 of file qgslayoutitemmap.cpp.

Member Function Documentation

◆ changed

void QgsLayoutItemMapAtlasClippingSettings::changed ( )

signal

Emitted when the atlas clipping settings are changed.

◆ clipItemShape()

bool QgsLayoutItemMapAtlasClippingSettings::clipItemShape ( ) const

Returns true if the map item shape will be clipped to the atlas feature geometry.

See also: setClipItemShape()

Since: QGIS 4.0

Definition at line 3256 of file qgslayoutitemmap.cpp.

◆ enabled()

bool QgsLayoutItemMapAtlasClippingSettings::enabled ( ) const

Returns true if the map content should be clipped to the current atlas feature.

See also: setEnabled()

Definition at line 3214 of file qgslayoutitemmap.cpp.

◆ featureClippingType()

QgsMapClippingRegion::FeatureClippingType QgsLayoutItemMapAtlasClippingSettings::featureClippingType ( ) const

Returns the feature clipping type to apply when clipping to the current atlas feature.

See also: setFeatureClippingType()

Definition at line 3228 of file qgslayoutitemmap.cpp.

◆ forceLabelsInsideFeature()

bool QgsLayoutItemMapAtlasClippingSettings::forceLabelsInsideFeature ( ) const

Returns true if labels should only be placed inside the atlas feature geometry.

See also: setForceLabelsInsideFeature()

Definition at line 3242 of file qgslayoutitemmap.cpp.

◆ layersToClip()

QList< QgsMapLayer * > QgsLayoutItemMapAtlasClippingSettings::layersToClip ( ) const

Returns the list of map layers to clip to the atlas feature.

Note: This setting is only used if restrictToLayers() is true.

See also: restrictToLayers(); setLayersToClip()

Definition at line 3284 of file qgslayoutitemmap.cpp.

◆ readXml()

bool QgsLayoutItemMapAtlasClippingSettings::readXml	(	const QDomElement &	element,
		const QDomDocument &	doc,
		const QgsReadWriteContext &	context )

Sets the setting's state from a DOM document, where element is the DOM node corresponding to a 'LayoutMap' tag.

See also: writeXml()

Definition at line 3329 of file qgslayoutitemmap.cpp.

◆ restrictToLayers()

bool QgsLayoutItemMapAtlasClippingSettings::restrictToLayers ( ) const

Returns true if clipping should be restricted to a subset of layers.

See also: layersToClip(); setRestrictToLayers()

Definition at line 3270 of file qgslayoutitemmap.cpp.

◆ setClipItemShape()

void QgsLayoutItemMapAtlasClippingSettings::setClipItemShape ( bool clipItemShape )

Sets whether the map item shape will be clipped to the atlas feature geometry.

See also: clipItemShape()

Since: QGIS 4.0

Definition at line 3261 of file qgslayoutitemmap.cpp.

◆ setEnabled()

void QgsLayoutItemMapAtlasClippingSettings::setEnabled ( bool enabled )

Sets whether the map content should be clipped to the current atlas feature.

See also: enabled()

Definition at line 3219 of file qgslayoutitemmap.cpp.

◆ setFeatureClippingType()

void QgsLayoutItemMapAtlasClippingSettings::setFeatureClippingType ( QgsMapClippingRegion::FeatureClippingType type )

Sets the feature clipping type to apply when clipping to the current atlas feature.

See also: featureClippingType()

Definition at line 3233 of file qgslayoutitemmap.cpp.

◆ setForceLabelsInsideFeature()

void QgsLayoutItemMapAtlasClippingSettings::setForceLabelsInsideFeature ( bool forceInside )

Sets whether labels should only be placed inside the atlas feature geometry.

See also: forceLabelsInsideFeature()

Definition at line 3247 of file qgslayoutitemmap.cpp.

◆ setLayersToClip()

void QgsLayoutItemMapAtlasClippingSettings::setLayersToClip ( const QList< QgsMapLayer * > & layers )

Sets the list of map layers to clip to the atlas feature.

Note: This setting is only used if restrictToLayers() is true.

See also: restrictToLayers(); layersToClip()

Definition at line 3289 of file qgslayoutitemmap.cpp.

◆ setRestrictToLayers()

void QgsLayoutItemMapAtlasClippingSettings::setRestrictToLayers ( bool enabled )

Sets whether clipping should be restricted to a subset of layers.

See also: setLayersToClip(); restrictToLayers()

Definition at line 3275 of file qgslayoutitemmap.cpp.

◆ writeXml()

bool QgsLayoutItemMapAtlasClippingSettings::writeXml	(	QDomElement &	element,
		QDomDocument &	document,
		const QgsReadWriteContext &	context ) const

Stores settings in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag.

See also: readXml()

Definition at line 3295 of file qgslayoutitemmap.cpp.

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

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/layout/qgslayoutitemmap.h
/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/layout/qgslayoutitemmap.cpp

Signals

Public Member Functions