QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgsannotationmarkeritem.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsannotationmarkeritem.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 QGSANNOTATIONMARKERITEM_H
19 #define QGSANNOTATIONMARKERITEM_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include "qgsannotationitem.h"
24 
25 
32 class CORE_EXPORT QgsAnnotationMarkerItem : public QgsAnnotationItem
33 {
34  public:
35 
39  QgsAnnotationMarkerItem( const QgsPoint &point );
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 QgsAnnotationMarkerItem *create() SIP_FACTORY;
50 
51  bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
52  QgsAnnotationMarkerItem *clone() override SIP_FACTORY;
53  QgsRectangle boundingBox() const override;
54 
62  QgsPointXY geometry() const { return mPoint; }
63 
71  void setGeometry( const QgsPoint &geometry ) { mPoint = geometry; }
72 
78  const QgsMarkerSymbol *symbol() const;
79 
87  void setSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER );
88 
89  private:
90 
91  QgsPoint mPoint;
92  std::unique_ptr< QgsMarkerSymbol > mSymbol;
93 
94 #ifdef SIP_RUN
96 #endif
97 
98 };
99 
100 #endif // QGSANNOTATIONMARKERITEM_H
QgsReadWriteContext
The class is used as a container of context for various read/write operations on other objects.
Definition: qgsreadwritecontext.h:35
QgsPoint
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:38
QgsRenderContext
Contains information about the context of a rendering operation.
Definition: qgsrendercontext.h:58
QgsRectangle
A rectangle specified with double values.
Definition: qgsrectangle.h:42
QgsAnnotationMarkerItem
An annotation item which renders a marker symbol at a point location.
Definition: qgsannotationmarkeritem.h:33
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsMarkerSymbol
A marker symbol type, for rendering Point and MultiPoint geometries.
Definition: qgssymbol.h:931
QgsAnnotationItem::writeXml
virtual bool writeXml(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const =0
Writes the item's state into an XML element.
QgsFeedback
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:44
qgis_sip.h
SIP_TRANSFER
#define SIP_TRANSFER
Definition: qgis_sip.h:36
QgsPointXY
A class to represent a 2D point.
Definition: qgspointxy.h:44
QgsAnnotationMarkerItem::~QgsAnnotationMarkerItem
~QgsAnnotationMarkerItem() override
QgsAnnotationItem::render
virtual void render(QgsRenderContext &context, QgsFeedback *feedback)=0
Renders the item to the specified render context.
QgsAnnotationMarkerItem::setGeometry
void setGeometry(const QgsPoint &geometry)
Sets the point geometry location of the marker.
Definition: qgsannotationmarkeritem.h:71
qgsannotationitem.h
QgsAnnotationItem
Abstract base class for annotation items which are drawn with QgsAnnotationLayers.
Definition: qgsannotationitem.h:39
QgsAnnotationItem::type
virtual QString type() const =0
Returns a unique (untranslated) string identifying the type of item.