QGIS API Documentation 3.27.0-Master (c6eca784ad)
qgslayoutviewmouseevent.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutviewmouseevent.h
3 -------------------------
4 Date : July 2017
5 Copyright : (C) 2017 Nyall Dawson
6 Email : nyall dot dawson at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSLAYOUTVIEWMOUSEEVENT_H
17#define QGSLAYOUTVIEWMOUSEEVENT_H
18
19#include <QMouseEvent>
20
21#include "qgis_gui.h"
22
23class QgsLayoutView;
24class QGraphicsLineItem;
25class QgsLayoutItem;
26
35class GUI_EXPORT QgsLayoutViewMouseEvent : public QMouseEvent
36{
37
38#ifdef SIP_RUN
40 if ( dynamic_cast<QgsLayoutViewMouseEvent *>( sipCpp ) )
41 sipType = sipType_QgsLayoutViewMouseEvent;
42 else
43 sipType = 0;
45#endif
46
47 public:
48
55 QgsLayoutViewMouseEvent( QgsLayoutView *view, QMouseEvent *event, bool snap = false );
56
65 void snapPoint( QGraphicsLineItem *horizontalSnapLine = nullptr, QGraphicsLineItem *verticalSnapLine = nullptr,
66 const QList<QgsLayoutItem *> &ignoreItems = QList< QgsLayoutItem * >() );
67
71 QPointF layoutPoint() const;
72
78 QPointF snappedPoint() const { return mSnappedPoint; }
79
84 bool isSnapped() const { return mSnapped; }
85
86 private:
87
89 QgsLayoutView *mView = nullptr;
90
91 bool mSnapped = false;
92 QPointF mLayoutPoint;
93 QPointF mSnappedPoint;
94
95};
96
97#endif // QGSLAYOUTVIEWMOUSEEVENT_H
Base class for graphical items within a QgsLayout.
A QgsLayoutViewMouseEvent is the result of a user interaction with the mouse on a QgsLayoutView.
bool isSnapped() const
Returns true if point was snapped, e.g.
QPointF snappedPoint() const
Returns the snapped event point location in layout coordinates.
A graphical widget to display and interact with QgsLayouts.
Definition: qgslayoutview.h:51
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:186
#define SIP_END
Definition: qgis_sip.h:203