Stores configuration of snapping settings for the project. More...

#include <qgssnappingconfig.h>

Classes
class	IndividualLayerSettings
	A container of advanced configuration (per layer) of the snapping of the project. More...

Public Types
enum	ScaleDependencyMode { Disabled = 0 , Global = 1 , PerLayer = 2 }
	ScaleDependencyMode the scale dependency mode of snapping. More...
enum	SnappingType { Vertex = 1 , VertexAndSegment = 2 , Segment = 3 }
	SnappingType defines on what object the snapping is performed. More...

Public Member Functions
	QgsSnappingConfig (QgsProject *project=nullptr)
	Constructor with default parameters defined in global settings.
bool	addLayers (const QList< QgsMapLayer * > &layers)
	Adds the specified layers as individual layers to the configuration with standard configuration.
void	clearIndividualLayerSettings ()
	Removes all individual layer snapping settings.
bool	enabled () const
	Returns if snapping is enabled.
QHash< QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings >	individualLayerSettings () const
	Returns individual snapping settings for all layers.
QgsSnappingConfig::IndividualLayerSettings	individualLayerSettings (QgsVectorLayer *vl) const
	Returns individual layer snappings settings (applied if mode is AdvancedConfiguration).
bool	intersectionSnapping () const
	Returns if the snapping on intersection is enabled.
double	maximumScale () const
	Returns the max scale (i.e.
double	minimumScale () const
	Returns the min scale (i.e.
Qgis::SnappingMode	mode () const
	Returns the mode (all layers, active layer, per layer settings).
bool	operator!= (const QgsSnappingConfig &other) const
bool	operator== (const QgsSnappingConfig &other) const
QgsProject *	project () const
	The project from which the snapped layers should be retrieved.
void	readProject (const QDomDocument &doc)
	Reads the configuration from the specified QGIS project document.
bool	removeLayers (const QList< QgsMapLayer * > &layers)
	Removes the specified layers from the individual layer configuration.
void	reset ()
	reset to default values
ScaleDependencyMode	scaleDependencyMode () const
	Returns the scale dependency mode.
bool	selfSnapping () const
	Returns if self snapping (snapping to the currently digitized feature) is enabled.
void	setEnabled (bool enabled)
	enables the snapping
void	setIndividualLayerSettings (QgsVectorLayer *vl, const QgsSnappingConfig::IndividualLayerSettings &individualLayerSettings)
	Sets individual layer snappings settings (applied if mode is AdvancedConfiguration).
void	setIntersectionSnapping (bool enabled)
	Sets if the snapping on intersection is enabled.
void	setMaximumScale (double maxScale)
	Set the max scale on which snapping is enabled, 0.0 disable scale limit.
void	setMinimumScale (double minScale)
	Sets the min scale on which snapping is enabled, 0.0 disable scale limit.
void	setMode (Qgis::SnappingMode mode)
	define the mode of snapping
void	setProject (QgsProject *project)
	The project from which the snapped layers should be retrieved.
void	setScaleDependencyMode (ScaleDependencyMode mode)
	Set the scale dependency mode.
void	setSelfSnapping (bool enabled)
	Sets if self snapping (snapping to the currently digitized feature) is enabled.
void	setTolerance (double tolerance)
	Sets the tolerance.
Q_DECL_DEPRECATED void	setType (QgsSnappingConfig::SnappingType type)
	define the type of snapping
void	setTypeFlag (Qgis::SnappingTypes type)
	define the type of snapping
void	setUnits (Qgis::MapToolUnit units)
	Sets the type of units.
double	tolerance () const
	Returns the tolerance.
Q_DECL_DEPRECATED QgsSnappingConfig::SnappingType	type () const
	Returns the flags type (vertices \| segments \| area \| centroid \| middle).
Qgis::SnappingTypes	typeFlag () const
	Returns the flags type (vertices \| segments \| area \| centroid \| middle).
Qgis::MapToolUnit	units () const
	Returns the type of units.
void	writeProject (QDomDocument &doc)
	Writes the configuration to the specified QGIS project document.

Static Public Member Functions
static Q_DECL_DEPRECATED QIcon	snappingTypeFlagToIcon (Qgis::SnappingType type)
	Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes.
static Q_DECL_DEPRECATED QString	snappingTypeFlagToString (Qgis::SnappingType type)
	Convenient method to return the translated name of the enum type Qgis::SnappingTypes.
static QIcon	snappingTypeToIcon (Qgis::SnappingType type)
	Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes.
static QString	snappingTypeToString (Qgis::SnappingType type)
	Convenient method to returns the translated name of the enum type Qgis::SnappingTypes.

Properties
bool	enabled
Qgis::SnappingMode	mode
QgsProject *	project

Detailed Description

Stores configuration of snapping settings for the project.

Definition at line 36 of file qgssnappingconfig.h.

Member Enumeration Documentation

◆ ScaleDependencyMode

enum QgsSnappingConfig::ScaleDependencyMode

ScaleDependencyMode the scale dependency mode of snapping.

Since: QGIS 3.14

Enumerator
Disabled	No scale dependency.
Global	Scale dependency using global min max range.
PerLayer	Scale dependency using min max range per layer.

Definition at line 64 of file qgssnappingconfig.h.

◆ SnappingType

enum QgsSnappingConfig::SnappingType

SnappingType defines on what object the snapping is performed.

Deprecated: QGIS 3.12. Use Qgis::SnappingTypes instead.

Enumerator
Vertex	On vertices only.
VertexAndSegment	Both on vertices and segments.
Segment	On segments only.

Definition at line 50 of file qgssnappingconfig.h.

Constructor & Destructor Documentation

◆ QgsSnappingConfig()

QgsSnappingConfig::QgsSnappingConfig ( QgsProject * project = nullptr )

explicit

Constructor with default parameters defined in global settings.

Definition at line 172 of file qgssnappingconfig.cpp.

Member Function Documentation

◆ addLayers()

bool QgsSnappingConfig::addLayers ( const QList< QgsMapLayer * > & layers )

Adds the specified layers as individual layers to the configuration with standard configuration.

When implementing a long-living QgsSnappingConfig (like the one in QgsProject) it is best to directly feed this with information from the layer registry.

Returns: true if changes have been done.

Definition at line 596 of file qgssnappingconfig.cpp.

◆ clearIndividualLayerSettings()

void QgsSnappingConfig::clearIndividualLayerSettings ( )

Removes all individual layer snapping settings.

Since: QGIS 3.16

Definition at line 419 of file qgssnappingconfig.cpp.

◆ enabled()

bool QgsSnappingConfig::enabled ( ) const

Returns if snapping is enabled.

Definition at line 239 of file qgssnappingconfig.cpp.

◆ individualLayerSettings() [1/2]

QHash< QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings > QgsSnappingConfig::individualLayerSettings ( ) const

Returns individual snapping settings for all layers.

Definition at line 401 of file qgssnappingconfig.cpp.

◆ individualLayerSettings() [2/2]

QgsSnappingConfig::IndividualLayerSettings QgsSnappingConfig::individualLayerSettings ( QgsVectorLayer * vl ) const

Returns individual layer snappings settings (applied if mode is AdvancedConfiguration).

Definition at line 406 of file qgssnappingconfig.cpp.

◆ intersectionSnapping()

bool QgsSnappingConfig::intersectionSnapping ( ) const

Returns if the snapping on intersection is enabled.

Definition at line 381 of file qgssnappingconfig.cpp.

◆ maximumScale()

double QgsSnappingConfig::maximumScale ( ) const

Returns the max scale (i.e.

most "zoomed in" scale)

Since: QGIS 3.14

Definition at line 727 of file qgssnappingconfig.cpp.

◆ minimumScale()

double QgsSnappingConfig::minimumScale ( ) const

Returns the min scale (i.e.

most "zoomed out" scale)

Since: QGIS 3.14

Definition at line 717 of file qgssnappingconfig.cpp.

◆ mode()

Qgis::SnappingMode QgsSnappingConfig::mode ( ) const

Returns the mode (all layers, active layer, per layer settings).

Definition at line 253 of file qgssnappingconfig.cpp.

◆ operator!=()

bool QgsSnappingConfig::operator!= ( const QgsSnappingConfig & other ) const

Definition at line 433 of file qgssnappingconfig.cpp.

◆ operator==()

bool QgsSnappingConfig::operator== ( const QgsSnappingConfig & other ) const

Definition at line 179 of file qgssnappingconfig.cpp.

◆ project()

QgsProject * QgsSnappingConfig::project ( ) const

The project from which the snapped layers should be retrieved.

Definition at line 702 of file qgssnappingconfig.cpp.

◆ readProject()

void QgsSnappingConfig::readProject ( const QDomDocument & doc )

Reads the configuration from the specified QGIS project document.

Definition at line 446 of file qgssnappingconfig.cpp.

◆ removeLayers()

bool QgsSnappingConfig::removeLayers ( const QList< QgsMapLayer * > & layers )

Removes the specified layers from the individual layer configuration.

When implementing a long-living QgsSnappingConfig (like the one in QgsProject) it is best to directly feed this with information from the layer registry.

Returns: true if changes have been done.

Definition at line 617 of file qgssnappingconfig.cpp.

◆ reset()

void QgsSnappingConfig::reset ( )

reset to default values

Definition at line 194 of file qgssnappingconfig.cpp.

◆ scaleDependencyMode()

QgsSnappingConfig::ScaleDependencyMode QgsSnappingConfig::scaleDependencyMode ( ) const

Returns the scale dependency mode.

Since: QGIS 3.14

Definition at line 742 of file qgssnappingconfig.cpp.

◆ selfSnapping()

bool QgsSnappingConfig::selfSnapping ( ) const

Returns if self snapping (snapping to the currently digitized feature) is enabled.

Since: QGIS 3.14

Definition at line 391 of file qgssnappingconfig.cpp.

◆ setEnabled()

void QgsSnappingConfig::setEnabled ( bool enabled )

enables the snapping

Definition at line 244 of file qgssnappingconfig.cpp.

◆ setIndividualLayerSettings()

void QgsSnappingConfig::setIndividualLayerSettings	(	QgsVectorLayer *	vl,
		const QgsSnappingConfig::IndividualLayerSettings &	individualLayerSettings )

Sets individual layer snappings settings (applied if mode is AdvancedConfiguration).

Definition at line 424 of file qgssnappingconfig.cpp.

◆ setIntersectionSnapping()

void QgsSnappingConfig::setIntersectionSnapping ( bool enabled )

Sets if the snapping on intersection is enabled.

Definition at line 386 of file qgssnappingconfig.cpp.

◆ setMaximumScale()

void QgsSnappingConfig::setMaximumScale ( double maxScale )

Set the max scale on which snapping is enabled, 0.0 disable scale limit.

Since: QGIS 3.14

Definition at line 732 of file qgssnappingconfig.cpp.

◆ setMinimumScale()

void QgsSnappingConfig::setMinimumScale ( double minScale )

Sets the min scale on which snapping is enabled, 0.0 disable scale limit.

Since: QGIS 3.14

Definition at line 722 of file qgssnappingconfig.cpp.

◆ setMode()

void QgsSnappingConfig::setMode ( Qgis::SnappingMode mode )

define the mode of snapping

Definition at line 258 of file qgssnappingconfig.cpp.

◆ setProject()

void QgsSnappingConfig::setProject ( QgsProject * project )

The project from which the snapped layers should be retrieved.

Definition at line 707 of file qgssnappingconfig.cpp.

◆ setScaleDependencyMode()

void QgsSnappingConfig::setScaleDependencyMode ( QgsSnappingConfig::ScaleDependencyMode mode )

Set the scale dependency mode.

Since: QGIS 3.14

Definition at line 737 of file qgssnappingconfig.cpp.

◆ setSelfSnapping()

void QgsSnappingConfig::setSelfSnapping ( bool enabled )

Sets if self snapping (snapping to the currently digitized feature) is enabled.

Since: QGIS 3.14

Definition at line 396 of file qgssnappingconfig.cpp.

◆ setTolerance()

void QgsSnappingConfig::setTolerance ( double tolerance )

Sets the tolerance.

Definition at line 358 of file qgssnappingconfig.cpp.

◆ setType()

void QgsSnappingConfig::setType ( QgsSnappingConfig::SnappingType type )

define the type of snapping

Deprecated: QGIS 3.12. Use setTypeFlag() instead.

Definition at line 326 of file qgssnappingconfig.cpp.

◆ setTypeFlag()

void QgsSnappingConfig::setTypeFlag ( Qgis::SnappingTypes type )

define the type of snapping

Since: QGIS 3.12

Definition at line 344 of file qgssnappingconfig.cpp.

◆ setUnits()

void QgsSnappingConfig::setUnits ( Qgis::MapToolUnit units )

Sets the type of units.

Definition at line 372 of file qgssnappingconfig.cpp.

◆ snappingTypeFlagToIcon()

Q_DECL_DEPRECATED QIcon QgsSnappingConfig::snappingTypeFlagToIcon ( Qgis::SnappingType type )

inlinestatic

Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes.

Deprecated: QGIS 3.26. Use snappingTypeToIcon() instead.

Since: QGIS 3.20

Definition at line 101 of file qgssnappingconfig.h.

◆ snappingTypeFlagToString()

Q_DECL_DEPRECATED QString QgsSnappingConfig::snappingTypeFlagToString ( Qgis::SnappingType type )

inlinestatic

Convenient method to return the translated name of the enum type Qgis::SnappingTypes.

Since: QGIS 3.12

Deprecated: QGIS 3.26. Use snappingTypeToString() instead.

Definition at line 85 of file qgssnappingconfig.h.

◆ snappingTypeToIcon()

QIcon QgsSnappingConfig::snappingTypeToIcon ( Qgis::SnappingType type )

static

Convenient method to return an icon corresponding to the enum type Qgis::SnappingTypes.

Since: QGIS 3.20

Definition at line 304 of file qgssnappingconfig.cpp.

◆ snappingTypeToString()

QString QgsSnappingConfig::snappingTypeToString ( Qgis::SnappingType type )

static

Convenient method to returns the translated name of the enum type Qgis::SnappingTypes.

Since: QGIS 3.26

Definition at line 282 of file qgssnappingconfig.cpp.

◆ tolerance()

double QgsSnappingConfig::tolerance ( ) const

Returns the tolerance.

Definition at line 353 of file qgssnappingconfig.cpp.

◆ type()

QgsSnappingConfig::SnappingType QgsSnappingConfig::type ( ) const

Returns the flags type (vertices | segments | area | centroid | middle).

Deprecated: QGIS 3.12. Use typeFlag() instead.

Definition at line 272 of file qgssnappingconfig.cpp.

◆ typeFlag()

Qgis::SnappingTypes QgsSnappingConfig::typeFlag ( ) const

Returns the flags type (vertices | segments | area | centroid | middle).

Since: QGIS 3.12

Definition at line 267 of file qgssnappingconfig.cpp.

◆ units()

Qgis::MapToolUnit QgsSnappingConfig::units ( ) const

Returns the type of units.

Definition at line 367 of file qgssnappingconfig.cpp.

◆ writeProject()

void QgsSnappingConfig::writeProject ( QDomDocument & doc )

Writes the configuration to the specified QGIS project document.

Definition at line 561 of file qgssnappingconfig.cpp.

Property Documentation

◆ enabled

bool QgsSnappingConfig::enabled

readwrite

Definition at line 41 of file qgssnappingconfig.h.

◆ mode

Qgis::SnappingMode QgsSnappingConfig::mode

readwrite

Definition at line 42 of file qgssnappingconfig.h.

◆ project

QgsProject * QgsSnappingConfig::project

readwrite

Definition at line 40 of file qgssnappingconfig.h.

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

/build/qgis-3.99.0+git20260128+d270888f95f+99sid/src/core/qgssnappingconfig.h
/build/qgis-3.99.0+git20260128+d270888f95f+99sid/src/core/qgssnappingconfig.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ ScaleDependencyMode

◆ SnappingType

Constructor & Destructor Documentation

◆ QgsSnappingConfig()

Member Function Documentation

◆ addLayers()

◆ clearIndividualLayerSettings()

◆ enabled()

◆ individualLayerSettings() [1/2]

◆ individualLayerSettings() [2/2]

◆ intersectionSnapping()

◆ maximumScale()

◆ minimumScale()

◆ mode()

◆ operator!=()

◆ operator==()

◆ project()

◆ readProject()

◆ removeLayers()

◆ reset()

◆ scaleDependencyMode()

◆ selfSnapping()

◆ setEnabled()

◆ setIndividualLayerSettings()

◆ setIntersectionSnapping()

◆ setMaximumScale()

◆ setMinimumScale()

◆ setMode()

◆ setProject()

◆ setScaleDependencyMode()

◆ setSelfSnapping()

◆ setTolerance()

◆ setType()

◆ setTypeFlag()

◆ setUnits()

◆ snappingTypeFlagToIcon()

◆ snappingTypeFlagToString()

◆ snappingTypeToIcon()

◆ snappingTypeToString()

◆ tolerance()

◆ type()

◆ typeFlag()

◆ units()

◆ writeProject()

Property Documentation

◆ enabled

◆ mode

◆ project