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 "qgsmessagebar.h"
#include "qgspointv2.h"
#include "qgsmapmouseevent.h"

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

#ifdef HAVE_TOUCH
#include <QGestureEvent>
#endif

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

class GUI_EXPORT QgsMapTool : public QObject
{

    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(); }

    virtual ~QgsMapTool();

    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 );

#ifdef HAVE_TOUCH
    virtual bool gestureEvent( QGestureEvent* e );
#endif

    Q_DECL_DEPRECATED virtual void renderComplete();

    void setAction( QAction* action );

    QAction* action();

    void setButton( QAbstractButton* button );

    QAbstractButton* button();

    virtual void setCursor( const QCursor& cursor );

    Q_DECL_DEPRECATED virtual bool isTransient() const;

    Q_DECL_DEPRECATED virtual bool isEditTool() const;

    virtual void activate();

    virtual void deactivate();

    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, QgsMessageBar::MessageLevel = QgsMessageBar::INFO );

    void messageDiscarded();

    void activated();

    void deactivated();

  private slots:
    void actionDestroyed();

  protected:

    QgsMapTool( QgsMapCanvas* canvas );

    QgsPoint toMapCoordinates( QPoint point );

    QgsPoint toLayerCoordinates( QgsMapLayer* layer, QPoint point );

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

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

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

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

    QPoint toCanvasCoordinates( const QgsPoint& point );

    QgsMapCanvas* mCanvas;

    QCursor mCursor;

    QAction* mAction;

    QAbstractButton* mButton;

    QString mToolName;

};

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapTool::Flags )

#endif