QGIS API Documentation  3.17.0-Master (a84647cf30)
qgsannotationpolygonitem.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsannotationpolygonitem.h
3  ----------------
4  begin : July 2020
5  copyright : (C) 2020 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSANNOTATIONPOLYGONITEM_H
19 #define QGSANNOTATIONPOLYGONITEM_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include "qgsannotationitem.h"
24 
25 
32 class CORE_EXPORT QgsAnnotationPolygonItem : public QgsAnnotationItem
33 {
34  public:
35 
40  ~QgsAnnotationPolygonItem() override;
41 
42  QString type() const override;
43  void render( QgsRenderContext &context, QgsFeedback *feedback ) override;
44  bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
45 
49  static QgsAnnotationPolygonItem *create() SIP_FACTORY;
50 
51  bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
53  QgsRectangle boundingBox() const override;
54 
62  const QgsCurvePolygon *geometry() const { return mPolygon.get(); }
63 
71  void setGeometry( QgsCurvePolygon *geometry SIP_TRANSFER ) { mPolygon.reset( geometry ); }
72 
78  const QgsFillSymbol *symbol() const;
79 
87  void setSymbol( QgsFillSymbol *symbol SIP_TRANSFER );
88 
89  private:
90 
91  std::unique_ptr< QgsCurvePolygon > mPolygon;
92  std::unique_ptr< QgsFillSymbol > mSymbol;
93 
94 #ifdef SIP_RUN
96 #endif
97 
98 };
99 #endif // QGSANNOTATIONPOLYGONITEM_H
The class is used as a container of context for various read/write operations on other objects...
A rectangle specified with double values.
Definition: qgsrectangle.h:41
virtual QString type() const =0
Returns a unique (untranslated) string identifying the type of item.
Curve polygon geometry type.
virtual QgsAnnotationItem * clone()=0
Returns a clone of the item.
void setGeometry(QgsCurvePolygon *geometry)
Sets the geometry of the item.
virtual bool readXml(const QDomElement &element, const QgsReadWriteContext &context)=0
Reads the item&#39;s state from the given DOM element.
Base class for feedback objects to be used for cancellation of something running in a worker thread...
Definition: qgsfeedback.h:43
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual bool writeXml(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const =0
Writes the item&#39;s state into an XML element.
virtual void render(QgsRenderContext &context, QgsFeedback *feedback)=0
Renders the item to the specified render context.
Abstract base class for annotation items which are drawn with QgsAnnotationLayers.
Contains information about the context of a rendering operation.
An annotation item which renders a fill symbol for a polygon geometry.
virtual QgsRectangle boundingBox() const =0
Returns the bounding box of the item&#39;s geographic location, in the parent layer&#39;s coordinate referenc...
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
Definition: qgssymbol.h:1295
const QgsCurvePolygon * geometry() const
Returns the geometry of the item.