QGIS API Documentation  2.11.0-Master
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 changedRasterResults (QList< IdentifyResult > &)
 
void identifyMessage (QString)
 
void identifyProgress (int, int)
 
- 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...
 

Public Member Functions

 QgsMapToolIdentifyFeature (QgsMapCanvas *canvas, QgsVectorLayer *vl=0)
 QgsMapToolIdentifyFeature is a map tool to identify a feature on a chosen layer. More...
 
 ~QgsMapToolIdentifyFeature ()
 
virtual void canvasReleaseEvent (QMouseEvent *e) override
 Overridden mouse release event. More...
 
void setLayer (QgsVectorLayer *vl)
 change the layer used by the map tool to identify More...
 
- Public Member Functions inherited from QgsMapToolIdentify
 QgsMapToolIdentify (QgsMapCanvas *canvas)
 constructor More...
 
virtual ~QgsMapToolIdentify ()
 
virtual void activate () override
 called when set as currently active map tool More...
 
virtual void canvasMoveEvent (QMouseEvent *e) override
 Overridden mouse move event. More...
 
virtual void canvasPressEvent (QMouseEvent *e) override
 Overridden mouse press event. More...
 
virtual void deactivate () override
 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...
 
QActionaction ()
 Return associated action with map tool or NULL if no action is associated. More...
 
QAbstractButtonbutton ()
 Return associated button with map tool or NULL if no button is associated. More...
 
QgsMapCanvascanvas ()
 returns pointer to the tool's map canvas More...
 
virtual void canvasDoubleClickEvent (QMouseEvent *e)
 Mouse double click event for overriding. Default implementation does nothing. More...
 
virtual bool isEditTool ()
 Check whether this MapTool performs an edit operation. More...
 
virtual bool isTransient ()
 Check whether this MapTool performs a zoom or pan operation. 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 (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)
 
QObjectchild (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< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () 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)
 
QThreadthread () const
 

Protected Member Functions

virtual void keyPressEvent (QKeyEvent *e) override
 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...
 
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...
 
- 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
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

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...
 
- 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 QgsMapToolIdentify
QgsIdentifyMenumIdentifyMenu
 
- Protected Attributes inherited from QgsMapTool
QActionmAction
 optionally map tool can have pointer to action which will be used to set that action as active More...
 
QAbstractButtonmButton
 optionally map tool can have pointer to a button which will be used to set that action as active More...
 
QgsMapCanvasmCanvas
 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

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.

Definition at line 26 of file qgsmaptoolidentifyfeature.h.

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.

Definition at line 22 of file qgsmaptoolidentifyfeature.cpp.

QgsMapToolIdentifyFeature::~QgsMapToolIdentifyFeature ( )

Definition at line 34 of file qgsmaptoolidentifyfeature.cpp.

Member Function Documentation

void QgsMapToolIdentifyFeature::canvasReleaseEvent ( QMouseEvent e)
overridevirtual

Overridden mouse release event.

Reimplemented from QgsMapToolIdentify.

Definition at line 38 of file qgsmaptoolidentifyfeature.cpp.

void QgsMapToolIdentifyFeature::featureIdentified ( const QgsFeature )
signal
void QgsMapToolIdentifyFeature::featureIdentified ( QgsFeatureId  )
signal
void QgsMapToolIdentifyFeature::keyPressEvent ( QKeyEvent e)
overrideprotectedvirtual

Key event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 53 of file qgsmaptoolidentifyfeature.cpp.

void QgsMapToolIdentifyFeature::setLayer ( QgsVectorLayer vl)
inline

change the layer used by the map tool to identify

Definition at line 41 of file qgsmaptoolidentifyfeature.h.


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