mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-23 00:02:38 -05:00
66 lines
1.9 KiB
Plaintext
66 lines
1.9 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsmapdecoration.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsMapDecoration
|
|
{
|
|
%Docstring(signature="appended")
|
|
Interface for map decorations.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmapdecoration.h"
|
|
%End
|
|
public:
|
|
|
|
QgsMapDecoration();
|
|
|
|
virtual ~QgsMapDecoration();
|
|
|
|
virtual void render( const QgsMapSettings &mapSettings, QgsRenderContext &context ) = 0;
|
|
%Docstring
|
|
Renders a map decoration.
|
|
%End
|
|
|
|
const QString displayName() const;
|
|
%Docstring
|
|
Returns the map decoration display name.
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
virtual bool hasFixedMapPosition() const;
|
|
%Docstring
|
|
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...)
|
|
|
|
.. versionadded:: 3.34
|
|
%End
|
|
|
|
protected:
|
|
|
|
void setDisplayName( const QString &name );
|
|
%Docstring
|
|
Sets the map decoration display ``name``.
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsmapdecoration.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|