Base class for map tools that edit vector geometry. More...

#include <qgsmaptooledit.h>

Inheritance diagram for QgsMapToolEdit:

Public Member Functions
	QgsMapToolEdit (QgsMapCanvas *canvas)

virtual	~QgsMapToolEdit ()

virtual bool	isEditTool () override
	Is this an edit tool? More...

Public Member Functions inherited from QgsMapTool
virtual	~QgsMapTool ()
	virtual destructor More...

QAction *	action ()
	Return associated action with map tool or NULL if no action is associated. More...

virtual void	activate ()
	called when set as currently active map tool More...

QAbstractButton *	button ()
	Return associated button with map tool or NULL if no button is associated. More...

QgsMapCanvas *	canvas ()
	returns pointer to the tool's map canvas More...

virtual void	canvasDoubleClickEvent (QgsMapMouseEvent *e)
	Mouse double click event for overriding. Default implementation does nothing. More...

virtual void	canvasMoveEvent (QgsMapMouseEvent *e)
	Mouse move event for overriding. Default implementation does nothing. More...

virtual void	canvasPressEvent (QgsMapMouseEvent *e)
	Mouse press event for overriding. Default implementation does nothing. More...

virtual void	canvasReleaseEvent (QgsMapMouseEvent *e)
	Mouse release event for overriding. Default implementation does nothing. More...

virtual void	deactivate ()
	called when map tool is being deactivated More...

virtual bool	isTransient ()
	Check whether this MapTool performs a zoom or pan operation. More...

virtual void	keyPressEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing. More...

virtual void	keyReleaseEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing. More...

virtual Q_DECL_DEPRECATED void	renderComplete ()
	Called when rendering has finished. More...

void	setAction (QAction *action)
	Use this to associate a QAction to this maptool. More...

void	setButton (QAbstractButton *button)
	Use this to associate a button to this maptool. More...

virtual void	setCursor (const QCursor &cursor)
	Set a user defined cursor. More...

QString	toolName ()
	Emit map tool changed with the old tool. More...

virtual void	wheelEvent (QWheelEvent *e)
	Mouse wheel event for overriding. Default implementation does nothing. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Protected Member Functions
int	addTopologicalPoints (const QList< QgsPoint > &geom)
	Adds vertices to other features to keep topology up to date, e.g. More...

QgsGeometryRubberBand *	createGeometryRubberBand (QGis::GeometryType geometryType=QGis::Line) const

QgsRubberBand *	createRubberBand (QGis::GeometryType geometryType=QGis::Line, bool alternativeBand=false)
	Creates a rubber band with the color/line width from the QGIS settings. More...

QgsVectorLayer *	currentVectorLayer ()
	Returns the current vector layer of the map canvas or 0. More...

void	notifyNotEditableLayer ()
	Display a timed message bar noting the active vector layer is not editable. More...

void	notifyNotVectorLayer ()
	Display a timed message bar noting the active layer is not vector. More...

Protected Member Functions inherited from QgsMapTool
	QgsMapTool (QgsMapCanvas *canvas)
	constructor takes map canvas as a parameter More...

QPoint	toCanvasCoordinates (const QgsPoint &point)
	transformation from map coordinates to screen coordinates More...

QgsPoint	toLayerCoordinates (QgsMapLayer *layer, const QPoint &point)
	transformation from screen coordinates to layer's coordinates More...

QgsPoint	toLayerCoordinates (QgsMapLayer *layer, const QgsPoint &point)
	transformation from map coordinates to layer's coordinates More...

QgsRectangle	toLayerCoordinates (QgsMapLayer *layer, const QgsRectangle &rect)
	trnasformation of the rect from map coordinates to layer's coordinates More...

QgsPoint	toMapCoordinates (const QPoint &point)
	transformation from screen coordinates to map coordinates More...

QgsPoint	toMapCoordinates (QgsMapLayer *layer, const QgsPoint &point)
	transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...

QgsPointV2	toMapCoordinates (QgsMapLayer *layer, const QgsPointV2 &point)
	transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Signals inherited from QgsMapTool
void	activated ()
	signal emitted once the map tool is activated More...

void	deactivated ()
	signal emitted once the map tool is deactivated More...

void	messageDiscarded ()
	emit signal to clear previous message More...

void	messageEmitted (QString message, QgsMessageBar::MessageLevel=QgsMessageBar::INFO)
	emit a message More...

Static Public Member Functions inherited from QgsMapTool
static double	searchRadiusMM ()
	Get search radius in mm. More...

static double	searchRadiusMU (const QgsRenderContext &context)
	Get search radius in map units for given context. More...

static double	searchRadiusMU (QgsMapCanvas *canvas)
	Get search radius in map units for given canvas. More...

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Protected Attributes inherited from QgsMapTool
QAction *	mAction
	optionally map tool can have pointer to action which will be used to set that action as active More...

QAbstractButton *	mButton
	optionally map tool can have pointer to a button which will be used to set that action as active More...

QgsMapCanvas *	mCanvas
	pointer to map canvas More...

QCursor	mCursor
	cursor used in map tool More...

QString	mToolName
	translated name of the map tool More...

Properties inherited from QObject
	objectName

Detailed Description

Base class for map tools that edit vector geometry.

Definition at line 28 of file qgsmaptooledit.h.

Constructor & Destructor Documentation

QgsMapToolEdit::QgsMapToolEdit ( QgsMapCanvas * canvas )

Definition at line 27 of file qgsmaptooledit.cpp.

QgsMapToolEdit::~QgsMapToolEdit ( )

virtual

Definition at line 32 of file qgsmaptooledit.cpp.

Member Function Documentation

int QgsMapToolEdit::addTopologicalPoints ( const QList< QgsPoint > & geom )

protected

Adds vertices to other features to keep topology up to date, e.g.

to neighbouring polygons.

Parameters

geom	list of points (in layer coordinate system)

Returns: 0 in case of success

Definition at line 67 of file qgsmaptooledit.cpp.

QgsGeometryRubberBand * QgsMapToolEdit::createGeometryRubberBand ( QGis::GeometryType geometryType = QGis::Line ) const

protected

Definition at line 90 of file qgsmaptooledit.cpp.

QgsRubberBand * QgsMapToolEdit::createRubberBand	(	QGis::GeometryType	geometryType = `QGis::Line`,
		bool	alternativeBand = `false`
	)

protected

Creates a rubber band with the color/line width from the QGIS settings.

The caller takes ownership of the returned object

Parameters

geometryType
alternativeBand	if true, rubber band will be set with more transparency and a dash pattern. defaut is false.

Definition at line 37 of file qgsmaptooledit.cpp.

QgsVectorLayer * QgsMapToolEdit::currentVectorLayer ( )

protected

Returns the current vector layer of the map canvas or 0.

Definition at line 61 of file qgsmaptooledit.cpp.

virtual bool QgsMapToolEdit::isEditTool ( )

inlineoverridevirtual

Is this an edit tool?

Returns: Of course it is or you would not be inheriting from it.

Reimplemented from QgsMapTool.

Definition at line 40 of file qgsmaptooledit.h.

void QgsMapToolEdit::notifyNotEditableLayer ( )

protected

Display a timed message bar noting the active vector layer is not editable.

Definition at line 110 of file qgsmaptooledit.cpp.

void QgsMapToolEdit::notifyNotVectorLayer ( )

protected

Display a timed message bar noting the active layer is not vector.

Definition at line 105 of file qgsmaptooledit.cpp.

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

/tmp/buildd/qgis-2.12.0+99unstable/src/gui/qgsmaptooledit.h
/tmp/buildd/qgis-2.12.0+99unstable/src/gui/qgsmaptooledit.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation