QGIS API Documentation  3.23.0-Master (22c16f2067)
qgsannotationlineitem.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsannotationlineitem.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 QGSANNOTATIONLINEITEM_H
19 #define QGSANNOTATIONLINEITEM_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include "qgsannotationitem.h"
24 
25 class QgsCurve;
26 
33 class CORE_EXPORT QgsAnnotationLineItem : public QgsAnnotationItem
34 {
35  public:
36 
42 
43  QString type() const override;
44  void render( QgsRenderContext &context, QgsFeedback *feedback ) override;
45  bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
46  QList< QgsAnnotationItemNode > nodes() const override;
49 
53  static QgsAnnotationLineItem *create() SIP_FACTORY;
54 
55  bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
56  QgsRectangle boundingBox() const override;
57 
58  QgsAnnotationLineItem *clone() override SIP_FACTORY;
59 
67  const QgsCurve *geometry() const { return mCurve.get(); }
68 
76  void setGeometry( QgsCurve *geometry SIP_TRANSFER ) { mCurve.reset( geometry ); }
77 
83  const QgsLineSymbol *symbol() const;
84 
92  void setSymbol( QgsLineSymbol *symbol SIP_TRANSFER );
93 
94  private:
95 
96  std::unique_ptr< QgsCurve > mCurve;
97  std::unique_ptr< QgsLineSymbol > mSymbol;
98 
99 #ifdef SIP_RUN
101 #endif
102 
103 };
104 
105 #endif // QGSANNOTATIONLINEITEM_H
AnnotationItemEditOperationResult
Results from an edit operation on an annotation item.
Definition: qgis.h:828
Abstract base class for annotation item edit operations.
Encapsulates the transient results of an in-progress annotation edit operation.
Abstract base class for annotation items which are drawn with QgsAnnotationLayers.
virtual bool writeXml(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const =0
Writes the item's state into an XML element.
virtual QString type() const =0
Returns a unique (untranslated) string identifying the type of item.
virtual void render(QgsRenderContext &context, QgsFeedback *feedback)=0
Renders the item to the specified render context.
virtual QgsAnnotationItemEditOperationTransientResults * transientEditResults(QgsAbstractAnnotationItemEditOperation *operation)
Retrieves the results of a transient (in progress) edit operation on the item.
virtual QList< QgsAnnotationItemNode > nodes() const
Returns the nodes for the item, used for editing the item.
virtual Qgis::AnnotationItemEditOperationResult applyEdit(QgsAbstractAnnotationItemEditOperation *operation)
Applies an edit operation to the item.
An annotation item which renders a line symbol along a line geometry.
~QgsAnnotationLineItem() override
void setGeometry(QgsCurve *geometry)
Sets the geometry of the item.
Abstract base class for curved geometry type.
Definition: qgscurve.h:36
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
A line symbol type, for rendering LineString and MultiLineString geometries.
Definition: qgslinesymbol.h:30
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:42
Contains information about the context of a rendering operation.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76