QgsMapToolIdentify Class Reference

Map tool for identifying features in layers. More...

#include <qgsmaptoolidentify.h>

Inheritance diagram for QgsMapToolIdentify:

Classes
struct	IdentifyResult

Public Types
enum	IdentifyMode {   DefaultQgsSetting = -1, ActiveLayer, TopDownStopAtFirst, TopDownAll,   LayerSelection }
enum	Type { VectorLayer = 1, RasterLayer = 2, AllLayers = VectorLayer | RasterLayer }

Public Slots
void	formatChanged (QgsRasterLayer *layer)

Signals
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
	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	canvasReleaseEvent (QMouseEvent *e)
	Overridden mouse release 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	keyPressEvent (QKeyEvent *e)
	Key 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
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

Protected Attributes
QgsIdentifyMenu *	mIdentifyMenu
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
QString	mToolName
	translated name of the map tool

Additional Inherited Members
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.

Detailed Description

Map tool for identifying features in layers.

after selecting a point, performs the identification:

• for raster layers shows value of underlying pixel
• for vector layers shows feature attributes within search radius (allows editing values when vector layer is in editing mode)

Member Enumeration Documentation

enum QgsMapToolIdentify::IdentifyMode

Enumerator:

DefaultQgsSetting
ActiveLayer
TopDownStopAtFirst
TopDownAll
LayerSelection

enum QgsMapToolIdentify::Type

Enumerator:

VectorLayer
RasterLayer
AllLayers

Constructor & Destructor Documentation

QgsMapToolIdentify::QgsMapToolIdentify

(

QgsMapCanvas *

canvas

)

constructor

QgsMapToolIdentify::~QgsMapToolIdentify ( )

virtual

Member Function Documentation

void QgsMapToolIdentify::activate ( )

virtual

called when set as currently active map tool

Reimplemented from QgsMapTool.

void QgsMapToolIdentify::canvasMoveEvent ( QMouseEvent *  e )

virtual

Overridden mouse move event.

Reimplemented from QgsMapTool.

void QgsMapToolIdentify::canvasPressEvent ( QMouseEvent *  e )

virtual

Overridden mouse press event.

Reimplemented from QgsMapTool.

void QgsMapToolIdentify::canvasReleaseEvent ( QMouseEvent *  e )

virtual

Overridden mouse release event.

Reimplemented from QgsMapTool.

Reimplemented in QgsMapToolIdentifyFeature.

void QgsMapToolIdentify::changedRasterResults ( QList< IdentifyResult > &  )

signal

void QgsMapToolIdentify::deactivate ( )

virtual

called when map tool is being deactivated

Reimplemented from QgsMapTool.

void QgsMapToolIdentify::formatChanged ( QgsRasterLayer *  layer )

slot

QList< QgsMapToolIdentify::IdentifyResult > QgsMapToolIdentify::identify	(	int	x,
		int	y,
		QList< QgsMapLayer * >	layerList = QList<QgsMapLayer*>(),
		IdentifyMode	mode = DefaultQgsSetting
	)

Performs the identification.

Parameters

x	x coordinates of mouseEvent
y	y coordinates of mouseEvent
layerList	Performs the identification within the given list of layers. Default value is an empty list, i.e. uses all the layers.
mode	Identification mode. Can use Qgis default settings or a defined mode. Default mode is DefaultQgsSetting.

Returns

a list of IdentifyResult

QList< QgsMapToolIdentify::IdentifyResult > QgsMapToolIdentify::identify	(	int	x,
		int	y,
		IdentifyMode	mode,
		LayerType	layerType = AllLayers
	)

Performs the identification.

To avoid beeing forced to specify IdentifyMode with a list of layers this has been made private and two publics methods are offered

Parameters

x	x coordinates of mouseEvent
y	y coordinates of mouseEvent
mode	Identification mode. Can use Qgis default settings or a defined mode.
layerType	Only performs identification in a certain type of layers (raster, vector). Default value is AllLayers.

Returns

a list of IdentifyResult

QList< QgsMapToolIdentify::IdentifyResult > QgsMapToolIdentify::identify ( int  x, int  y, IdentifyMode  mode, QList< QgsMapLayer * >  layerList, LayerType  layerType = AllLayers  )

protected

Performs the identification.

To avoid beeing forced to specify IdentifyMode with a list of layers this has been made private and two publics methods are offered

Parameters

x	x coordinates of mouseEvent
y	y coordinates of mouseEvent
mode	Identification mode. Can use Qgis default settings or a defined mode.
layerList	Performs the identification within the given list of layers.
layerType	Only performs identification in a certain type of layers (raster, vector).

Returns

a list of IdentifyResult

bool QgsMapToolIdentify::identifyLayer ( QList< IdentifyResult > *  results, QgsMapLayer *  layer, QgsPoint  point, QgsRectangle  viewExtent, double  mapUnitsPerPixel, LayerType  layerType = AllLayers  )

protected

call the right method depending on layer type

QgsIdentifyMenu* QgsMapToolIdentify::identifyMenu ( )

inline

return a pointer to the identify menu which will be used in layer selection mode this menu can also be customized

void QgsMapToolIdentify::identifyMessage ( QString  )

signal

void QgsMapToolIdentify::identifyProgress ( int  , int    )

signal

bool QgsMapToolIdentify::identifyRasterLayer ( QList< IdentifyResult > *  results, QgsRasterLayer *  layer, QgsPoint  point, QgsRectangle  viewExtent, double  mapUnitsPerPixel  )

protected

bool QgsMapToolIdentify::identifyVectorLayer ( QList< IdentifyResult > *  results, QgsVectorLayer *  layer, QgsPoint  point  )

protected

Member Data Documentation

QgsIdentifyMenu* QgsMapToolIdentify::mIdentifyMenu

protected

---

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

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