QGIS API Documentation 3.41.0-Master (45a0abf3bec)
|
Contains settings relating to clipping a layout map by another layout item. More...
#include <qgslayoutitemmap.h>
Signals | |
void | changed () |
Emitted when the item clipping settings are changed. | |
Public Member Functions | |
QgsLayoutItemMapItemClipPathSettings (QgsLayoutItemMap *map=nullptr) | |
Constructor for QgsLayoutItemMapItemClipPathSettings, with the specified map parent. | |
QgsGeometry | clipPathInMapItemCoordinates () const |
Returns the clipping path geometry, in the map item's coordinate space. | |
QgsGeometry | clippedMapExtent () const |
Returns the geometry to use for clipping the parent map, in the map item's CRS. | |
bool | enabled () const |
Returns true if the map content should be clipped to the associated item. | |
QgsMapClippingRegion::FeatureClippingType | featureClippingType () const |
Returns the feature clipping type to apply when clipping to the associated item. | |
void | finalizeRestoreFromXml () |
To be called after all pending items have been restored from XML. | |
bool | forceLabelsInsideClipPath () const |
Returns true if labels should only be placed inside the clip path geometry. | |
bool | isActive () const |
Returns true if the item clipping is enabled and set to a valid source item. | |
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. | |
void | setEnabled (bool enabled) |
Sets whether the map content should be clipped to the associated item. | |
void | setFeatureClippingType (QgsMapClippingRegion::FeatureClippingType type) |
Sets the feature clipping type to apply when clipping to the associated item. | |
void | setForceLabelsInsideClipPath (bool forceInside) |
Sets whether labels should only be placed inside the clip path geometry. | |
void | setSourceItem (QgsLayoutItem *item) |
Sets the source item which will provide the clipping path for the map. | |
QgsLayoutItem * | sourceItem () |
Returns the source item which will provide the clipping path for the map, or nullptr if no item is set. | |
QgsMapClippingRegion | toMapClippingRegion () const |
Returns the clip path as a map clipping region. | |
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. | |
Contains settings relating to clipping a layout map by another layout item.
Definition at line 170 of file qgslayoutitemmap.h.
QgsLayoutItemMapItemClipPathSettings::QgsLayoutItemMapItemClipPathSettings | ( | QgsLayoutItemMap * | map = nullptr | ) |
Constructor for QgsLayoutItemMapItemClipPathSettings, with the specified map parent.
Definition at line 3216 of file qgslayoutitemmap.cpp.
|
signal |
Emitted when the item clipping settings are changed.
QgsGeometry QgsLayoutItemMapItemClipPathSettings::clipPathInMapItemCoordinates | ( | ) | const |
Returns the clipping path geometry, in the map item's coordinate space.
Definition at line 3258 of file qgslayoutitemmap.cpp.
QgsGeometry QgsLayoutItemMapItemClipPathSettings::clippedMapExtent | ( | ) | const |
Returns the geometry to use for clipping the parent map, in the map item's CRS.
Definition at line 3247 of file qgslayoutitemmap.cpp.
bool QgsLayoutItemMapItemClipPathSettings::enabled | ( | ) | const |
Returns true
if the map content should be clipped to the associated item.
Definition at line 3227 of file qgslayoutitemmap.cpp.
QgsMapClippingRegion::FeatureClippingType QgsLayoutItemMapItemClipPathSettings::featureClippingType | ( | ) | const |
Returns the feature clipping type to apply when clipping to the associated item.
Definition at line 3318 of file qgslayoutitemmap.cpp.
void QgsLayoutItemMapItemClipPathSettings::finalizeRestoreFromXml | ( | ) |
To be called after all pending items have been restored from XML.
Definition at line 3373 of file qgslayoutitemmap.cpp.
bool QgsLayoutItemMapItemClipPathSettings::forceLabelsInsideClipPath | ( | ) | const |
Returns true
if labels should only be placed inside the clip path geometry.
Definition at line 3332 of file qgslayoutitemmap.cpp.
bool QgsLayoutItemMapItemClipPathSettings::isActive | ( | ) | const |
Returns true
if the item clipping is enabled and set to a valid source item.
Definition at line 3222 of file qgslayoutitemmap.cpp.
bool QgsLayoutItemMapItemClipPathSettings::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.
Definition at line 3361 of file qgslayoutitemmap.cpp.
void QgsLayoutItemMapItemClipPathSettings::setEnabled | ( | bool | enabled | ) |
Sets whether the map content should be clipped to the associated item.
Definition at line 3232 of file qgslayoutitemmap.cpp.
void QgsLayoutItemMapItemClipPathSettings::setFeatureClippingType | ( | QgsMapClippingRegion::FeatureClippingType | type | ) |
Sets the feature clipping type to apply when clipping to the associated item.
Definition at line 3323 of file qgslayoutitemmap.cpp.
void QgsLayoutItemMapItemClipPathSettings::setForceLabelsInsideClipPath | ( | bool | forceInside | ) |
Sets whether labels should only be placed inside the clip path geometry.
Definition at line 3337 of file qgslayoutitemmap.cpp.
void QgsLayoutItemMapItemClipPathSettings::setSourceItem | ( | QgsLayoutItem * | item | ) |
Sets the source item which will provide the clipping path for the map.
The specified item must return the QgsLayoutItem::FlagProvidesClipPath flag.
Definition at line 3276 of file qgslayoutitemmap.cpp.
QgsLayoutItem * QgsLayoutItemMapItemClipPathSettings::sourceItem | ( | ) |
Returns the source item which will provide the clipping path for the map, or nullptr
if no item is set.
Definition at line 3313 of file qgslayoutitemmap.cpp.
QgsMapClippingRegion QgsLayoutItemMapItemClipPathSettings::toMapClippingRegion | ( | ) | const |
Returns the clip path as a map clipping region.
Definition at line 3269 of file qgslayoutitemmap.cpp.
bool QgsLayoutItemMapItemClipPathSettings::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.
Definition at line 3346 of file qgslayoutitemmap.cpp.