QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
scalebar
qgsscalebarrendererregistry.h
Go to the documentation of this file.
1
/***************************************************************************
2
QgsScaleBarRendererRegistry.h
3
---------------------
4
begin : March 2020
5
copyright : (C) 2020 by Nyall Dawson
6
email : nyall dot dawson at gmail dot com
7
***************************************************************************
8
* *
9
* This program is free software; you can redistribute it and/or modify *
10
* it under the terms of the GNU General Public License as published by *
11
* the Free Software Foundation; either version 2 of the License, or *
12
* (at your option) any later version. *
13
* *
14
***************************************************************************/
15
16
#ifndef QGSSCALEBARRENDERERREGISTRY_H
17
#define QGSSCALEBARRENDERERREGISTRY_H
18
19
#include "
qgis.h
"
20
#include "qgis_core.h"
21
22
class
QgsScaleBarRenderer
;
23
33
class
CORE_EXPORT
QgsScaleBarRendererRegistry
34
{
35
public
:
41
explicit
QgsScaleBarRendererRegistry
();
42
~QgsScaleBarRendererRegistry
();
43
47
QStringList
renderers
()
const
;
48
53
QStringList
sortedRendererList
()
const
;
54
60
void
addRenderer
(
QgsScaleBarRenderer
*
renderer
SIP_TRANSFER
);
61
65
void
removeRenderer
(
const
QString &
id
);
66
73
QgsScaleBarRenderer
*
renderer
(
const
QString &
id
)
const
SIP_TRANSFERBACK
;
74
78
QString
visibleName
(
const
QString &
id
)
const
;
79
83
int
sortKey
(
const
QString &
id
)
const
;
84
85
private
:
86
QHash<QString, QgsScaleBarRenderer *> mRenderers;
87
};
88
#endif
// QGSSCALEBARRENDERERREGISTRY_H
QgsScaleBarRendererRegistry::addRenderer
void addRenderer(QgsScaleBarRenderer *renderer)
Adds a new renderer to the registry.
Definition
qgsscalebarrendererregistry.cpp:71
QgsScaleBarRendererRegistry::sortedRendererList
QStringList sortedRendererList() const
Returns a list of the renderer ids currently contained in the registry, sorted in an order respecting...
Definition
qgsscalebarrendererregistry.cpp:49
QgsScaleBarRendererRegistry::renderers
QStringList renderers() const
Returns a list of the renderer ids currently contained in the registry.
Definition
qgsscalebarrendererregistry.cpp:44
QgsScaleBarRendererRegistry::sortKey
int sortKey(const QString &id) const
Returns the sorting key for the renderer with matching id.
Definition
qgsscalebarrendererregistry.cpp:103
QgsScaleBarRendererRegistry::visibleName
QString visibleName(const QString &id) const
Returns the translated, user-visible name for the renderer with matching id.
Definition
qgsscalebarrendererregistry.cpp:95
QgsScaleBarRendererRegistry::QgsScaleBarRendererRegistry
QgsScaleBarRendererRegistry()
You should not normally need to create your own scalebar renderer registry.
Definition
qgsscalebarrendererregistry.cpp:27
QgsScaleBarRendererRegistry::renderer
QgsScaleBarRenderer * renderer(const QString &id) const
Creates a new scalebar renderer by id.
Definition
qgsscalebarrendererregistry.cpp:87
QgsScaleBarRendererRegistry::removeRenderer
void removeRenderer(const QString &id)
Removes the renderer with matching id from the registry.
Definition
qgsscalebarrendererregistry.cpp:79
QgsScaleBarRenderer
Abstract base class for scale bar renderers.
Definition
qgsscalebarrenderer.h:39
qgis.h
SIP_TRANSFER
#define SIP_TRANSFER
Definition
qgis_sip.h:35
SIP_TRANSFERBACK
#define SIP_TRANSFERBACK
Definition
qgis_sip.h:47
Generated on
for QGIS API Documentation by
1.17.0