A scale bar that draws segments using short ticks. More...

#include <qgsticksscalebarrenderer.h>

Inheritance diagram for QgsTicksScaleBarRenderer:

Public Types
enum	TickPosition { TicksUp , TicksDown , TicksMiddle }
	Tick positions. More...

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

Public Member Functions
	QgsTicksScaleBarRenderer (TickPosition position=TicksMiddle)
	Constructor for QgsTicksScaleBarRenderer.

QgsTicksScaleBarRenderer *	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.

void	setTickPosition (TickPosition position)
	Sets the position for tick marks in the scalebar.

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

TickPosition	tickPosition () const
	Returns the position for tick marks in the scalebar.

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.

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.

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.

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

Additional Inherited Members
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 that draws segments using short ticks.

Definition at line 28 of file qgsticksscalebarrenderer.h.

Member Enumeration Documentation

◆ TickPosition

enum QgsTicksScaleBarRenderer::TickPosition

Tick positions.

Enumerator
TicksUp	Render ticks above line.
TicksDown	Render ticks below line.
TicksMiddle	Render ticks crossing line.

Definition at line 33 of file qgsticksscalebarrenderer.h.

Constructor & Destructor Documentation

◆ QgsTicksScaleBarRenderer()

QgsTicksScaleBarRenderer::QgsTicksScaleBarRenderer ( QgsTicksScaleBarRenderer::TickPosition position = TicksMiddle )

Constructor for QgsTicksScaleBarRenderer.

Definition at line 24 of file qgsticksscalebarrenderer.cpp.

Member Function Documentation

◆ clone()

QgsTicksScaleBarRenderer * QgsTicksScaleBarRenderer::clone ( ) const

overridevirtual

Returns a clone of the renderer.

The caller takes ownership of the returned value.

Implements QgsScaleBarRenderer.

Definition at line 89 of file qgsticksscalebarrenderer.cpp.

◆ draw()

void QgsTicksScaleBarRenderer::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 94 of file qgsticksscalebarrenderer.cpp.

◆ flags()

QgsScaleBarRenderer::Flags QgsTicksScaleBarRenderer::flags ( ) const

overridevirtual

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

Since: QGIS 3.14

Reimplemented from QgsScaleBarRenderer.

Definition at line 73 of file qgsticksscalebarrenderer.cpp.

◆ id()

QString QgsTicksScaleBarRenderer::id ( ) const

overridevirtual

Returns the unique ID for this renderer.

Since: QGIS 3.14

Implements QgsScaleBarRenderer.

Definition at line 30 of file qgsticksscalebarrenderer.cpp.

◆ setTickPosition()

void QgsTicksScaleBarRenderer::setTickPosition ( TickPosition position )

inline

Sets the position for tick marks in the scalebar.

See also: tickPosition()

Definition at line 59 of file qgsticksscalebarrenderer.h.

◆ sortKey()

int QgsTicksScaleBarRenderer::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 59 of file qgsticksscalebarrenderer.cpp.

◆ tickPosition()

TickPosition QgsTicksScaleBarRenderer::tickPosition ( ) const

inline

Returns the position for tick marks in the scalebar.

See also: setTickPosition()

Definition at line 65 of file qgsticksscalebarrenderer.h.

◆ visibleName()

QString QgsTicksScaleBarRenderer::visibleName ( ) const

overridevirtual

Returns the user friendly, translated name for the renderer.

Since: QGIS 3.14

Implements QgsScaleBarRenderer.

Definition at line 44 of file qgsticksscalebarrenderer.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/scalebar/qgsticksscalebarrenderer.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/scalebar/qgsticksscalebarrenderer.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TickPosition

Constructor & Destructor Documentation

◆ QgsTicksScaleBarRenderer()

Member Function Documentation

◆ clone()

◆ draw()

◆ flags()

◆ id()

◆ setTickPosition()

◆ sortKey()

◆ tickPosition()

◆ visibleName()