QgsAnnotationPolygonItem Class Reference

An annotation item which renders a fill symbol for a polygon geometry. More...

#include <qgsannotationpolygonitem.h>

Inheritance diagram for QgsAnnotationPolygonItem:

Public Member Functions
	QgsAnnotationPolygonItem (QgsCurvePolygon *polygon)
	Constructor for QgsAnnotationPolygonItem, with the specified polygon geometry. More...
	~QgsAnnotationPolygonItem () override
QgsRectangle	boundingBox () const override
	Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. More...
QgsAnnotationPolygonItem *	clone () override
	Returns a clone of the item. More...
const QgsCurvePolygon *	geometry () const
	Returns the geometry of the item. More...
bool	readXml (const QDomElement &element, const QgsReadWriteContext &context) override
	Reads the item's state from the given DOM element. More...
void	render (QgsRenderContext &context, QgsFeedback *feedback) override
	Renders the item to the specified render context. More...
void	setGeometry (QgsCurvePolygon *geometry)
	Sets the geometry of the item. More...
void	setSymbol (QgsFillSymbol *symbol)
	Sets the symbol used to render the polygon item. More...
const QgsFillSymbol *	symbol () const
	Returns the symbol used to render the item. More...
QString	type () const override
	Returns a unique (untranslated) string identifying the type of item. More...
bool	writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
	Writes the item's state into an XML element. More...
Public Member Functions inherited from QgsAnnotationItem
	QgsAnnotationItem ()=default
	Constructor for an annotation item. More...
	QgsAnnotationItem (const QgsAnnotationItem &other)=delete
	QgsAnnotationItem cannot be copied. More...
virtual	~QgsAnnotationItem ()=default
QgsAnnotationItem &	operator= (const QgsAnnotationItem &other)=delete
	QgsAnnotationItem cannot be copied. More...
void	setZIndex (int index)
	Sets the item's z index, which controls the order in which annotation items are rendered in the layer. More...
int	zIndex () const
	Returns the item's z index, which controls the order in which annotation items are rendered in the layer. More...

Static Public Member Functions
static QgsAnnotationPolygonItem *	create ()
	Creates a new polygon annotation item. More...

Detailed Description

An annotation item which renders a fill symbol for a polygon geometry.

Since

QGIS 3.16

Definition at line 32 of file qgsannotationpolygonitem.h.

Constructor & Destructor Documentation

QgsAnnotationPolygonItem()

QgsAnnotationPolygonItem::QgsAnnotationPolygonItem

(

QgsCurvePolygon *

polygon

)

Constructor for QgsAnnotationPolygonItem, with the specified polygon geometry.

Definition at line 24 of file qgsannotationpolygonitem.cpp.

~QgsAnnotationPolygonItem()

QgsAnnotationPolygonItem::~QgsAnnotationPolygonItem ( )

overridedefault

Member Function Documentation

boundingBox()

QgsRectangle QgsAnnotationPolygonItem::boundingBox ( ) const

overridevirtual

Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system.

Implements QgsAnnotationItem.

Definition at line 126 of file qgsannotationpolygonitem.cpp.

clone()

QgsAnnotationPolygonItem * QgsAnnotationPolygonItem::clone ( )

overridevirtual

Returns a clone of the item.

Ownership is transferred to the caller.

Implements QgsAnnotationItem.

Definition at line 118 of file qgsannotationpolygonitem.cpp.

create()

QgsAnnotationPolygonItem * QgsAnnotationPolygonItem::create ( )

static

Creates a new polygon annotation item.

Definition at line 97 of file qgsannotationpolygonitem.cpp.

geometry()

const QgsCurvePolygon* QgsAnnotationPolygonItem::geometry ( ) const

inline

Returns the geometry of the item.

The coordinate reference system for the polygon will be the parent layer's QgsAnnotationLayer::crs().

See also

setGeometry()

Definition at line 62 of file qgsannotationpolygonitem.h.

readXml()

bool QgsAnnotationPolygonItem::readXml ( const QDomElement &  element, const QgsReadWriteContext &  context  )

overridevirtual

Reads the item's state from the given DOM element.

Implements QgsAnnotationItem.

Definition at line 102 of file qgsannotationpolygonitem.cpp.

render()

void QgsAnnotationPolygonItem::render ( QgsRenderContext &  context, QgsFeedback *  feedback  )

overridevirtual

Renders the item to the specified render context.

The feedback argument can be used to detect render cancellations during expensive render operations.

Implements QgsAnnotationItem.

Definition at line 39 of file qgsannotationpolygonitem.cpp.

setGeometry()

void QgsAnnotationPolygonItem::setGeometry ( QgsCurvePolygon *  geometry )

inline

Sets the geometry of the item.

The coordinate reference system for the polygon will be the parent layer's QgsAnnotationLayer::crs().

See also

geometry()

Definition at line 71 of file qgsannotationpolygonitem.h.

setSymbol()

void QgsAnnotationPolygonItem::setSymbol

(

QgsFillSymbol *

symbol

)

Sets the symbol used to render the polygon item.

The item takes ownership of the symbol.

See also

symbol()

Definition at line 136 of file qgsannotationpolygonitem.cpp.

symbol()

const QgsFillSymbol * QgsAnnotationPolygonItem::symbol

(

)

const

Returns the symbol used to render the item.

See also

setSymbol()

Definition at line 131 of file qgsannotationpolygonitem.cpp.

type()

QString QgsAnnotationPolygonItem::type ( ) const

overridevirtual

Returns a unique (untranslated) string identifying the type of item.

Implements QgsAnnotationItem.

Definition at line 34 of file qgsannotationpolygonitem.cpp.

writeXml()

bool QgsAnnotationPolygonItem::writeXml ( QDomElement &  element, QDomDocument &  document, const QgsReadWriteContext &  context  ) const

overridevirtual

Writes the item's state into an XML element.

Implements QgsAnnotationItem.

Definition at line 87 of file qgsannotationpolygonitem.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.20.0+99unstable/src/core/annotations/qgsannotationpolygonitem.h
• /build/qgis-3.20.0+99unstable/src/core/annotations/qgsannotationpolygonitem.cpp