QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Member Functions | Protected Member Functions | List of all members
QgsMapDecoration Class Referenceabstract

Interface for map decorations. More...

#include <qgsmapdecoration.h>

Public Member Functions

 QgsMapDecoration ()=default
 Constructor for QgsMapDecoration. More...
 
virtual ~QgsMapDecoration ()=default
 
const QString displayName () const
 Returns the map decoration display name. More...
 
virtual void render (const QgsMapSettings &mapSettings, QgsRenderContext &context)=0
 Renders a map decoration. More...
 

Protected Member Functions

void setDisplayName (const QString &name)
 Sets the map decoration display name. More...
 

Detailed Description

Interface for map decorations.

Since
QGIS 3.0

Definition at line 34 of file qgsmapdecoration.h.

Constructor & Destructor Documentation

◆ QgsMapDecoration()

QgsMapDecoration::QgsMapDecoration ( )
default

Constructor for QgsMapDecoration.

◆ ~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 55 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 63 of file qgsmapdecoration.h.


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