An annotation item which renders a line symbol along a line geometry. More...

#include <qgsannotationlineitem.h>

Inheritance diagram for QgsAnnotationLineItem:

Public Member Functions
	QgsAnnotationLineItem (QgsCurve *curve)
	Constructor for QgsAnnotationLineItem, with the specified curve. More...

	~QgsAnnotationLineItem () override

Qgis::AnnotationItemEditOperationResult	applyEdit (QgsAbstractAnnotationItemEditOperation *operation) override
	Applies an edit operation to the item. More...

QgsRectangle	boundingBox () const override
	Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. More...

QgsAnnotationLineItem *	clone () const override
	Returns a clone of the item. More...

const QgsCurve *	geometry () const
	Returns the geometry of the item. More...

QList< QgsAnnotationItemNode >	nodes () const override
	Returns the nodes for the item, used for editing 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 (QgsCurve *geometry)
	Sets the geometry of the item. More...

void	setSymbol (QgsLineSymbol *symbol)
	Sets the symbol used to render the marker item. More...

const QgsLineSymbol *	symbol () const
	Returns the symbol used to render the item. More...

QgsAnnotationItemEditOperationTransientResults *	transientEditResults (QgsAbstractAnnotationItemEditOperation *operation) override
	Retrieves the results of a transient (in progress) edit operation on 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

virtual Qgis::AnnotationItemEditOperationResult	applyEdit (QgsAbstractAnnotationItemEditOperation *operation)
	Applies an edit operation to the item. More...

virtual QgsRectangle	boundingBox () const =0
	Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. More...

virtual QgsRectangle	boundingBox (QgsRenderContext &context) const
	Returns the bounding box of the item's geographic location, in the parent layer's coordinate reference system. More...

virtual QgsAnnotationItem *	clone () const =0
	Returns a clone of the item. More...

bool	enabled () const
	Returns `true` if the item is enabled and will be rendered in the layer. More...

virtual Qgis::AnnotationItemFlags	flags () const
	Returns item flags. More...

virtual QList< QgsAnnotationItemNode >	nodes () const
	Returns the nodes for the item, used for editing the item. More...

QgsAnnotationItem &	operator= (const QgsAnnotationItem &other)=delete
	QgsAnnotationItem cannot be copied. More...

virtual bool	readXml (const QDomElement &element, const QgsReadWriteContext &context)=0
	Reads the item's state from the given DOM element. More...

virtual void	render (QgsRenderContext &context, QgsFeedback *feedback)=0
	Renders the item to the specified render context. More...

void	setEnabled (bool enabled)
	Sets if the item will be rendered or not in the layer. More...

void	setSymbologyReferenceScale (double scale)
	Sets the annotation's symbology reference scale. More...

void	setUseSymbologyReferenceScale (bool enabled)
	Sets whether the annotation item uses a symbology reference scale. 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...

double	symbologyReferenceScale () const
	Returns the annotation's symbology reference scale. More...

virtual QgsAnnotationItemEditOperationTransientResults *	transientEditResults (QgsAbstractAnnotationItemEditOperation *operation)
	Retrieves the results of a transient (in progress) edit operation on the item. More...

virtual QString	type () const =0
	Returns a unique (untranslated) string identifying the type of item. More...

bool	useSymbologyReferenceScale () const
	Returns `true` if the annotation item uses a symbology reference scale. More...

virtual bool	writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const =0
	Writes the item's state into an XML element. 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 QgsAnnotationLineItem *	create ()
	Creates a new linestring annotation item. More...

Additional Inherited Members
Protected Member Functions inherited from QgsAnnotationItem
void	copyCommonProperties (const QgsAnnotationItem *other)
	Copies common properties from the base class from an other item. More...

bool	readCommonProperties (const QDomElement &element, const QgsReadWriteContext &context)
	Reads common properties from the base class from the given DOM element. More...

bool	writeCommonProperties (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
	Writes common properties from the base class into an XML element. More...

Detailed Description

An annotation item which renders a line symbol along a line geometry.

Since: QGIS 3.16

Definition at line 33 of file qgsannotationlineitem.h.

Constructor & Destructor Documentation

◆ QgsAnnotationLineItem()

QgsAnnotationLineItem::QgsAnnotationLineItem ( QgsCurve * curve )

Constructor for QgsAnnotationLineItem, with the specified curve.

Definition at line 27 of file qgsannotationlineitem.cpp.

◆ ~QgsAnnotationLineItem()

QgsAnnotationLineItem::~QgsAnnotationLineItem ( )

overridedefault

Member Function Documentation

◆ applyEdit()

Qgis::AnnotationItemEditOperationResult QgsAnnotationLineItem::applyEdit ( QgsAbstractAnnotationItemEditOperation * operation )

overridevirtual

Applies an edit operation to the item.

Since: QGIS 3.22

Reimplemented from QgsAnnotationItem.

Definition at line 97 of file qgsannotationlineitem.cpp.

◆ boundingBox()

QgsRectangle QgsAnnotationLineItem::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 193 of file qgsannotationlineitem.cpp.

◆ clone()

QgsAnnotationLineItem * QgsAnnotationLineItem::clone ( ) const

overridevirtual

Returns a clone of the item.

Ownership is transferred to the caller.

Implementations should include a call to copyCommonProperties() to copy the base class properties.

See also: copyCommonProperties()

Implements QgsAnnotationItem.

Definition at line 198 of file qgsannotationlineitem.cpp.

◆ create()

QgsAnnotationLineItem * QgsAnnotationLineItem::create ( )

static

Creates a new linestring annotation item.

Definition at line 172 of file qgsannotationlineitem.cpp.

◆ geometry()

const QgsCurve * QgsAnnotationLineItem::geometry ( ) const

inline

Returns the geometry of the item.

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

See also: setGeometry()

Definition at line 67 of file qgsannotationlineitem.h.

◆ nodes()

QList< QgsAnnotationItemNode > QgsAnnotationLineItem::nodes ( ) const

overridevirtual

Returns the nodes for the item, used for editing the item.

Since: QGIS 3.22

Reimplemented from QgsAnnotationItem.

Definition at line 86 of file qgsannotationlineitem.cpp.

◆ readXml()

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

overridevirtual

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

Implementations should include a call to readCommonProperties() to read the base class properties.

See also: writeXml(); readCommonProperties()

Implements QgsAnnotationItem.

Definition at line 177 of file qgsannotationlineitem.cpp.

◆ render()

void QgsAnnotationLineItem::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 42 of file qgsannotationlineitem.cpp.

◆ setGeometry()

void QgsAnnotationLineItem::setGeometry ( QgsCurve * geometry )

Sets the geometry of the item.

Ownership of geometry is transferred.

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

See also: geometry()

Definition at line 206 of file qgsannotationlineitem.cpp.

◆ setSymbol()

void QgsAnnotationLineItem::setSymbol ( QgsLineSymbol * symbol )

Sets the symbol used to render the marker item.

The item takes ownership of the symbol.

See also: symbol()

Definition at line 213 of file qgsannotationlineitem.cpp.

◆ symbol()

const QgsLineSymbol * QgsAnnotationLineItem::symbol ( ) const

Returns the symbol used to render the item.

See also: setSymbol()

Definition at line 208 of file qgsannotationlineitem.cpp.

◆ transientEditResults()

QgsAnnotationItemEditOperationTransientResults * QgsAnnotationLineItem::transientEditResults ( QgsAbstractAnnotationItemEditOperation * operation )

overridevirtual

Retrieves the results of a transient (in progress) edit operation on the item.

Since: QGIS 3.22

Reimplemented from QgsAnnotationItem.

Definition at line 141 of file qgsannotationlineitem.cpp.

◆ type()

QString QgsAnnotationLineItem::type ( ) const

overridevirtual

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

Implements QgsAnnotationItem.

Definition at line 37 of file qgsannotationlineitem.cpp.

◆ writeXml()

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

overridevirtual

Writes the item's state into an XML element.

Implementations should include a call to writeCommonProperties() to store the base class properties.

See also: readXml(); writeCommonProperties()

Implements QgsAnnotationItem.

Definition at line 77 of file qgsannotationlineitem.cpp.

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

/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/annotations/qgsannotationlineitem.h
/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/annotations/qgsannotationlineitem.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsAnnotationLineItem()

◆ ~QgsAnnotationLineItem()

Member Function Documentation

◆ applyEdit()

◆ boundingBox()

◆ clone()

◆ create()

◆ geometry()

◆ nodes()

◆ readXml()

◆ render()

◆ setGeometry()

◆ setSymbol()

◆ symbol()

◆ transientEditResults()

◆ type()

◆ writeXml()