QGIS API Documentation  3.15.0-Master (a49cb7c9f3)
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. 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.

Since
QGIS 3.0

Definition at line 32 of file qgssnapindicator.h.

Constructor & Destructor Documentation

◆ QgsSnapIndicator()

QgsSnapIndicator::QgsSnapIndicator ( QgsMapCanvas canvas)

Constructs an indicator for the given map canvas.

Definition at line 27 of file qgssnapindicator.cpp.

◆ ~QgsSnapIndicator()

QgsSnapIndicator::~QgsSnapIndicator ( )

Definition at line 41 of file qgssnapindicator.cpp.

Member Function Documentation

◆ isVisible()

bool QgsSnapIndicator::isVisible ( ) const

Returns whether the snapping indicator is visible.

Definition at line 127 of file qgssnapindicator.cpp.

◆ match()

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

Returns currently displayed snapping match.

Definition at line 42 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 52 of file qgssnapindicator.cpp.

◆ setVisible()

void QgsSnapIndicator::setVisible ( bool  visible = true)

Sets whether the snapping indicator is visible.

Definition at line 121 of file qgssnapindicator.cpp.


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