Scalebar style that draws a single box with alternating color for the segments, with horizontal lines through alternating segments. More...

#include <qgshollowscalebarrenderer.h>

Inheritance diagram for QgsHollowScaleBarRenderer:

[legend]

Public Member Functions
	QgsHollowScaleBarRenderer ()=default
	Constructor for QgsHollowScaleBarRenderer. More...

bool	applyDefaultSettings (QgsScaleBarSettings &settings) const override
	Applies any default settings relating to the scalebar to the passed settings object. More...

QgsHollowScaleBarRenderer *	clone () const override
	Returns a clone of the renderer. More...

void	draw (QgsRenderContext &context, const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const override
	Draws the scalebar using the specified settings and scaleContext to a destination render context. More...

Flags	flags () const override
	Returns the scalebar rendering flags, which dictates the renderer's behavior. More...

QString	id () const override
	Returns the unique ID for this renderer. More...

int	sortKey () const override
	Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists. More...

QString	visibleName () const override
	Returns the user friendly, translated name for the renderer. More...

Public Member Functions inherited from QgsScaleBarRenderer
	QgsScaleBarRenderer ()=default
	Constructor for QgsScaleBarRenderer. More...

virtual	~QgsScaleBarRenderer ()=default

virtual bool	applyDefaultSettings (QgsScaleBarSettings &settings) const
	Applies any default settings relating to the scalebar to the passed settings object. More...

virtual Q_DECL_DEPRECATED QSizeF	calculateBoxSize (const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const
	Calculates the required box size (in millimeters) for a scalebar using the specified settings and scaleContext. More...

virtual QSizeF	calculateBoxSize (QgsRenderContext &context, const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const
	Calculates the required box size (in millimeters) for a scalebar using the specified settings and scaleContext. More...

virtual QgsScaleBarRenderer *	clone () const =0
	Returns a clone of the renderer. More...

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. More...

virtual Flags	flags () const
	Returns the scalebar rendering flags, which dictates the renderer's behavior. More...

virtual QString	id () const =0
	Returns the unique ID for this renderer. More...

Q_DECL_DEPRECATED QString	name () const
	Returns the unique name for this style. More...

virtual int	sortKey () const
	Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists. More...

virtual QString	visibleName () const =0
	Returns the user friendly, translated name for the renderer. More...

Additional Inherited Members
Public Types inherited from QgsScaleBarRenderer
enum class	Flag { FlagUsesLineSymbol = 1 << 0 , FlagUsesFillSymbol = 1 << 1 , FlagUsesAlternateFillSymbol = 1 << 2 , FlagRespectsUnits = 1 << 3 , FlagRespectsMapUnitsPerScaleBarUnit = 1 << 4 , FlagUsesUnitLabel = 1 << 5 , FlagUsesSegments = 1 << 6 , FlagUsesLabelBarSpace = 1 << 7 , FlagUsesLabelVerticalPlacement = 1 << 8 , FlagUsesLabelHorizontalPlacement = 1 << 8 , FlagUsesAlignment = 1 << 9 , FlagUsesSubdivisions = 1 << 10 , FlagUsesDivisionSymbol = 1 << 11 , FlagUsesSubdivisionSymbol = 1 << 12 , FlagUsesSubdivisionsHeight = 1 << 13 }
	Flags which control scalebar renderer behavior. More...

Protected Member Functions inherited from QgsScaleBarRenderer
void	drawDefaultLabels (QgsRenderContext &context, const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const
	Draws default scalebar labels using the specified settings and scaleContext to a destination render context. More...

QString	firstLabelString (const QgsScaleBarSettings &settings) const
	Returns the text used for the first label in the scalebar. More...

Q_DECL_DEPRECATED double	firstLabelXOffset (const QgsScaleBarSettings &settings) const
	Returns the x-offset (in millimeters) used for the first label in the scalebar. More...

double	firstLabelXOffset (const QgsScaleBarSettings &settings, const QgsRenderContext &context, const ScaleBarContext &scaleContext) const
	Returns the x-offset (in render context painter units) used for the first label in the scalebar. More...

Q_DECL_DEPRECATED QList< double >	segmentPositions (const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
	Returns a list of positions for each segment within the scalebar. More...

QList< double >	segmentPositions (QgsRenderContext &context, const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
	Returns a list of positions for each segment within the scalebar. More...

QList< double >	segmentWidths (const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
	Returns a list of widths of each segment of the scalebar. More...

Detailed Description

Scalebar style that draws a single box with alternating color for the segments, with horizontal lines through alternating segments.

AKA "South African" style.

Since: QGIS 3.14

Definition at line 31 of file qgshollowscalebarrenderer.h.

Constructor & Destructor Documentation

◆ QgsHollowScaleBarRenderer()

QgsHollowScaleBarRenderer::QgsHollowScaleBarRenderer ( )

default

Constructor for QgsHollowScaleBarRenderer.

Member Function Documentation

◆ applyDefaultSettings()

bool QgsHollowScaleBarRenderer::applyDefaultSettings ( QgsScaleBarSettings & settings ) const

overridevirtual

Applies any default settings relating to the scalebar to the passed settings object.

Returns true if settings were applied.

Since: QGIS 3.14

Reimplemented from QgsScaleBarRenderer.

Definition at line 179 of file qgshollowscalebarrenderer.cpp.

◆ clone()

QgsHollowScaleBarRenderer * QgsHollowScaleBarRenderer::clone ( ) const

overridevirtual

Returns a clone of the renderer.

The caller takes ownership of the returned value.

Implements QgsScaleBarRenderer.

Definition at line 57 of file qgshollowscalebarrenderer.cpp.

◆ draw()

void QgsHollowScaleBarRenderer::draw	(	QgsRenderContext &	context,
		const QgsScaleBarSettings &	settings,
		const QgsScaleBarRenderer::ScaleBarContext &	scaleContext
	)		const