QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
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
23
34{
35
36 public:
37
45
49 QStringList renderers() const;
50
55 QStringList sortedRendererList() const;
56
63
67 void removeRenderer( const QString &id );
68
75 QgsScaleBarRenderer *renderer( const QString &id ) const SIP_TRANSFERBACK;
76
80 QString visibleName( const QString &id ) const;
81
85 int sortKey( const QString &id ) const;
86
87 private:
88 QHash<QString, QgsScaleBarRenderer *> mRenderers;
89};
90#endif // QGSSCALEBARRENDERERREGISTRY_H
void addRenderer(QgsScaleBarRenderer *renderer)
Adds a new renderer to the registry.
QStringList sortedRendererList() const
Returns a list of the renderer ids currently contained in the registry, sorted in an order respecting...
QStringList renderers() const
Returns a list of the renderer ids currently contained in the registry.
int sortKey(const QString &id) const
Returns the sorting key for the renderer with matching id.
QString visibleName(const QString &id) const
Returns the translated, user-visible name for the renderer with matching id.
QgsScaleBarRendererRegistry()
You should not normally need to create your own scalebar renderer registry.
QgsScaleBarRenderer * renderer(const QString &id) const
Creates a new scalebar renderer by id.
void removeRenderer(const QString &id)
Removes the renderer with matching id from the registry.
Abstract base class for scale bar renderers.
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_TRANSFERBACK
Definition qgis_sip.h:48