Ui::ScaleQuickItem Class Reference

QML Class implementing a scale for a Map. More...

#include <ScaleQuickItem.h>

Signals
void	colorChanged ()
	Notification signal for property with the same name.
void	pixelPer10kmChanged ()
	Notification signal for property with the same name.
void	verticalChanged ()
	Notification signal for property with the same name.

Public Member Functions
	ScaleQuickItem (QQuickItem *parent=nullptr)
	Standard constructor.
QColor	color () const
	Getter function for the property with the same name.
void	setColor (QColor _color)
	Setter function for the property with the same name.
auto	pixelPer10km () const -> qreal
	Getter function for the property with the same name.
void	setPixelPer10km (qreal _pxp10k)
	Setter function for the property with the same name.
void	paint (QPainter *painter) override
	Re-implemented from QQuickPaintedItem to implement painting.
auto	vertical () const -> bool
	Getter function for the property with the same name.
void	setVertical (bool newVertical)
	Setter function for the property with the same name.

Properties
QColor	color
	Foreground color.
qreal	pixelPer10km
	Number of pixel that represent a distance of 10km on the map.
bool	vertical
	Determines whether the scale should be drawn vertically or horizontally.

Detailed Description

QML Class implementing a scale for a Map.

This class implements a QML item that draws a scale, to be added to a map. To work, the property pixelPer10km needs to be set, according to the scale of the map. To use this class, export it to QML, add it to your view and make sure that the property pixelPer10km get set accordingly.

The methods of this class are re-entrant, but not thread safe.

Definition at line 38 of file ScaleQuickItem.h.

Constructor & Destructor Documentation

ScaleQuickItem()

Ui::ScaleQuickItem::ScaleQuickItem ( QQuickItem * parent = nullptr )

explicit

Standard constructor.

Parameters

parent

The standard QObject parent pointer

Member Function Documentation

color()

QColor Ui::ScaleQuickItem::color ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns

Property pixelPer10km

Definition at line 60 of file ScaleQuickItem.h.

paint()

void Ui::ScaleQuickItem::paint ( QPainter * painter )

override

Re-implemented from QQuickPaintedItem to implement painting.

Parameters

painter

Pointer to the QPainter used for painting

pixelPer10km()

auto Ui::ScaleQuickItem::pixelPer10km ( ) const -> qreal

inlinenodiscard

Getter function for the property with the same name.

Returns

Property pixelPer10km

Definition at line 75 of file ScaleQuickItem.h.

setColor()

void Ui::ScaleQuickItem::setColor

(

QColor

_color

)

Setter function for the property with the same name.

Parameters

_color

Property color

setPixelPer10km()

void Ui::ScaleQuickItem::setPixelPer10km

(

qreal

_pxp10k

)

Setter function for the property with the same name.

Parameters

_pxp10k

Property pixelPer10km

setVertical()

void Ui::ScaleQuickItem::setVertical

(

bool

newVertical

)

Setter function for the property with the same name.

Parameters

newVertical

Property vertical

vertical()

auto Ui::ScaleQuickItem::vertical ( ) const -> bool

inlinenodiscard

Getter function for the property with the same name.

Returns

Property vertical

Definition at line 99 of file ScaleQuickItem.h.

Property Documentation

vertical

bool Ui::ScaleQuickItem::vertical

readwrite

Determines whether the scale should be drawn vertically or horizontally.

This property defaults to 'false'.

Definition at line 93 of file ScaleQuickItem.h.

---

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

• /home/runner/work/enroute/enroute/src/ui/ScaleQuickItem.h