QgsAdvancedDigitizingTool Class Reference

An abstract class for advanced digitizing tools. More...

#include <qgsadvanceddigitizingtools.h>

Inheritance diagram for QgsAdvancedDigitizingTool:

Signals
void	paintRequested ()
	Requests a new painting event to the advanced digitizing canvas item.

Public Member Functions
	QgsAdvancedDigitizingTool (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)
	The advanced digitizing tool constructor.
QgsAdvancedDigitizingDockWidget *	cadDockWidget () const
	Returns the advanced digitizing widget associated with the tool.
virtual void	canvasMoveEvent (QgsMapMouseEvent *event)
	Handles canvas press move.
virtual void	canvasPressEvent (QgsMapMouseEvent *event)
	Handles canvas press event.
virtual void	canvasReleaseEvent (QgsMapMouseEvent *event)
	Handles canvas release event.
virtual QWidget *	createWidget ()
	Returns a widget to control the tool.
QgsMapCanvas *	mapCanvas () const
	Returns the map canvas associated with the tool.
virtual void	paint (QPainter *painter)
	Paints tool content onto the advanced digitizing canvas item.

Protected Attributes
QPointer< QgsAdvancedDigitizingDockWidget >	mCadDockWidget
QgsMapCanvas *	mMapCanvas = nullptr

Detailed Description

An abstract class for advanced digitizing tools.

Since

QGIS 3.40

Definition at line 38 of file qgsadvanceddigitizingtools.h.

Constructor & Destructor Documentation

QgsAdvancedDigitizingTool()

QgsAdvancedDigitizingTool::QgsAdvancedDigitizingTool ( QgsMapCanvas *  canvas, QgsAdvancedDigitizingDockWidget *  cadDockWidget  )

explicit

The advanced digitizing tool constructor.

Parameters

canvas	The map canvas on which the widget operates
cadDockWidget	The cadDockWidget to which the floater belongs

Definition at line 25 of file qgsadvanceddigitizingtools.cpp.

Member Function Documentation

cadDockWidget()

QgsAdvancedDigitizingDockWidget * QgsAdvancedDigitizingTool::cadDockWidget ( ) const

inline

Returns the advanced digitizing widget associated with the tool.

Definition at line 59 of file qgsadvanceddigitizingtools.h.

canvasMoveEvent()

virtual void QgsAdvancedDigitizingTool::canvasMoveEvent ( QgsMapMouseEvent *  event )

inlinevirtual

Handles canvas press move.

Note

To stop propagation, set the event's accepted property to false.

Reimplemented in QgsAdvancedDigitizingCirclesIntersectionTool.

Definition at line 85 of file qgsadvanceddigitizingtools.h.

canvasPressEvent()

virtual void QgsAdvancedDigitizingTool::canvasPressEvent ( QgsMapMouseEvent *  event )

inlinevirtual

Handles canvas press event.

Note

To stop propagation, set the event's accepted property to false.

Definition at line 76 of file qgsadvanceddigitizingtools.h.

canvasReleaseEvent()

virtual void QgsAdvancedDigitizingTool::canvasReleaseEvent ( QgsMapMouseEvent *  event )

inlinevirtual

Handles canvas release event.

Note

To stop propagation, set the event's accepted property to false.

Reimplemented in QgsAdvancedDigitizingCirclesIntersectionTool.

Definition at line 94 of file qgsadvanceddigitizingtools.h.

createWidget()

virtual QWidget * QgsAdvancedDigitizingTool::createWidget ( )

inlinevirtual

Returns a widget to control the tool.

Note

The caller gets the ownership.

Reimplemented in QgsAdvancedDigitizingCirclesIntersectionTool.

Definition at line 65 of file qgsadvanceddigitizingtools.h.

mapCanvas()

QgsMapCanvas * QgsAdvancedDigitizingTool::mapCanvas ( ) const

inline

Returns the map canvas associated with the tool.

Definition at line 54 of file qgsadvanceddigitizingtools.h.

paint()

virtual void QgsAdvancedDigitizingTool::paint ( QPainter *  painter )

inlinevirtual

Paints tool content onto the advanced digitizing canvas item.

Reimplemented in QgsAdvancedDigitizingCirclesIntersectionTool.

Definition at line 70 of file qgsadvanceddigitizingtools.h.

paintRequested

void QgsAdvancedDigitizingTool::paintRequested ( )

signal

Requests a new painting event to the advanced digitizing canvas item.

Member Data Documentation

mCadDockWidget

QPointer< QgsAdvancedDigitizingDockWidget > QgsAdvancedDigitizingTool::mCadDockWidget

protected

Definition at line 109 of file qgsadvanceddigitizingtools.h.

mMapCanvas

QgsMapCanvas* QgsAdvancedDigitizingTool::mMapCanvas = nullptr

protected

Definition at line 108 of file qgsadvanceddigitizingtools.h.

---

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

• /build/qgis-3.40.0+99sid/src/gui/qgsadvanceddigitizingtools.h
• /build/qgis-3.40.0+99sid/src/gui/qgsadvanceddigitizingtools.cpp