QGIS API Documentation  3.21.0-Master (909859188c)
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_core.h"
20 #include "qgis.h"
21 
23 
33 class CORE_EXPORT QgsScaleBarRendererRegistry
34 {
35 
36  public:
37 
43  explicit QgsScaleBarRendererRegistry();
45 
49  QStringList renderers() const;
50 
55  QStringList sortedRendererList() const;
56 
62  void addRenderer( QgsScaleBarRenderer *renderer SIP_TRANSFER );
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
The QgsScaleBarRendererRegistry manages registered scalebar renderers.
Abstract base class for scale bar renderers.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_TRANSFERBACK
Definition: qgis_sip.h:48