A scale bar style that draws text in the form of '1:XXXXX'. More...

#include <qgsnumericscalebarrenderer.h>

Inheritance diagram for QgsNumericScaleBarRenderer:

Public Member Functions
	QgsNumericScaleBarRenderer ()=default

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

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

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

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.

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

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

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

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

Public Member Functions inherited from QgsScaleBarRenderer
	QgsScaleBarRenderer ()=default

virtual	~QgsScaleBarRenderer ()=default

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

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

Additional Inherited Members
Public Types inherited from QgsScaleBarRenderer
enum class	Flag : int { 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...

typedef QFlags< Flag >	Flags

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.

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

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

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.

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.

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

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

Detailed Description

A scale bar style that draws text in the form of '1:XXXXX'.

Definition at line 29 of file qgsnumericscalebarrenderer.h.

Constructor & Destructor Documentation

◆ QgsNumericScaleBarRenderer()

QgsNumericScaleBarRenderer::QgsNumericScaleBarRenderer ( )

default

Member Function Documentation

◆ calculateBoxSize() [1/2]

QSizeF QgsNumericScaleBarRenderer::calculateBoxSize	(	const QgsScaleBarSettings &	settings,
		const QgsScaleBarRenderer::ScaleBarContext &	scaleContext
	)		const

overridevirtual

Calculates the required box size (in millimeters) for a scalebar using the specified settings and scaleContext.

Deprecated:: QGIS 3.40. Use the version with a QgsRenderContext instead.

Reimplemented from QgsScaleBarRenderer.

Definition at line 96 of file qgsnumericscalebarrenderer.cpp.

◆ calculateBoxSize() [2/2]

QSizeF QgsNumericScaleBarRenderer::calculateBoxSize	(	QgsRenderContext &	context,
		const QgsScaleBarSettings &	settings,
		const QgsScaleBarRenderer::ScaleBarContext &	scaleContext
	)		const

overridevirtual

Calculates the required box size (in millimeters) for a scalebar using the specified settings and scaleContext.

Since: QGIS 3.14

Reimplemented from QgsScaleBarRenderer.

Definition at line 84 of file qgsnumericscalebarrenderer.cpp.

◆ clone()

QgsNumericScaleBarRenderer * QgsNumericScaleBarRenderer::clone ( ) const

overridevirtual

Returns a clone of the renderer.

The caller takes ownership of the returned value.

Implements QgsScaleBarRenderer.

Definition at line 45 of file qgsnumericscalebarrenderer.cpp.

◆ draw()

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

overridevirtual

Draws the scalebar using the specified settings and scaleContext to a destination render context.

Implements QgsScaleBarRenderer.

Definition at line 50 of file qgsnumericscalebarrenderer.cpp.

◆ flags()

QgsScaleBarRenderer::Flags QgsNumericScaleBarRenderer::flags ( ) const

overridevirtual

Returns the scalebar rendering flags, which dictates the renderer's behavior.

Since: QGIS 3.14

Reimplemented from QgsScaleBarRenderer.

Definition at line 40 of file qgsnumericscalebarrenderer.cpp.

◆ id()

QString QgsNumericScaleBarRenderer::id ( ) const

overridevirtual

Returns the unique ID for this renderer.

Since: QGIS 3.14

Implements QgsScaleBarRenderer.

Definition at line 25 of file qgsnumericscalebarrenderer.cpp.

◆ sortKey()

int QgsNumericScaleBarRenderer::sortKey ( ) const

overridevirtual

Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists.

Generally, subclasses should return QgsScaleBarRenderer::sortKey() as their sorting key.

Reimplemented from QgsScaleBarRenderer.

Definition at line 35 of file qgsnumericscalebarrenderer.cpp.

◆ visibleName()

QString QgsNumericScaleBarRenderer::visibleName ( ) const

overridevirtual

Returns the user friendly, translated name for the renderer.

Since: QGIS 3.14

Implements QgsScaleBarRenderer.

Definition at line 30 of file qgsnumericscalebarrenderer.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/scalebar/qgsnumericscalebarrenderer.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/scalebar/qgsnumericscalebarrenderer.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsNumericScaleBarRenderer()

Member Function Documentation

◆ calculateBoxSize() [1/2]

◆ calculateBoxSize() [2/2]

◆ clone()

◆ draw()

◆ flags()

◆ id()

◆ sortKey()

◆ visibleName()