QgsMapToolIdentifyFeature Class Reference

The QgsMapToolIdentifyFeature class is a map tool to identify a feature on a chosen layer. More...

#include <qgsmaptoolidentifyfeature.h>

Inheritance diagram for QgsMapToolIdentifyFeature:

Signals
void	featureIdentified (const QgsFeature &)
void	featureIdentified (QgsFeatureId)
Signals inherited from QgsMapToolIdentify
void	identifyProgress (int, int)
void	identifyMessage (QString)
void	changedRasterResults (QList< IdentifyResult > &)
Signals inherited from QgsMapTool
void	messageEmitted (QString message, QgsMessageBar::MessageLevel=QgsMessageBar::INFO)
	emit a message
void	messageDiscarded ()
	emit signal to clear previous message
void	activated ()
	signal emitted once the map tool is activated
void	deactivated ()
	signal emitted once the map tool is deactivated

Public Member Functions
	QgsMapToolIdentifyFeature (QgsMapCanvas *canvas, QgsVectorLayer *vl=0)
	QgsMapToolIdentifyFeature is a map tool to identify a feature on a chosen layer.
	~QgsMapToolIdentifyFeature ()
void	setLayer (QgsVectorLayer *vl)
	change the layer used by the map tool to identify
virtual void	canvasReleaseEvent (QMouseEvent *e)
	Overridden mouse release event.
Public Member Functions inherited from QgsMapToolIdentify
	QgsMapToolIdentify (QgsMapCanvas *canvas)
	constructor
virtual	~QgsMapToolIdentify ()
virtual void	canvasMoveEvent (QMouseEvent *e)
	Overridden mouse move event.
virtual void	canvasPressEvent (QMouseEvent *e)
	Overridden mouse press event.
virtual void	activate ()
	called when set as currently active map tool
virtual void	deactivate ()
	called when map tool is being deactivated
QList< IdentifyResult >	identify (int x, int y, QList< QgsMapLayer * > layerList=QList< QgsMapLayer * >(), IdentifyMode mode=DefaultQgsSetting)
	Performs the identification.
QList< IdentifyResult >	identify (int x, int y, IdentifyMode mode, LayerType layerType=AllLayers)
	Performs the identification.
QgsIdentifyMenu *	identifyMenu ()
	return a pointer to the identify menu which will be used in layer selection mode this menu can also be customized
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. Default implementation does nothing.
virtual void	keyReleaseEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing.
virtual Q_DECL_DEPRECATED void	renderComplete ()
	Called when rendering has finished.
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.
QgsMapCanvas *	canvas ()
	returns pointer to the tool's map canvas
QString	toolName ()
	Emit map tool changed with the old tool.

Protected Member Functions
virtual void	keyPressEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing.
Protected Member Functions inherited from QgsMapToolIdentify
QList< IdentifyResult >	identify (int x, int y, IdentifyMode mode, QList< QgsMapLayer * > layerList, LayerType layerType=AllLayers)
	Performs the identification.
bool	identifyLayer (QList< IdentifyResult > *results, QgsMapLayer *layer, QgsPoint point, QgsRectangle viewExtent, double mapUnitsPerPixel, LayerType layerType=AllLayers)
	call the right method depending on layer type
bool	identifyRasterLayer (QList< IdentifyResult > *results, QgsRasterLayer *layer, QgsPoint point, QgsRectangle viewExtent, double mapUnitsPerPixel)
bool	identifyVectorLayer (QList< IdentifyResult > *results, QgsVectorLayer *layer, QgsPoint point)
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

Additional Inherited Members
Public Types inherited from QgsMapToolIdentify
enum	IdentifyMode {   DefaultQgsSetting = -1, ActiveLayer, TopDownStopAtFirst, TopDownAll,   LayerSelection }
enum	Type { VectorLayer = 1, RasterLayer = 2, AllLayers = VectorLayer | RasterLayer }
Public Slots inherited from QgsMapToolIdentify
void	formatChanged (QgsRasterLayer *layer)
Static Public Member Functions inherited from QgsMapTool
static double	searchRadiusMM ()
	Get search radius in mm.
static double	searchRadiusMU (const QgsRenderContext &context)
	Get search radius in map units for given context.
static double	searchRadiusMU (QgsMapCanvas *canvas)
	Get search radius in map units for given canvas.
Protected Attributes inherited from QgsMapToolIdentify
QgsIdentifyMenu *	mIdentifyMenu

Detailed Description

The QgsMapToolIdentifyFeature class is a map tool to identify a feature on a chosen layer.

Once the map tool is enable, user can click on the map canvas to identify a feature. A signal will then be emitted.

Constructor & Destructor Documentation

QgsMapToolIdentifyFeature::QgsMapToolIdentifyFeature	(	QgsMapCanvas *	canvas,
		QgsVectorLayer *	vl = 0
	)

QgsMapToolIdentifyFeature is a map tool to identify a feature on a chosen layer.

Parameters

canvas	the map canvas
vl	the vector layer. The map tool can be initialized without any layer and can be set afterward.

QgsMapToolIdentifyFeature::~QgsMapToolIdentifyFeature

(

)

Member Function Documentation

void QgsMapToolIdentifyFeature::canvasReleaseEvent ( QMouseEvent *  e )

virtual

Overridden mouse release event.

Reimplemented from QgsMapToolIdentify.

void QgsMapToolIdentifyFeature::featureIdentified ( const QgsFeature &  )

signal

void QgsMapToolIdentifyFeature::featureIdentified ( QgsFeatureId  )

signal

void QgsMapToolIdentifyFeature::keyPressEvent ( QKeyEvent *  e )

protectedvirtual

Key event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

void QgsMapToolIdentifyFeature::setLayer ( QgsVectorLayer *  vl )

inline

change the layer used by the map tool to identify

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmaptoolidentifyfeature.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmaptoolidentifyfeature.cpp