QGIS API Documentation  3.17.0-Master (a84647cf30)
qgslayoutitempolygon.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayoutitempolygon.h
3  begin : March 2016
4  copyright : (C) 2016 Paul Blottiere, Oslandia
5  email : paul dot blottiere at oslandia dot com
6  ***************************************************************************/
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 QGSLAYOUTITEMPOLYGON_H
18 #define QGSLAYOUTITEMPOLYGON_H
19 
20 #include "qgis_core.h"
21 #include "qgslayoutitemnodeitem.h"
22 #include "qgssymbol.h"
23 
29 class CORE_EXPORT QgsLayoutItemPolygon: public QgsLayoutNodesItem
30 {
31  Q_OBJECT
32 
33  public:
34 
39 
44  QgsLayoutItemPolygon( const QPolygonF &polygon, QgsLayout *layout );
45 
51  static QgsLayoutItemPolygon *create( QgsLayout *layout ) SIP_FACTORY;
52 
53  int type() const override;
54  QIcon icon() const override;
55  QString displayName() const override;
56  bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
57  QgsLayoutItem::Flags itemFlags() const override;
58  QgsGeometry clipPath() const override;
59 
64  QgsFillSymbol *symbol() { return mPolygonStyleSymbol.get(); }
65 
71  void setSymbol( QgsFillSymbol *symbol );
72 
73  protected:
74  bool _addNode( int indexPoint, QPointF newPoint, double radius ) override;
75  bool _removeNode( int nodeIndex ) override;
76  void _draw( QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem *itemStyle = nullptr ) override;
77  void _readXmlStyle( const QDomElement &elmt, const QgsReadWriteContext &context ) override;
78  void _writeXmlStyle( QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context ) const override;
79 
80  private:
81 
83  std::unique_ptr<QgsFillSymbol> mPolygonStyleSymbol;
85  void createDefaultPolygonStyleSymbol();
86 
91  void refreshSymbol();
92 };
93 
94 #endif // QGSLAYOUTITEMPOLYGON_H
virtual void _writeXmlStyle(QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context) const =0
Method called in writeXml.
The class is used as a container of context for various read/write operations on other objects...
virtual QIcon icon() const
Returns the item&#39;s icon.
int type() const override
Returns a unique graphics item type identifier.
virtual void _draw(QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem *itemStyle=nullptr)=0
Method called in paint.
QgsFillSymbol * symbol()
Returns the fill symbol used to draw the shape.
An abstract layout item that provides generic methods for node based shapes such as polygon or polyli...
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:123
virtual bool _removeNode(int nodeIndex)=0
Method called in removeNode.
Layout item for node based polygon shapes.
An interface for classes which can visit style entity (e.g.
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified style entity visitor, causing it to visit all style entities associated with th...
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:49
virtual Flags itemFlags() const
Returns the item&#39;s flags, which indicate how the item behaves.
Contains settings and helpers relating to a render of a QgsLayoutItem.
Definition: qgslayoutitem.h:44
virtual QString displayName() const
Gets item display name.
virtual QgsGeometry clipPath() const
Returns the clipping path generated by this item, in layout coordinates.
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
Definition: qgssymbol.h:1295
virtual void _readXmlStyle(const QDomElement &elmt, const QgsReadWriteContext &context)=0
Method called in readXml.
virtual bool _addNode(int nodeIndex, QPointF newNode, double radius)=0
Method called in addNode.