QGIS API Documentation  3.21.0-Master (5b68dc587e)
qgslayoutviewtoolselect.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayoutviewtoolselect.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 QGSLAYOUTVIEWTOOLSELECT_H
17 #define QGSLAYOUTVIEWTOOLSELECT_H
18 
19 #include "qgis_sip.h"
20 #include "qgis_gui.h"
21 #include "qgslayoutviewtool.h"
23 #include <memory>
24 
25 class QgsLayoutMouseHandles;
26 
32 class GUI_EXPORT QgsLayoutViewToolSelect : public QgsLayoutViewTool
33 {
34 
35  Q_OBJECT
36 
37  public:
38 
43  ~QgsLayoutViewToolSelect() override;
44 
45  void layoutPressEvent( QgsLayoutViewMouseEvent *event ) override;
46  void layoutMoveEvent( QgsLayoutViewMouseEvent *event ) override;
47  void layoutReleaseEvent( QgsLayoutViewMouseEvent *event ) override;
48  void wheelEvent( QWheelEvent *event ) override;
49  void keyPressEvent( QKeyEvent *event ) override;
50  void deactivate() override;
51 
53 
58  SIP_SKIP QgsLayoutMouseHandles *mouseHandles();
60 
62  void setLayout( QgsLayout *layout );
63 
64  private:
65 
66  bool mIsSelecting = false;
67 
69  std::unique_ptr< QgsLayoutViewRubberBand > mRubberBand;
70 
72  QPoint mMousePressStartPos;
73 
75  QPointF mRubberBandStartPos;
76 
77  QPointer< QgsLayoutMouseHandles > mMouseHandles; //owned by scene
78 };
79 
80 #endif // QGSLAYOUTVIEWTOOLSELECT_H
A QgsLayoutViewMouseEvent is the result of a user interaction with the mouse on a QgsLayoutView.
Layout view tool for selecting items in the layout.
void setLayout(QgsLayout *layout)
Sets the a layout.
Abstract base class for all layout view tools.
virtual void deactivate()
Called when tool is deactivated.
virtual void wheelEvent(QWheelEvent *event)
Mouse wheel event for overriding.
virtual void layoutMoveEvent(QgsLayoutViewMouseEvent *event)
Mouse move event for overriding.
virtual void layoutPressEvent(QgsLayoutViewMouseEvent *event)
Mouse press event for overriding.
virtual void layoutReleaseEvent(QgsLayoutViewMouseEvent *event)
Mouse release event for overriding.
virtual void keyPressEvent(QKeyEvent *event)
Key press event for overriding.
A graphical widget to display and interact with QgsLayouts.
Definition: qgslayoutview.h:50
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:51
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
#define SIP_SKIP
Definition: qgis_sip.h:126