QGIS API Documentation  3.17.0-Master (a035f434f4)
Signals | Public Member Functions | List of all members
QgsLayoutItemMapAtlasClippingSettings Class Reference

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

#include <qgslayoutitemmap.h>

Inheritance diagram for QgsLayoutItemMapAtlasClippingSettings:
Inheritance graph
[legend]

Signals

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

Public Member Functions

 QgsLayoutItemMapAtlasClippingSettings (QgsLayoutItemMap *map=nullptr)
 Constructor for QgsLayoutItemMapAtlasClippingSettings, with the specified map parent. More...
 
bool enabled () const
 Returns true if the map content should be clipped to the current atlas feature. More...
 
QgsMapClippingRegion::FeatureClippingType featureClippingType () const
 Returns the feature clipping type to apply when clipping to the current atlas feature. More...
 
bool forceLabelsInsideFeature () const
 Returns true if labels should only be placed inside the atlas feature geometry. More...
 
QList< QgsMapLayer *> layersToClip () const
 Returns the list of map layers to clip to the atlas feature. More...
 
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. More...
 
bool restrictToLayers () const
 Returns true if clipping should be restricted to a subset of layers. More...
 
void setEnabled (bool enabled)
 Sets whether the map content should be clipped to the current atlas feature. More...
 
void setFeatureClippingType (QgsMapClippingRegion::FeatureClippingType type)
 Sets the feature clipping type to apply when clipping to the current atlas feature. More...
 
void setForceLabelsInsideFeature (bool forceInside)
 Sets whether labels should only be placed inside the atlas feature geometry. More...
 
void setLayersToClip (const QList< QgsMapLayer * > &layers)
 Sets the list of map layers to clip to the atlas feature. More...
 
void setRestrictToLayers (bool enabled)
 Sets whether clipping should be restricted to a subset of layers. More...
 
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. More...
 

Detailed Description

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

Since
QGIS 3.16

Definition at line 39 of file qgslayoutitemmap.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemMapAtlasClippingSettings()

QgsLayoutItemMapAtlasClippingSettings::QgsLayoutItemMapAtlasClippingSettings ( QgsLayoutItemMap map = nullptr)

Constructor for QgsLayoutItemMapAtlasClippingSettings, with the specified map parent.

Definition at line 2742 of file qgslayoutitemmap.cpp.

Member Function Documentation

◆ changed

void QgsLayoutItemMapAtlasClippingSettings::changed ( )
signal

Emitted when the atlas clipping settings are changed.

◆ 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 2753 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 2767 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 2781 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 2809 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 2850 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 2795 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 2758 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 2772 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 2786 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 2814 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 2800 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 2820 of file qgslayoutitemmap.cpp.


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