QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
qgshollowscalebarrenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgshollowscalebarrenderer.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  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  ***************************************************************************/
16 
17 #ifndef QGSHOLLOWSCALEBARRENDERER_H
18 #define QGSHOLLOWSCALEBARRENDERER_H
19 
20 #include "qgis_core.h"
21 #include "qgsscalebarrenderer.h"
22 #include <QString>
23 
32 {
33  public:
34 
38  QgsHollowScaleBarRenderer() = default;
39 
40  QString id() const override;
41  QString visibleName() const override;
42  Flags flags() const override;
43  int sortKey() const override;
45 
46  void draw( QgsRenderContext &context,
47  const QgsScaleBarSettings &settings,
48  const QgsScaleBarRenderer::ScaleBarContext &scaleContext ) const override;
49  bool applyDefaultSettings( QgsScaleBarSettings &settings ) const override;
50 
51 };
52 
53 #endif // QGSHOLLOWSCALEBARRENDERER_H
QgsScaleBarRenderer::draw
virtual void draw(QgsRenderContext &context, const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const =0
Draws the scalebar using the specified settings and scaleContext to a destination render context.
QgsScaleBarRenderer::id
virtual QString id() const =0
Returns the unique ID for this renderer.
QgsScaleBarRenderer::ScaleBarContext
Contains parameters regarding scalebar calculations.
Definition: qgsscalebarrenderer.h:70
QgsScaleBarRenderer::clone
virtual QgsScaleBarRenderer * clone() const =0
Returns a clone of the renderer.
QgsRenderContext
Contains information about the context of a rendering operation.
Definition: qgsrendercontext.h:59
qgsscalebarrenderer.h
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsScaleBarRenderer::applyDefaultSettings
virtual bool applyDefaultSettings(QgsScaleBarSettings &settings) const
Applies any default settings relating to the scalebar to the passed settings object.
Definition: qgsscalebarrenderer.cpp:294
QgsScaleBarSettings
The QgsScaleBarSettings class stores the appearance and layout settings for scalebar drawing with Qgs...
Definition: qgsscalebarsettings.h:40
QgsScaleBarRenderer
Abstract base class for scale bar renderers.
Definition: qgsscalebarrenderer.h:38
QgsScaleBarRenderer::visibleName
virtual QString visibleName() const =0
Returns the user friendly, translated name for the renderer.
QgsScaleBarRenderer::sortKey
virtual int sortKey() const
Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists.
Definition: qgsscalebarrenderer.cpp:163
QgsScaleBarRenderer::flags
virtual Flags flags() const
Returns the scalebar rendering flags, which dictates the renderer's behavior.
Definition: qgsscalebarrenderer.cpp:158
QgsHollowScaleBarRenderer
Scalebar style that draws a single box with alternating color for the segments, with horizontal lines...
Definition: qgshollowscalebarrenderer.h:31