An annotation item which renders a picture. More...

#include <qgsannotationpictureitem.h>

Inheritance diagram for QgsAnnotationPictureItem:

[legend]

Public Member Functions
	QgsAnnotationPictureItem (Qgis::PictureFormat format, const QString &path, const QgsRectangle &bounds)
	Constructor for QgsAnnotationPictureItem, rendering the specified image path within the specified bounds geometry.

	~QgsAnnotationPictureItem () override

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

Qgis::PictureFormat	format () const
	Returns the picture format.

bool	lockAspectRatio () const
	Returns `true` if the aspect ratio of the picture will be retained.

QString	path () const
	Returns the path of the image used to render the item.

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

void	setLockAspectRatio (bool locked)
	Sets whether the aspect ratio of the picture will be retained.

void	setPath (Qgis::PictureFormat format, const QString &path)
	Sets the format and path of the image used to render the item.

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

bool	writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
	Writes the item's state into an XML element.

Public Member Functions inherited from QgsAnnotationRectItem
	QgsAnnotationRectItem (const QgsRectangle &bounds)
	Constructor for QgsAnnotationRectItem, rendering the annotation within the specified bounds geometry.

	~QgsAnnotationRectItem () override

Qgis::AnnotationItemEditOperationResult	applyEditV2 (QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context) override
	Applies an edit operation to the item.

bool	backgroundEnabled () const
	Returns `true` if the item's background should be rendered.

const QgsFillSymbol *	backgroundSymbol () const
	Returns the symbol used to render the item's background.

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

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

QgsRectangle	bounds () const
	Returns the bounds of the item.

QSizeF	fixedSize () const
	Returns the fixed size to use for the item, when the placementMode() is Qgis::AnnotationPlacementMode::FixedSize.

Qgis::RenderUnit	fixedSizeUnit () const
	Returns the units to use for fixed item sizes, when the placementMode() is Qgis::AnnotationPlacementMode::FixedSize.

Qgis::AnnotationItemFlags	flags () const override
	Returns item flags.

bool	frameEnabled () const
	Returns `true` if the item's frame should be rendered.

const QgsFillSymbol *	frameSymbol () const
	Returns the symbol used to render the item's frame.

QList< QgsAnnotationItemNode >	nodesV2 (const QgsAnnotationItemEditContext &context) const override
	Returns the nodes for the item, used for editing the item.

Qgis::AnnotationPlacementMode	placementMode () const
	Returns the placement mode for the item.

void	render (QgsRenderContext &context, QgsFeedback *feedback) override
	Renders the item to the specified render context.

void	setBackgroundEnabled (bool enabled)
	Sets whether the item's background should be rendered.

void	setBackgroundSymbol (QgsFillSymbol *symbol)
	Sets the symbol used to render the item's background.

void	setBounds (const QgsRectangle &bounds)
	Sets the bounds of the item.

void	setFixedSize (const QSizeF &size)
	Sets the fixed size to use for the item, when the placementMode() is Qgis::AnnotationPlacementMode::FixedSize.

void	setFixedSizeUnit (Qgis::RenderUnit unit)
	Sets the unit to use for fixed item sizes, when the placementMode() is Qgis::AnnotationPlacementMode::FixedSize.

void	setFrameEnabled (bool enabled)
	Sets whether the item's frame should be rendered.

void	setFrameSymbol (QgsFillSymbol *symbol)
	Sets the symbol used to render the item's frame.

void	setPlacementMode (Qgis::AnnotationPlacementMode mode)
	Sets the placement mode for the item.

QgsAnnotationItemEditOperationTransientResults *	transientEditResultsV2 (QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context) override
	Retrieves the results of a transient (in progress) edit operation on the item.

Public Member Functions inherited from QgsAnnotationItem
	QgsAnnotationItem ()

	QgsAnnotationItem (const QgsAnnotationItem &other)=delete

virtual	~QgsAnnotationItem ()

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

QgsCallout *	callout () const
	Returns the item's callout renderer, responsible for drawing item callouts.

QgsGeometry	calloutAnchor () const
	Returns the callout's anchor geometry.

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

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

QSizeF	offsetFromCallout () const
	Returns the (optional) offset of the annotation item from the calloutAnchor().

Qgis::RenderUnit	offsetFromCalloutUnit () const
	Returns the units for the offsetFromCallout().

QgsAnnotationItem &	operator= (const QgsAnnotationItem &other)=delete

void	setCallout (QgsCallout *callout)
	Sets the item's callout renderer, responsible for drawing item callouts.

void	setCalloutAnchor (const QgsGeometry &anchor)
	Sets the callout's anchor geometry.

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

void	setOffsetFromCallout (const QSizeF &offset)
	Sets the offset of the annotation item from the calloutAnchor().

void	setOffsetFromCalloutUnit (Qgis::RenderUnit unit)
	Sets the unit for the offsetFromCallout().

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

void	setUseSymbologyReferenceScale (bool enabled)
	Sets whether the annotation item uses a symbology reference scale.

void	setZIndex (int index)
	Sets the item's z index, which controls the order in which annotation items are rendered in the layer.

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

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

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

int	zIndex () const
	Returns the item's z index, which controls the order in which annotation items are rendered in the layer.

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

Protected Member Functions
void	renderInBounds (QgsRenderContext &context, const QRectF &painterBounds, QgsFeedback *feedback) override
	Renders the item to the specified render context.

Protected Member Functions inherited from QgsAnnotationRectItem
void	copyCommonProperties (const QgsAnnotationItem *other) override
	Copies common properties from the base class from an other item.

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

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

Protected Member Functions inherited from QgsAnnotationItem
void	renderCallout (QgsRenderContext &context, const QRectF &rect, double angle, QgsCallout::QgsCalloutContext &calloutContext, QgsFeedback *feedback)
	Renders the item's callout.

Detailed Description

An annotation item which renders a picture.

Since: QGIS 3.40

Definition at line 31 of file qgsannotationpictureitem.h.

Constructor & Destructor Documentation

◆ QgsAnnotationPictureItem()

QgsAnnotationPictureItem::QgsAnnotationPictureItem	(	Qgis::PictureFormat	format,
		const QString &	path,
		const QgsRectangle &	bounds
	)

Constructor for QgsAnnotationPictureItem, rendering the specified image path within the specified bounds geometry.

Definition at line 30 of file qgsannotationpictureitem.cpp.

◆ ~QgsAnnotationPictureItem()

QgsAnnotationPictureItem::~QgsAnnotationPictureItem ( )

overridedefault

Member Function Documentation

◆ clone()

QgsAnnotationPictureItem * QgsAnnotationPictureItem::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 133 of file qgsannotationpictureitem.cpp.

◆ create()

QgsAnnotationPictureItem * QgsAnnotationPictureItem::create ( )

static

Creates a new polygon annotation item.

Definition at line 117 of file qgsannotationpictureitem.cpp.

◆ format()

Qgis::PictureFormat QgsAnnotationPictureItem::format ( ) const

inline

Returns the picture format.

Definition at line 62 of file qgsannotationpictureitem.h.

◆ lockAspectRatio()

bool QgsAnnotationPictureItem::lockAspectRatio ( ) const

Returns true if the aspect ratio of the picture will be retained.

See also: setLockAspectRatio()

Definition at line 154 of file qgsannotationpictureitem.cpp.

◆ path()

QString QgsAnnotationPictureItem::path ( ) const

inline

Returns the path of the image used to render the item.

See also: setPath()

Definition at line 57 of file qgsannotationpictureitem.h.

◆ readXml()

bool QgsAnnotationPictureItem::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 122 of file qgsannotationpictureitem.cpp.

◆ renderInBounds()

void QgsAnnotationPictureItem::renderInBounds	(	QgsRenderContext &	context,
		const QRectF &	painterRect,
		QgsFeedback *	feedback
	)

overrideprotectedvirtual

Renders the item to the specified render context.

The painterRect argument specifies the bounds in painter units where the rectangular item should be rendered within.

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

Implements QgsAnnotationRectItem.

Definition at line 43 of file qgsannotationpictureitem.cpp.

◆ setLockAspectRatio()

void QgsAnnotationPictureItem::setLockAspectRatio ( bool locked )

Sets whether the aspect ratio of the picture will be retained.

See also: lockAspectRatio()

Definition at line 159 of file qgsannotationpictureitem.cpp.

◆ setPath()

void QgsAnnotationPictureItem::setPath	(	Qgis::PictureFormat	format,
		const QString &	path
	)

Sets the format and path of the image used to render the item.

See also: path(); format()

Definition at line 142 of file qgsannotationpictureitem.cpp.

◆ type()

QString QgsAnnotationPictureItem::type ( ) const

overridevirtual

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

Implements QgsAnnotationItem.

Definition at line 38 of file qgsannotationpictureitem.cpp.

◆ writeXml()

bool QgsAnnotationPictureItem::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 108 of file qgsannotationpictureitem.cpp.

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

/build/qgis-3.39.0+git20240917+7b5d8bea57d+99sid/src/core/annotations/qgsannotationpictureitem.h
/build/qgis-3.39.0+git20240917+7b5d8bea57d+99sid/src/core/annotations/qgsannotationpictureitem.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsAnnotationPictureItem()

◆ ~QgsAnnotationPictureItem()

Member Function Documentation

◆ clone()

◆ create()

◆ format()

◆ lockAspectRatio()

◆ path()

◆ readXml()

◆ renderInBounds()

◆ setLockAspectRatio()

◆ setPath()

◆ type()

◆ writeXml()