Interface for map decorations. More...

#include <qgsmapdecoration.h>

Public Member Functions
	QgsMapDecoration ()=default

virtual	~QgsMapDecoration ()=default

const QString	displayName () const
	Returns the map decoration display name.

virtual bool	hasFixedMapPosition () const
	Returns `true` if the decoration is attached to a fixed map position (e.g grid, layout extent), or `false` if the annotation uses a position relative to the map canvas (e.g.

virtual void	render (const QgsMapSettings &mapSettings, QgsRenderContext &context)=0
	Renders a map decoration.

Protected Member Functions
void	setDisplayName (const QString &name)
	Sets the map decoration display name.

Detailed Description

Interface for map decorations.

Definition at line 33 of file qgsmapdecoration.h.

Constructor & Destructor Documentation

◆ QgsMapDecoration()

QgsMapDecoration::QgsMapDecoration ( )

default

◆ ~QgsMapDecoration()

virtual QgsMapDecoration::~QgsMapDecoration ( )

virtualdefault

Member Function Documentation

◆ displayName()

const QString QgsMapDecoration::displayName ( ) const

inline

Returns the map decoration display name.

Since: QGIS 3.14

Definition at line 51 of file qgsmapdecoration.h.

◆ hasFixedMapPosition()

virtual bool QgsMapDecoration::hasFixedMapPosition ( ) const

inlinevirtual

Returns true if the decoration is attached to a fixed map position (e.g grid, layout extent), or false if the annotation uses a position relative to the map canvas (e.g.

title, copyright...)

Since: QGIS 3.34

Definition at line 58 of file qgsmapdecoration.h.

◆ render()

virtual void QgsMapDecoration::render	(	const QgsMapSettings &	mapSettings,
		QgsRenderContext &	context
	)

pure virtual

Renders a map decoration.

◆ setDisplayName()

void QgsMapDecoration::setDisplayName ( const QString & name )

inlineprotected

Sets the map decoration display name.

Since: QGIS 3.14

Definition at line 66 of file qgsmapdecoration.h.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/qgsmapdecoration.h

Public Member Functions

Protected Member Functions