qgsplottool.h

Go to the documentation of this file.

/***************************************************************************
                          qgsplottool.h
                          ---------------
    begin                : March 2022
    copyright            : (C) 2022 by Nyall Dawson
    email                : nyall dot dawson 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 QGSPLOTTOOL_H
#define QGSPLOTTOOL_H
 
#include "qgsconfig.h"
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QCursor>
#include <QPointer>
 
class QgsPlotCanvas;
class QgsPlotMouseEvent;
class QgsPoint;
class QgsPointXY;
 
class QWheelEvent;
class QKeyEvent;
class QGestureEvent;
class QHelpEvent;
class QMenu;
class QAction;
 
#ifdef SIP_RUN
//%ModuleHeaderCode
#include "qgsplottool.h"
#include "qgsplottoolpan.h"
#include "qgsplottoolzoom.h"
//%End
#endif
 

class GUI_EXPORT QgsPlotTool : public QObject
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsPlotToolPan *>( sipCpp ) != nullptr )
      sipType = sipType_QgsPlotToolPan;
    else if ( qobject_cast<QgsPlotToolZoom *>( sipCpp ) != nullptr )
      sipType = sipType_QgsPlotToolZoom;
    else if ( qobject_cast<QgsPlotTool *>( sipCpp ) != nullptr )
      sipType = sipType_QgsPlotTool;
    else
      sipType = nullptr;
    SIP_END
#endif
 
    Q_OBJECT
 
  public:
    ~QgsPlotTool() override;

    virtual Qgis::PlotToolFlags flags() const;

    QString toolName() const { return mToolName; }

    virtual void plotMoveEvent( QgsPlotMouseEvent *event );

    virtual void plotDoubleClickEvent( QgsPlotMouseEvent *event );

    virtual void plotPressEvent( QgsPlotMouseEvent *event );

    virtual void plotReleaseEvent( QgsPlotMouseEvent *event );

    virtual void wheelEvent( QWheelEvent *event );

    virtual void keyPressEvent( QKeyEvent *event );

    virtual void keyReleaseEvent( QKeyEvent *event );

    virtual bool gestureEvent( QGestureEvent *event );

    virtual bool canvasToolTipEvent( QHelpEvent *event );

    bool isActive() const;

    virtual void activate();

    virtual void deactivate();

    QgsPlotCanvas *canvas() const;

    void setAction( QAction *action );

    QAction *action();

    void setCursor( const QCursor &cursor );

    virtual bool populateContextMenuWithEvent( QMenu *menu, QgsPlotMouseEvent *event );
 
  signals:

    void activated();

    void deactivated();
 
  protected:
    QgsPlotTool( QgsPlotCanvas *canvas SIP_TRANSFERTHIS, const QString &name );

    QgsPoint toMapCoordinates( const QgsPointXY &point ) const;

    QgsPointXY toCanvasCoordinates( const QgsPoint &point ) const;

    bool isClickAndDrag( QPoint startViewPoint, QPoint endViewPoint ) const;

    static QPointF constrainPointToRect( QPointF point, const QRectF &rect );

    QgsPlotCanvas *mCanvas = nullptr;

    QString mToolName;

    QPointer<QAction> mAction;

    QCursor mCursor = Qt::ArrowCursor;
};
 
#endif // QGSPLOTTOOL_H