QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
layout
qgslayoutviewtooladditem.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgslayoutviewtooladditem.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 QGSLAYOUTVIEWTOOLADDITEM_H
17
#define QGSLAYOUTVIEWTOOLADDITEM_H
18
19
#include <memory>
20
21
#include "qgis_gui.h"
22
#include "
qgis_sip.h
"
23
#include "
qgslayoutviewrubberband.h
"
24
#include "
qgslayoutviewtool.h
"
25
30
class
GUI_EXPORT
QgsLayoutViewToolAddItem
:
public
QgsLayoutViewTool
31
{
32
Q_OBJECT
33
34
public
:
36
QgsLayoutViewToolAddItem
(
QgsLayoutView
*
view
SIP_TRANSFERTHIS
);
37
42
int
itemMetadataId
()
const
;
43
52
void
setItemMetadataId
(
int
metadataId );
53
54
void
layoutPressEvent
(
QgsLayoutViewMouseEvent
*event )
override
;
55
void
layoutMoveEvent
(
QgsLayoutViewMouseEvent
*event )
override
;
56
void
layoutReleaseEvent
(
QgsLayoutViewMouseEvent
*event )
override
;
57
void
activate
()
override
;
58
void
deactivate
()
override
;
59
66
QVariantMap
customProperties
()
const
;
67
77
void
setCustomProperties
(
const
QVariantMap &properties );
78
79
signals:
80
84
void
createdItem
();
85
86
private
:
87
bool
mDrawing =
false
;
88
89
int
mItemMetadataId = -1;
90
92
std::unique_ptr<QgsLayoutViewRubberBand> mRubberBand;
93
95
QPoint mMousePressStartPos;
96
98
QPointF mMousePressStartLayoutPos;
99
101
QPointF mRubberBandStartPos;
102
103
QVariantMap mCustomProperties;
104
};
105
106
#endif
// QGSLAYOUTVIEWTOOLADDITEM_H
QgsLayoutViewMouseEvent
A mouse event which is the result of a user interaction with a QgsLayoutView.
Definition
qgslayoutviewmouseevent.h:35
QgsLayoutViewToolAddItem::customProperties
QVariantMap customProperties() const
Returns any custom properties set for the tool.
Definition
qgslayoutviewtooladditem.cpp:180
QgsLayoutViewToolAddItem::itemMetadataId
int itemMetadataId() const
Returns the item metadata id for items created by the tool.
Definition
qgslayoutviewtooladditem.cpp:190
QgsLayoutViewToolAddItem::QgsLayoutViewToolAddItem
QgsLayoutViewToolAddItem(QgsLayoutView *view)
Constructs a QgsLayoutViewToolAddItem for the given layout view.
Definition
qgslayoutviewtooladditem.cpp:38
QgsLayoutViewToolAddItem::createdItem
void createdItem()
Emitted when an item has been created using the tool.
QgsLayoutViewToolAddItem::setItemMetadataId
void setItemMetadataId(int metadataId)
Sets the item metadata metadataId for items created by the tool.
Definition
qgslayoutviewtooladditem.cpp:45
QgsLayoutViewToolAddItem::setCustomProperties
void setCustomProperties(const QVariantMap &properties)
Sets custom properties for the tool.
Definition
qgslayoutviewtooladditem.cpp:185
QgsLayoutViewTool::view
QgsLayoutView * view() const
Returns the view associated with the tool.
Definition
qgslayoutviewtool.cpp:38
QgsLayoutViewTool::deactivate
virtual void deactivate()
Called when tool is deactivated.
Definition
qgslayoutviewtool.cpp:129
QgsLayoutViewTool::activate
virtual void activate()
Called when tool is set as the currently active layout tool.
Definition
qgslayoutviewtool.cpp:119
QgsLayoutViewTool::layoutMoveEvent
virtual void layoutMoveEvent(QgsLayoutViewMouseEvent *event)
Mouse move event for overriding.
Definition
qgslayoutviewtool.cpp:69
QgsLayoutViewTool::layoutPressEvent
virtual void layoutPressEvent(QgsLayoutViewMouseEvent *event)
Mouse press event for overriding.
Definition
qgslayoutviewtool.cpp:79
QgsLayoutViewTool::QgsLayoutViewTool
QgsLayoutViewTool(QgsLayoutView *view, const QString &name)
Constructor for QgsLayoutViewTool, taking a layout view and tool name as parameters.
Definition
qgslayoutviewtool.cpp:23
QgsLayoutViewTool::layoutReleaseEvent
virtual void layoutReleaseEvent(QgsLayoutViewMouseEvent *event)
Mouse release event for overriding.
Definition
qgslayoutviewtool.cpp:84
QgsLayoutView
A graphical widget to display and interact with QgsLayouts.
Definition
qgslayoutview.h:52
qgis_sip.h
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition
qgis_sip.h:52
qgslayoutviewrubberband.h
qgslayoutviewtool.h
Generated on
for QGIS API Documentation by
1.17.0