QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Signals | Public Member Functions | Protected Member Functions | List of all members
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:
Inheritance graph
[legend]

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 More...
 
void messageDiscarded ()
 emit signal to clear previous message More...
 
void activated ()
 signal emitted once the map tool is activated More...
 
void deactivated ()
 signal emitted once the map tool is deactivated More...
 

Public Member Functions

 QgsMapToolIdentifyFeature (QgsMapCanvas *canvas, QgsVectorLayer *vl=0)
 QgsMapToolIdentifyFeature is a map tool to identify a feature on a chosen layer. More...
 
 ~QgsMapToolIdentifyFeature ()
 
void setLayer (QgsVectorLayer *vl)
 change the layer used by the map tool to identify More...
 
virtual void canvasReleaseEvent (QMouseEvent *e)
 Overridden mouse release event. More...
 
- Public Member Functions inherited from QgsMapToolIdentify
 QgsMapToolIdentify (QgsMapCanvas *canvas)
 constructor More...
 
virtual ~QgsMapToolIdentify ()
 
virtual void canvasMoveEvent (QMouseEvent *e)
 Overridden mouse move event. More...
 
virtual void canvasPressEvent (QMouseEvent *e)
 Overridden mouse press event. More...
 
virtual void activate ()
 called when set as currently active map tool More...
 
virtual void deactivate ()
 called when map tool is being deactivated More...
 
QList< IdentifyResultidentify (int x, int y, QList< QgsMapLayer * > layerList=QList< QgsMapLayer * >(), IdentifyMode mode=DefaultQgsSetting)
 Performs the identification. More...
 
QList< IdentifyResultidentify (int x, int y, IdentifyMode mode, LayerType layerType=AllLayers)
 Performs the identification. More...
 
QgsIdentifyMenuidentifyMenu ()
 return a pointer to the identify menu which will be used in layer selection mode this menu can also be customized More...
 
- Public Member Functions inherited from QgsMapTool
virtual ~QgsMapTool ()
 virtual destructor More...
 
virtual void canvasDoubleClickEvent (QMouseEvent *e)
 Mouse double click event for overriding. Default implementation does nothing. More...
 
virtual void wheelEvent (QWheelEvent *e)
 Mouse wheel 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...
 
QAction * action ()
 Return associated action with map tool or NULL if no action is associated. More...
 
void setButton (QAbstractButton *button)
 Use this to associate a button to this maptool. More...
 
QAbstractButton * button ()
 Return associated button with map tool or NULL if no button is associated. More...
 
virtual void setCursor (QCursor cursor)
 Set a user defined cursor. More...
 
virtual bool isTransient ()
 Check whether this MapTool performs a zoom or pan operation. More...
 
virtual bool isEditTool ()
 Check whether this MapTool performs an edit operation. More...
 
QgsMapCanvascanvas ()
 returns pointer to the tool's map canvas More...
 
QString toolName ()
 Emit map tool changed with the old tool. More...
 

Protected Member Functions

virtual void keyPressEvent (QKeyEvent *e)
 Key event for overriding. Default implementation does nothing. More...
 
- Protected Member Functions inherited from QgsMapToolIdentify
QList< IdentifyResultidentify (int x, int y, IdentifyMode mode, QList< QgsMapLayer * > layerList, LayerType layerType=AllLayers)
 Performs the identification. More...
 
bool identifyLayer (QList< IdentifyResult > *results, QgsMapLayer *layer, QgsPoint point, QgsRectangle viewExtent, double mapUnitsPerPixel, LayerType layerType=AllLayers)
 call the right method depending on layer type More...
 
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 More...
 
QgsPoint toMapCoordinates (const QPoint &point)
 transformation from screen coordinates to map 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...
 
QgsPoint toMapCoordinates (QgsMapLayer *layer, const QgsPoint &point)
 transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...
 
QgsRectangle toLayerCoordinates (QgsMapLayer *layer, const QgsRectangle &rect)
 trnasformation of the rect from map coordinates to layer's coordinates More...
 
QPoint toCanvasCoordinates (const QgsPoint &point)
 transformation from map coordinates to screen coordinates More...
 

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. 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...
 
- Protected Attributes inherited from QgsMapToolIdentify
QgsIdentifyMenumIdentifyMenu
 
- Protected Attributes inherited from QgsMapTool
QgsMapCanvasmCanvas
 pointer to map canvas More...
 
QCursor mCursor
 cursor used in map tool More...
 
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...
 
QString mToolName
 translated name of the map tool More...
 

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
canvasthe map canvas
vlthe 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: