qgsmaptool.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaptool.h  -  base class for map canvas tools
    ----------------------
    begin                : January 2006
    copyright            : (C) 2006 by Martin Dobias
    email                : wonder.sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSMAPTOOL_H
#define QGSMAPTOOL_H

#include "qgsconfig.h"
#include "qgis.h"

#include <QCursor>
#include <QString>
#include <QObject>

#include <QGestureEvent>
#include "qgis_gui.h"

class QgsMapLayer;
class QgsMapCanvas;
class QgsRenderContext;
class QKeyEvent;
class QMouseEvent;
class QWheelEvent;
class QgsPoint;
class QgsPointXY;
class QgsRectangle;
class QPoint;
class QAction;
class QAbstractButton;
class QgsMapMouseEvent;

#ifdef SIP_RUN
% ModuleHeaderCode
// fix to allow compilation with sip 4.7 that for some reason
// doesn't add these includes to the file where the code from
// ConvertToSubClassCode goes.
#include <qgsmaptoolzoom.h>
#include <qgsmaptoolpan.h>
#include <qgsmaptoolemitpoint.h>
#include <qgsmaptoolidentify.h>
% End
#endif

class GUI_EXPORT QgsMapTool : public QObject
{

#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsMapToolZoom *>( sipCpp ) != NULL )
      sipType = sipType_QgsMapToolZoom;
    else if ( dynamic_cast<QgsMapToolPan *>( sipCpp ) != NULL )
      sipType = sipType_QgsMapToolPan;
    else if ( dynamic_cast<QgsMapToolEmitPoint *>( sipCpp ) != NULL )
      sipType = sipType_QgsMapToolEmitPoint;
    else if ( dynamic_cast<QgsMapToolIdentify *>( sipCpp ) != NULL )
      sipType = sipType_QgsMapToolIdentify;
    else
      sipType = NULL;
    SIP_END
#endif

    Q_OBJECT

  public:

    enum Flag
    {
      Transient = 1 << 1, 
      EditTool = 1 << 2, 
      AllowZoomRect = 1 << 3, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )

    
    virtual Flags flags() const { return Flags(); }

    ~QgsMapTool() override;

    virtual void canvasMoveEvent( QgsMapMouseEvent *e );

    virtual void canvasDoubleClickEvent( QgsMapMouseEvent *e );

    virtual void canvasPressEvent( QgsMapMouseEvent *e );

    virtual void canvasReleaseEvent( QgsMapMouseEvent *e );

    virtual void wheelEvent( QWheelEvent *e );

    virtual void keyPressEvent( QKeyEvent *e );

    virtual void keyReleaseEvent( QKeyEvent *e );

    virtual bool gestureEvent( QGestureEvent *e );

    void setAction( QAction *action );

    QAction *action();

    bool isActive() const;

    void setButton( QAbstractButton *button );

    QAbstractButton *button();

    virtual void setCursor( const QCursor &cursor );

    virtual void activate();

    virtual void deactivate();

    virtual void clean();

    QgsMapCanvas *canvas();

    QString toolName() { return mToolName; }

    static double searchRadiusMM();

    static double searchRadiusMU( const QgsRenderContext &context );

    static double searchRadiusMU( QgsMapCanvas *canvas );

  signals:
    void messageEmitted( const QString &message, Qgis::MessageLevel = Qgis::Info );

    void messageDiscarded();

    void activated();

    void deactivated();

  private slots:
    void actionDestroyed();

  protected:

    QgsMapTool( QgsMapCanvas *canvas SIP_TRANSFERTHIS );

    QgsPointXY toMapCoordinates( QPoint point );

    QgsPointXY toLayerCoordinates( const QgsMapLayer *layer, QPoint point );

    QgsPointXY toLayerCoordinates( const QgsMapLayer *layer, const QgsPointXY &point );

    QgsPointXY toMapCoordinates( const QgsMapLayer *layer, const QgsPointXY &point );

    QgsPoint toMapCoordinates( const QgsMapLayer *layer, const QgsPoint &point ) SIP_PYNAME( toMapCoordinatesV2 );

    QgsRectangle toLayerCoordinates( const QgsMapLayer *layer, const QgsRectangle &rect );

    QPoint toCanvasCoordinates( const QgsPointXY &point );

    QgsMapCanvas *mCanvas = nullptr;

    QCursor mCursor;

    QAction *mAction = nullptr;

    QAbstractButton *mButton = nullptr;

    QString mToolName;

};

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapTool::Flags )

#endif