Class that shows snapping marker on map canvas for the current snapping match. More...

Public Member Functions
	QgsSnapIndicator (QgsMapCanvas *canvas)
	Constructs an indicator for the given map canvas. More...

	~QgsSnapIndicator ()

bool	isVisible () const
	Returns whether the snapping indicator is visible. More...

QgsPointLocator::Match	match () const
	Returns currently displayed snapping match. More...

void	setMatch (const QgsPointLocator::Match &match)
	Sets snapping match that should be displayed in map canvas. Invalid match hides the indicator. More...

void	setVisible (bool visible=true)
	Sets whether the snapping indicator is visible. More...

Detailed Description

Class that shows snapping marker on map canvas for the current snapping match.

Definition at line 31 of file qgssnapindicator.h.

Constructor & Destructor Documentation

QgsSnapIndicator::QgsSnapIndicator ( QgsMapCanvas * canvas )

Constructs an indicator for the given map canvas.

Definition at line 28 of file qgssnapindicator.cpp.

QgsSnapIndicator::~QgsSnapIndicator ( )

default

bool QgsSnapIndicator::isVisible ( ) const

Returns whether the snapping indicator is visible.

Definition at line 112 of file qgssnapindicator.cpp.

QgsPointLocator::Match QgsSnapIndicator::match ( ) const

inline

Returns currently displayed snapping match.

Definition at line 41 of file qgssnapindicator.h.

void QgsSnapIndicator::setMatch ( const QgsPointLocator::Match & match )

Sets snapping match that should be displayed in map canvas. Invalid match hides the indicator.

Definition at line 36 of file qgssnapindicator.cpp.

void QgsSnapIndicator::setVisible ( bool visible = true )

Sets whether the snapping indicator is visible.

Definition at line 106 of file qgssnapindicator.cpp.

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

/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/qgssnapindicator.h
/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/qgssnapindicator.cpp