QGIS API Documentation 3.37.0-Master (c2d15952569)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsSnapIndicator Class Reference

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

#include <qgssnapindicator.h>

Public Member Functions

 QgsSnapIndicator (QgsMapCanvas *canvas)
 Constructs an indicator for the given map canvas.
 
 ~QgsSnapIndicator ()
 
bool isVisible () const
 Returns whether the snapping indicator is visible.
 
QgsPointLocator::Match match () const
 Returns currently displayed snapping match.
 
void setMatch (const QgsPointLocator::Match &match)
 Sets snapping match that should be displayed in map canvas. Invalid match hides the indicator.
 
void setVisible (bool visible=true)
 Sets whether the snapping indicator is visible.
 

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::QgsSnapIndicator ( QgsMapCanvas canvas)

Constructs an indicator for the given map canvas.

Definition at line 28 of file qgssnapindicator.cpp.

◆ ~QgsSnapIndicator()

QgsSnapIndicator::~QgsSnapIndicator ( )
default

Member Function Documentation

◆ isVisible()

bool QgsSnapIndicator::isVisible ( ) const

Returns whether the snapping indicator is visible.

Definition at line 112 of file qgssnapindicator.cpp.

◆ match()

QgsPointLocator::Match QgsSnapIndicator::match ( ) const
inline

Returns currently displayed snapping match.

Definition at line 41 of file qgssnapindicator.h.

◆ setMatch()

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.

◆ setVisible()

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: