QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
src
core
qgsmapdecoration.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsmapdecoration.h
3
----------------
4
begin : April 2017
5
copyright : (C) 2017 by Mathieu Pellerin
6
email : nirvn dot asia at gmail dot com
7
***************************************************************************/
8
9
/***************************************************************************
10
* *
11
* This program is free software; you can redistribute it and/or modify *
12
* it under the terms of the GNU General Public License as published by *
13
* the Free Software Foundation; either version 2 of the License, or *
14
* (at your option) any later version. *
15
* *
16
***************************************************************************/
17
18
#ifndef QGSMAPDECORATION_H
19
#define QGSMAPDECORATION_H
20
21
#include "qgis_core.h"
22
#include "
qgsmapsettings.h
"
23
#include "
qgsrendercontext.h
"
24
32
class
CORE_EXPORT
QgsMapDecoration
33
{
34
35
public
:
36
40
QgsMapDecoration
() =
default
;
41
42
virtual
~QgsMapDecoration
() =
default
;
43
47
virtual
void
render
(
const
QgsMapSettings
&mapSettings,
QgsRenderContext
&context ) = 0;
48
53
const
QString
displayName
()
const
{
return
mDisplayName; }
54
55
protected
:
56
61
void
setDisplayName
(
const
QString &name ) { mDisplayName = name; }
62
63
private
:
64
65
QString mDisplayName;
66
67
};
68
69
#endif //QGSMAPDECORATION_H
QgsRenderContext
Contains information about the context of a rendering operation.
Definition:
qgsrendercontext.h:58
qgsmapsettings.h
qgsrendercontext.h
QgsMapDecoration::setDisplayName
void setDisplayName(const QString &name)
Sets the map decoration display name.
Definition:
qgsmapdecoration.h:61
QgsMapDecoration::~QgsMapDecoration
virtual ~QgsMapDecoration()=default
QgsMapDecoration
Interface for map decorations.
Definition:
qgsmapdecoration.h:33
QgsMapSettings
The QgsMapSettings class contains configuration for rendering of the map.
Definition:
qgsmapsettings.h:88
QgsMapDecoration::QgsMapDecoration
QgsMapDecoration()=default
Constructor for QgsMapDecoration.
QgsMapDecoration::displayName
const QString displayName() const
Returns the map decoration display name.
Definition:
qgsmapdecoration.h:53
QgsMapDecoration::render
virtual void render(const QgsMapSettings &mapSettings, QgsRenderContext &context)=0
Renders a map decoration.
Generated on Sat Oct 24 2020 17:43:09 for QGIS API Documentation by
1.8.20