QGIS API Documentation
2.8.2-Wien
|
Map tool for identifying features in layers. More...
#include <qgsmaptoolidentify.h>
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 | changedRasterResults (QList< IdentifyResult > &) |
void | identifyMessage (QString) |
void | identifyProgress (int, int) |
Signals inherited from QgsMapTool | |
void | activated () |
signal emitted once the map tool is activated | |
void | deactivated () |
signal emitted once the map tool is deactivated | |
void | messageDiscarded () |
emit signal to clear previous message | |
void | messageEmitted (QString message, QgsMessageBar::MessageLevel=QgsMessageBar::INFO) |
emit a message |
Public Member Functions | |
QgsMapToolIdentify (QgsMapCanvas *canvas) | |
constructor | |
virtual | ~QgsMapToolIdentify () |
virtual void | activate () override |
called when set as currently active map tool | |
virtual void | canvasMoveEvent (QMouseEvent *e) override |
Overridden mouse move event. | |
virtual void | canvasPressEvent (QMouseEvent *e) override |
Overridden mouse press event. | |
virtual void | canvasReleaseEvent (QMouseEvent *e) override |
Overridden mouse release event. | |
virtual void | deactivate () override |
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 | |
QAction * | action () |
Return associated action with map tool or NULL if no action is associated. | |
QAbstractButton * | button () |
Return associated button with map tool or NULL if no button is associated. | |
QgsMapCanvas * | canvas () |
returns pointer to the tool's map canvas | |
virtual void | canvasDoubleClickEvent (QMouseEvent *e) |
Mouse double click event for overriding. Default implementation does nothing. | |
virtual bool | isEditTool () |
Check whether this MapTool performs an edit operation. | |
virtual bool | isTransient () |
Check whether this MapTool performs a zoom or pan operation. | |
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. | |
void | setButton (QAbstractButton *button) |
Use this to associate a button to this maptool. | |
virtual void | setCursor (QCursor cursor) |
Set a user defined cursor. | |
QString | toolName () |
Emit map tool changed with the old tool. | |
virtual void | wheelEvent (QWheelEvent *e) |
Mouse wheel event for overriding. Default implementation does nothing. |
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 | |
QPoint | toCanvasCoordinates (const QgsPoint &point) |
transformation from map coordinates to screen 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 | |
QgsRectangle | toLayerCoordinates (QgsMapLayer *layer, const QgsRectangle &rect) |
trnasformation of the rect from map coordinates to layer's coordinates | |
QgsPoint | toMapCoordinates (const QPoint &point) |
transformation from screen coordinates to map coordinates | |
QgsPoint | toMapCoordinates (QgsMapLayer *layer, const QgsPoint &point) |
transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) |
Protected Attributes | |
QgsIdentifyMenu * | mIdentifyMenu |
Protected Attributes inherited from QgsMapTool | |
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 | |
QgsMapCanvas * | mCanvas |
pointer to map canvas | |
QCursor | mCursor |
cursor used in map tool | |
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. |
Map tool for identifying features in layers.
after selecting a point, performs the identification:
Definition at line 44 of file qgsmaptoolidentify.h.
Definition at line 51 of file qgsmaptoolidentify.h.
Definition at line 60 of file qgsmaptoolidentify.h.
QgsMapToolIdentify::QgsMapToolIdentify | ( | QgsMapCanvas * | canvas | ) |
constructor
Definition at line 47 of file qgsmaptoolidentify.cpp.
|
virtual |
Definition at line 57 of file qgsmaptoolidentify.cpp.
|
overridevirtual |
called when set as currently active map tool
Reimplemented from QgsMapTool.
Definition at line 165 of file qgsmaptoolidentify.cpp.
|
overridevirtual |
Overridden mouse move event.
Reimplemented from QgsMapTool.
Definition at line 62 of file qgsmaptoolidentify.cpp.
|
overridevirtual |
Overridden mouse press event.
Reimplemented from QgsMapTool.
Definition at line 67 of file qgsmaptoolidentify.cpp.
|
overridevirtual |
Overridden mouse release event.
Reimplemented from QgsMapTool.
Reimplemented in QgsMapToolIdentifyFeature.
Definition at line 72 of file qgsmaptoolidentify.cpp.
|
signal |
|
overridevirtual |
called when map tool is being deactivated
Reimplemented from QgsMapTool.
Definition at line 170 of file qgsmaptoolidentify.cpp.
|
slot |
Definition at line 569 of file qgsmaptoolidentify.cpp.
QList< QgsMapToolIdentify::IdentifyResult > QgsMapToolIdentify::identify | ( | int | x, |
int | y, | ||
QList< QgsMapLayer * > | layerList = QList<QgsMapLayer*>() , |
||
IdentifyMode | mode = DefaultQgsSetting |
||
) |
Performs the identification.
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. |
Definition at line 77 of file qgsmaptoolidentify.cpp.
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
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. |
Definition at line 82 of file qgsmaptoolidentify.cpp.
|
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
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). |
Definition at line 87 of file qgsmaptoolidentify.cpp.
|
protected |
call the right method depending on layer type
Definition at line 175 of file qgsmaptoolidentify.cpp.
|
inline |
return a pointer to the identify menu which will be used in layer selection mode this menu can also be customized
Definition at line 128 of file qgsmaptoolidentify.h.
|
signal |
|
signal |
|
protected |
Definition at line 354 of file qgsmaptoolidentify.cpp.
|
protected |
Definition at line 191 of file qgsmaptoolidentify.cpp.
|
protected |
Definition at line 150 of file qgsmaptoolidentify.h.