QGIS API Documentation 3.37.0-Master (c2d15952569)
Loading...
Searching...
No Matches
qgslayoutitemshape.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutitemshape.h
3 ---------------------
4 begin : July 2017
5 copyright : (C) 2017 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8/***************************************************************************
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 ***************************************************************************/
16
17#ifndef QGSLAYOUTITEMSHAPE_H
18#define QGSLAYOUTITEMSHAPE_H
19
20#include "qgis_core.h"
21#include "qgslayoutitem.h"
24
30class CORE_EXPORT QgsLayoutItemShape : public QgsLayoutItem
31{
32 Q_OBJECT
33
34 public:
35
37 enum Shape
38 {
41 Triangle
42 };
43
44
48 explicit QgsLayoutItemShape( QgsLayout *layout );
49
51
57 static QgsLayoutItemShape *create( QgsLayout *layout ) SIP_FACTORY;
58
59
60 int type() const override;
61 QIcon icon() const override;
62
63 //Overridden to return shape type
64 QString displayName() const override;
65 QgsLayoutItem::Flags itemFlags() const override;
66
71 QgsLayoutItemShape::Shape shapeType() const { return mShape; }
72
77 void setShapeType( QgsLayoutItemShape::Shape type );
78
84 void setSymbol( QgsFillSymbol *symbol );
85
90 QgsFillSymbol *symbol() { return mShapeStyleSymbol.get(); }
91
96 void setCornerRadius( QgsLayoutMeasurement radius );
97
102 QgsLayoutMeasurement cornerRadius() const { return mCornerRadius; }
103
104 QgsGeometry clipPath() const override;
105
106 // Depending on the symbol style, the bounding rectangle can be larger than the shape
107 QRectF boundingRect() const override;
108
109 // Reimplement estimatedFrameBleed, since frames on shapes are drawn using symbology
110 // rather than the item's pen
111 double estimatedFrameBleed() const override;
112
113 bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
114
115 protected:
116
117 void draw( QgsLayoutItemRenderContext &context ) override;
118
119 bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
120 bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
121
122 private slots:
123
131 void refreshSymbol( bool redraw );
132
134 void updateBoundingRect();
135
136 private:
137
138 Shape mShape = Rectangle;
139
140 std::unique_ptr< QgsFillSymbol > mShapeStyleSymbol;
141
142 double mMaxSymbolBleed = 0.0;
144 QRectF mCurrentRectangle;
145
146 QgsLayoutMeasurement mCornerRadius;
147
148 QPolygonF calculatePolygon( double scale ) const;
149};
150
151
152#endif //QGSLAYOUTITEMSHAPE_H
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
A geometry is the spatial representation of a feature.
Contains settings and helpers relating to a render of a QgsLayoutItem.
Layout item for basic filled shapes (e.g.
QgsFillSymbol * symbol()
Returns the fill symbol used to draw the shape.
~QgsLayoutItemShape() override
QgsLayoutMeasurement cornerRadius() const
Returns the corner radius for rounded rectangle corners.
@ Ellipse
Ellipse shape.
@ Rectangle
Rectangle shape.
QgsLayoutItemShape::Shape shapeType() const
Returns the type of shape (e.g.
Base class for graphical items within a QgsLayout.
virtual QgsGeometry clipPath() const
Returns the clipping path generated by this item, in layout coordinates.
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified style entity visitor, causing it to visit all style entities associated with th...
virtual QIcon icon() const
Returns the item's icon.
virtual bool writePropertiesToElement(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
Stores item state within an XML DOM element.
int type() const override
Returns a unique graphics item type identifier.
virtual QString displayName() const
Gets item display name.
virtual Flags itemFlags() const
Returns the item's flags, which indicate how the item behaves.
virtual bool readPropertiesFromElement(const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context)
Sets item state from a DOM element.
virtual double estimatedFrameBleed() const
Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.
virtual void draw(QgsLayoutItemRenderContext &context)=0
Draws the item's contents using the specified item render context.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:49
The class is used as a container of context for various read/write operations on other objects.
An interface for classes which can visit style entity (e.g.
#define SIP_FACTORY
Definition qgis_sip.h:76