QgsMapToolEmitPoint Class Reference

A map tool that simply emits a point when clicking on the map. More...

#include <qgsmaptoolemitpoint.h>

Inheritance diagram for QgsMapToolEmitPoint:

Collaboration diagram for QgsMapToolEmitPoint:

Signals
void	canvasClicked (const QgsPoint &point, Qt::MouseButton button)
	signal emitted on canvas click

Public Member Functions
	QgsMapToolEmitPoint (QgsMapCanvas *canvas)
	constructor
virtual void	canvasMoveEvent (QMouseEvent *e)
	Overridden mouse move event.
virtual void	canvasPressEvent (QMouseEvent *e)
	Overridden mouse press event - emits the signal.
virtual void	canvasReleaseEvent (QMouseEvent *e)
	Overridden mouse release event.
Public Member Functions inherited from QgsMapTool
virtual	~QgsMapTool ()
	virtual destructor
virtual void	canvasDoubleClickEvent (QMouseEvent *e)
	Mouse double click event for overriding. Default implementation does nothing.
virtual void	wheelEvent (QWheelEvent *e)
	Mouse wheel event for overriding.
virtual void	keyPressEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing.
virtual void	keyReleaseEvent (QKeyEvent *e)
	Key event for overriding.
virtual void	renderComplete ()
	Called when rendering has finished. Default implementation does nothing.
void	setAction (QAction *action)
	Use this to associate a QAction to this maptool.
QAction *	action ()
	Return associated action with map tool or NULL if no action is associated.
void	setButton (QAbstractButton *button)
	Use this to associate a button to this maptool.
QAbstractButton *	button ()
	Return associated button with map tool or NULL if no button is associated.
virtual void	setCursor (QCursor cursor)
	Set a user defined cursor.
virtual bool	isTransient ()
	Check whether this MapTool performs a zoom or pan operation.
virtual bool	isEditTool ()
	Check whether this MapTool performs an edit operation.
virtual void	activate ()
	called when set as currently active map tool
virtual void	deactivate ()
	called when map tool is being deactivated
QgsMapCanvas *	canvas ()
	returns pointer to the tool's map canvas

Additional Inherited Members
Protected Member Functions inherited from QgsMapTool
	QgsMapTool (QgsMapCanvas *canvas)
	constructor takes map canvas as a parameter
QgsPoint	toMapCoordinates (const QPoint &point)
	transformation from screen coordinates to map coordinates
QgsPoint	toLayerCoordinates (QgsMapLayer *layer, const QPoint &point)
	transformation from screen coordinates to layer's coordinates
QgsPoint	toLayerCoordinates (QgsMapLayer *layer, const QgsPoint &point)
	transformation from map coordinates to layer's coordinates
QgsPoint	toMapCoordinates (QgsMapLayer *layer, const QgsPoint &point)
	transformation from layer's coordinates to map coordinates (which is different in case reprojection is used)
QgsRectangle	toLayerCoordinates (QgsMapLayer *layer, const QgsRectangle &rect)
	trnasformation of the rect from map coordinates to layer's coordinates
QPoint	toCanvasCoordinates (const QgsPoint &point)
	transformation from map coordinates to screen coordinates
Protected Attributes inherited from QgsMapTool
QgsMapCanvas *	mCanvas
	pointer to map canvas
QCursor	mCursor
	cursor used in map tool
QAction *	mAction
	optionally map tool can have pointer to action which will be used to set that action as active
QAbstractButton *	mButton
	optionally map tool can have pointer to a button which will be used to set that action as active

Detailed Description

A map tool that simply emits a point when clicking on the map.

Connecting a slot to its canvasClicked() signal will let you implement custom behaviour for the passed in point.

Definition at line 29 of file qgsmaptoolemitpoint.h.

Constructor & Destructor Documentation

QgsMapToolEmitPoint::QgsMapToolEmitPoint

(

QgsMapCanvas *

canvas

)

constructor

Definition at line 22 of file qgsmaptoolemitpoint.cpp.

Member Function Documentation

void QgsMapToolEmitPoint::canvasClicked ( const QgsPoint &  point, Qt::MouseButton  button  )

signal

signal emitted on canvas click

Referenced by canvasPressEvent().

void QgsMapToolEmitPoint::canvasMoveEvent ( QMouseEvent *  e )

virtual

Overridden mouse move event.

Reimplemented from QgsMapTool.

Definition at line 27 of file qgsmaptoolemitpoint.cpp.

void QgsMapToolEmitPoint::canvasPressEvent ( QMouseEvent *  e )

virtual

Overridden mouse press event - emits the signal.

Reimplemented from QgsMapTool.

Definition at line 32 of file qgsmaptoolemitpoint.cpp.

References canvasClicked(), and QgsMapTool::toMapCoordinates().

void QgsMapToolEmitPoint::canvasReleaseEvent ( QMouseEvent *  e )

virtual

Overridden mouse release event.

Reimplemented from QgsMapTool.

Definition at line 38 of file qgsmaptoolemitpoint.cpp.

---

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

• /tmp/buildd/qgis-2.0.1/src/gui/qgsmaptoolemitpoint.h
• /tmp/buildd/qgis-2.0.1/src/gui/qgsmaptoolemitpoint.cpp