qgsplotmouseevent.h

Go to the documentation of this file.

/***************************************************************************
                          qgsplotmouseevent.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 QGSPLOTMOUSEEVENT_H
#define QGSPLOTMOUSEEVENT_H
 
#include "qgis_gui.h"
#include "qgspointlocator.h"
#include "qgspointxy.h"
 
#include <QMouseEvent>
 
class QgsPlotCanvas;

class GUI_EXPORT QgsPlotMouseEvent : public QMouseEvent
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsPlotMouseEvent *>( sipCpp ) )
      sipType = sipType_QgsPlotMouseEvent;
    else
      sipType = 0;
  SIP_END
#endif
 
  public:
    QgsPlotMouseEvent( QgsPlotCanvas *canvas, QMouseEvent *event );

    QgsPlotMouseEvent(
      QgsPlotCanvas *canvas, QEvent::Type type, QPoint pos, Qt::MouseButton button = Qt::NoButton, Qt::MouseButtons buttons = Qt::NoButton, Qt::KeyboardModifiers modifiers = Qt::NoModifier
    );

    QgsPoint mapPoint() const;

    QgsPointXY snappedPoint();

    bool isSnapped();
 
  private:
    QgsPlotCanvas *mCanvas = nullptr;

    QgsPoint mMapPoint;
 
    bool mHasCachedSnapResult = false;
    QgsPointXY mSnappedPoint;
    bool mIsSnapped = false;
 
    void snapPoint();
};
 
#endif // QGSPLOTMOUSEEVENT_H