Holds all configurable appearance properties for the map scale bar. More...

#include <scalebarsettings.h>

Inheritance diagram for ScaleBarSettings:

Collaboration diagram for ScaleBarSettings:

Public Types
enum	Units { Auto , Meters , Feet , Kilometers , Miles }

enum	Position { BottomLeft , BottomRight , TopLeft , TopRight }

Signals
void	changed ()

Public Member Functions
	ScaleBarSettings (QObject *parent=nullptr)

QPen	pen () const

QFont	font () const

Units	units () const

Position	position () const

int	maxBarLength () const

int	labelDecimals () const

bool	compactNotation () const

void	setPen (const QPen &pen)

void	setFont (const QFont &font)

void	setUnits (Units units)

void	setPosition (Position position)

void	setMaxBarLength (int length)

void	setLabelDecimals (int decimals)

void	setCompactNotation (bool compact)

QString	formatLabel (double metres, bool rawUnits=false) const
	Format a distance (in metres) as a string using the current units setting.

double	roundedMetres (double metres) const
	Returns the metres value that `formatLabel()` will actually display, i.e. the input rounded in the active unit. Use this to sync bar length to the label.

Properties
QPen	pen

QFont	font

Units	units

Position	position

int	maxBarLength

int	labelDecimals

bool	compactNotation

Detailed Description

Holds all configurable appearance properties for the map scale bar.

Owned by MapCanvas as a child QObject and exposed via a CONSTANT Q_PROPERTY so it can be passed directly to QPropertyModel for live editing.

Connect the changed() signal to MapCanvas::update() so any property change immediately repaints the canvas.

Member Enumeration Documentation

◆ Position

enum ScaleBarSettings::Position

Enumerator
BottomLeft
BottomRight
TopLeft
TopRight

◆ Units

enum ScaleBarSettings::Units

Enumerator
Auto
Meters
Feet
Kilometers
Miles

Constructor & Destructor Documentation

◆ ScaleBarSettings()

ScaleBarSettings::ScaleBarSettings ( QObject * parent = nullptr )

explicit

Member Function Documentation

◆ changed

void ScaleBarSettings::changed ( )

signal

Here is the caller graph for this function:

◆ compactNotation()

bool ScaleBarSettings::compactNotation ( ) const

inline

◆ font()

QFont ScaleBarSettings::font ( ) const

inline

◆ formatLabel()

QString ScaleBarSettings::formatLabel	(	double	metres,
		bool	rawUnits = `false`
	)		const

Format a distance (in metres) as a string using the current units setting.

Parameters

metres	Distance in metres.
rawUnits	When true, ignores the Units setting and appends "units" (used for local / undefined CRS where no real-world unit is known).

Here is the caller graph for this function:

◆ labelDecimals()

int ScaleBarSettings::labelDecimals ( ) const

inline

◆ maxBarLength()

int ScaleBarSettings::maxBarLength ( ) const

inline

◆ pen()

QPen ScaleBarSettings::pen ( ) const

inline

◆ position()

Position ScaleBarSettings::position ( ) const

inline

◆ roundedMetres()

double ScaleBarSettings::roundedMetres ( double metres ) const

Returns the metres value that formatLabel() will actually display, i.e. the input rounded in the active unit. Use this to sync bar length to the label.

Here is the caller graph for this function: