A scale bar item that can be added to a map composition. More...

#include <qgscomposerscalebar.h>

Inheritance diagram for QgsComposerScaleBar:

Collaboration diagram for QgsComposerScaleBar:

Public Types
enum	Alignment { Left = 0, Middle, Right }
	Added in version 1.8. More...
enum	ScaleBarUnits { MapUnits = 0, Meters, Feet }
	Added in version 1.9. More...
Public Slots
void	invalidateCurrentMap ()
	Sets mCompositionMap to 0 if the map is deleted.
void	updateSegmentSize ()
Public Member Functions
	QgsComposerScaleBar (QgsComposition *composition)
	~QgsComposerScaleBar ()
void	adjustBoxSize ()
	Sets box size suitable to content.
Alignment	alignment () const
	Left / Middle/ Right.
void	applyDefaultSettings ()
	Apply default settings.
void	applyDefaultSize ()
	Apply default size (scale bar 1/5 of map item width)
double	boxContentSpace () const
QBrush	brush () const
const QgsComposerMap *	composerMap () const
void	correctXPositionAlignment (double width, double widthAfter)
	Moves scalebar position to the left / right depending on alignment and change in item width.
QString	firstLabelString () const
	Returns string of first label (important for drawing, labeling, size calculation.
QFont	font () const
QColor	fontColor () const
double	height () const
double	labelBarSpace () const
double	numMapUnitsPerScaleBarUnit () const
int	numSegments () const
int	numSegmentsLeft () const
double	numUnitsPerSegment () const
void	paint (QPainter painter, const QStyleOptionGraphicsItem itemStyle, QWidget *pWidget)
	Reimplementation of QCanvasItem::paint.
QPen	pen () const
bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	sets state from Dom document
double	segmentMillimeters () const
void	segmentPositions (QList< QPair< double, double > > &posWidthList) const
	Returns the x - positions of the segment borders (in item coordinates) and the width of the segment.
void	setAlignment (Alignment a)
void	setBoxContentSpace (double space)
void	setBrush (const QBrush &brush)
void	setComposerMap (const QgsComposerMap *map)
void	setFont (const QFont &font)
void	setFontColor (const QColor &c)
void	setHeight (double h)
void	setLabelBarSpace (double space)
void	setNumMapUnitsPerScaleBarUnit (double d)
void	setNumSegments (int nSegments)
void	setNumSegmentsLeft (int nSegmentsLeft)
void	setNumUnitsPerSegment (double units)
void	setPen (const QPen &pen)
void	setStyle (const QString &styleName)
	Sets style by name.
void	setUnitLabeling (const QString &label)
void	setUnits (ScaleBarUnits u)
QString	style () const
	Returns style name.
virtual int	type () const
	return correct graphics item type.
QString	unitLabeling () const
ScaleBarUnits	units () const
void	update ()
	Adjusts box size and calls QgsComposerItem::update()
bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	stores state in Dom element
Protected Member Functions
double	mapWidth () const
	Returns diagonal of composer map in selected units (map units / meters / feet)
void	refreshSegmentMillimeters ()
	Calculates with of a segment in mm and stores it in mSegmentMillimeters.
Protected Attributes
Alignment	mAlignment
double	mBoxContentSpace
	Space between content and item box.
QBrush	mBrush
	Fill.
const QgsComposerMap *	mComposerMap
	Reference to composer map object.
QFont	mFont
	Font.
QColor	mFontColor
double	mHeight
	Height of bars/lines.
double	mLabelBarSpace
	Space between bar and Text labels.
double	mNumMapUnitsPerScaleBarUnit
	Number of map units per scale bar units (e.g.
int	mNumSegments
	Number of segments on right side.
int	mNumSegmentsLeft
	Number of segments on left side.
double	mNumUnitsPerSegment
	Size of a segment (in map units)
QPen	mPen
	Outline.
double	mSegmentMillimeters
	Width of a segment (in mm)
QgsScaleBarStyle *	mStyle
	Scalebar style.
QString	mUnitLabeling
	Labeling of map units.
ScaleBarUnits	mUnits

Detailed Description

A scale bar item that can be added to a map composition.

Definition at line 30 of file qgscomposerscalebar.h.

Member Enumeration Documentation

enum QgsComposerScaleBar::Alignment

Added in version 1.8.

Enumerator:

Left
Middle
Right

Definition at line 37 of file qgscomposerscalebar.h.

enum QgsComposerScaleBar::ScaleBarUnits

Added in version 1.9.

Enumerator:

MapUnits
Meters
Feet

Definition at line 45 of file qgscomposerscalebar.h.

Constructor & Destructor Documentation

QgsComposerScaleBar::QgsComposerScaleBar ( QgsComposition * composition )

Definition at line 36 of file qgscomposerscalebar.cpp.

References applyDefaultSettings(), and applyDefaultSize().

QgsComposerScaleBar::~QgsComposerScaleBar ( )

Definition at line 50 of file qgscomposerscalebar.cpp.

References mStyle.

Member Function Documentation

void QgsComposerScaleBar::adjustBoxSize ( )

Sets box size suitable to content.

Definition at line 268 of file qgscomposerscalebar.cpp.

References QgsScaleBarStyle::calculateBoxSize(), mStyle, and QgsComposerItem::setSceneRect().

Referenced by applyDefaultSize(), setFont(), and update().

Alignment QgsComposerScaleBar::alignment ( void ) const [inline]

Left / Middle/ Right.

Note:: : this method was added in version 1.8

Definition at line 106 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::applyDefaultSettings ( )

Apply default settings.

Definition at line 212 of file qgscomposerscalebar.cpp.

References QgsComposerItem::itemChanged(), mBoxContentSpace, mBrush, mFont, mFontColor, mHeight, mLabelBarSpace, mNumMapUnitsPerScaleBarUnit, mNumSegments, mNumSegmentsLeft, mPen, and mStyle.

Referenced by QgsComposerScaleBar().

void QgsComposerScaleBar::applyDefaultSize ( )

Apply default size (scale bar 1/5 of map item width)

Note:: this method was added in version 1.7

Definition at line 239 of file qgscomposerscalebar.cpp.

References adjustBoxSize(), QgsComposerItem::itemChanged(), mapWidth(), mComposerMap, Meters, numUnitsPerSegment(), refreshSegmentMillimeters(), setNumMapUnitsPerScaleBarUnit(), setNumSegments(), setNumSegmentsLeft(), setNumUnitsPerSegment(), setUnitLabeling(), setUnits(), and tr.

Referenced by QgsComposerView::mousePressEvent(), and QgsComposerScaleBar().

double QgsComposerScaleBar::boxContentSpace ( ) const [inline]

Definition at line 99 of file qgscomposerscalebar.h.

Referenced by QgsNumericScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::calculateBoxSize(), QgsNumericScaleBarStyle::draw(), QgsDoubleBoxScaleBarStyle::draw(), QgsSingleBoxScaleBarStyle::draw(), QgsTicksScaleBarStyle::draw(), and QgsScaleBarStyle::drawLabels().

QBrush QgsComposerScaleBar::brush ( ) const [inline]

Definition at line 87 of file qgscomposerscalebar.h.

Referenced by QgsDoubleBoxScaleBarStyle::draw(), and QgsSingleBoxScaleBarStyle::draw().

const QgsComposerMap* QgsComposerScaleBar::composerMap ( ) const [inline]

Definition at line 94 of file qgscomposerscalebar.h.

Referenced by readXML(), and QgsNumericScaleBarStyle::scaleText().

void QgsComposerScaleBar::correctXPositionAlignment	(	double	width,
		double	widthAfter
	)

Moves scalebar position to the left / right depending on alignment and change in item width.

Definition at line 503 of file qgscomposerscalebar.cpp.

References mAlignment, Middle, QgsComposerItem::move(), and Right.

Referenced by setBoxContentSpace(), setNumSegments(), setNumSegmentsLeft(), setNumUnitsPerSegment(), and updateSegmentSize().

QString QgsComposerScaleBar::firstLabelString ( ) const

Returns string of first label (important for drawing, labeling, size calculation.

Definition at line 369 of file qgscomposerscalebar.cpp.

References mNumMapUnitsPerScaleBarUnit, mNumSegmentsLeft, and mNumUnitsPerSegment.

Referenced by QgsScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::drawLabels(), and paint().

QFont QgsComposerScaleBar::font ( ) const

Definition at line 381 of file qgscomposerscalebar.cpp.

References mFont.

Referenced by QgsNumericScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::calculateBoxSize(), QgsDoubleBoxScaleBarStyle::draw(), QgsNumericScaleBarStyle::draw(), QgsSingleBoxScaleBarStyle::draw(), QgsTicksScaleBarStyle::draw(), QgsScaleBarStyle::drawLabels(), and setFont().

QColor QgsComposerScaleBar::fontColor ( ) const [inline]

Definition at line 79 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::drawLabels().

double QgsComposerScaleBar::height ( ) const [inline]

Definition at line 90 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::calculateBoxSize(), QgsDoubleBoxScaleBarStyle::draw(), QgsSingleBoxScaleBarStyle::draw(), and QgsTicksScaleBarStyle::draw().

void QgsComposerScaleBar::invalidateCurrentMap ( ) [slot]

Sets mCompositionMap to 0 if the map is deleted.

Definition at line 155 of file qgscomposerscalebar.cpp.

References mComposerMap, and updateSegmentSize().

Referenced by readXML(), and setComposerMap().

double QgsComposerScaleBar::labelBarSpace ( ) const [inline]

Definition at line 96 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::calculateBoxSize(), QgsDoubleBoxScaleBarStyle::draw(), QgsSingleBoxScaleBarStyle::draw(), and QgsTicksScaleBarStyle::draw().

double QgsComposerScaleBar::mapWidth ( ) const [protected]

Returns diagonal of composer map in selected units (map units / meters / feet)

Definition at line 177 of file qgscomposerscalebar.cpp.

References QgsMapRenderer::destinationCrs(), QgsComposerMap::extent(), Feet, QgsMapRenderer::hasCrsTransformEnabled(), QgsProject::instance(), QgsComposerMap::mapRenderer(), MapUnits, mComposerMap, QgsDistanceArea::measureLine(), mUnits, QgsDistanceArea::setEllipsoid(), QgsDistanceArea::setEllipsoidalMode(), QgsDistanceArea::setSourceCrs(), QgsCoordinateReferenceSystem::srsid(), QgsRectangle::width(), QgsRectangle::xMaximum(), QgsRectangle::xMinimum(), and QgsRectangle::yMinimum().

Referenced by applyDefaultSize(), and refreshSegmentMillimeters().

double QgsComposerScaleBar::numMapUnitsPerScaleBarUnit ( ) const [inline]

Definition at line 71 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::calculateBoxSize(), and QgsScaleBarStyle::drawLabels().

int QgsComposerScaleBar::numSegments ( ) const [inline]

Definition at line 62 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::calculateBoxSize().

int QgsComposerScaleBar::numSegmentsLeft ( ) const [inline]

Definition at line 65 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::drawLabels().

double QgsComposerScaleBar::numUnitsPerSegment ( ) const [inline]

Definition at line 68 of file qgscomposerscalebar.h.

Referenced by applyDefaultSize(), QgsScaleBarStyle::calculateBoxSize(), and QgsScaleBarStyle::drawLabels().

void QgsComposerScaleBar::paint	(	QPainter *	painter,
		const QStyleOptionGraphicsItem *	itemStyle,
		QWidget *	pWidget
	)

Reimplementation of QCanvasItem::paint.

Definition at line 55 of file qgscomposerscalebar.cpp.

References QgsScaleBarStyle::draw(), QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), QgsComposerItem::drawSelectionBoxes(), firstLabelString(), mFont, mStyle, and QgsComposerItem::textWidthMillimeters().

QPen QgsComposerScaleBar::pen ( ) const [inline]

Definition at line 84 of file qgscomposerscalebar.h.

Referenced by QgsNumericScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::calculateBoxSize(), QgsNumericScaleBarStyle::draw(), QgsDoubleBoxScaleBarStyle::draw(), QgsSingleBoxScaleBarStyle::draw(), and QgsTicksScaleBarStyle::draw().

bool QgsComposerScaleBar::readXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc
	)		`[virtual]`

sets state from Dom document

Parameters:

itemElem	is Dom node corresponding to item tag
doc	is Dom document

Implements QgsComposerItem.

Definition at line 439 of file qgscomposerscalebar.cpp.

References QgsComposerItem::_readXML(), composerMap(), QgsComposition::getComposerMapById(), invalidateCurrentMap(), mAlignment, mBoxContentSpace, mBrush, mComposerMap, QgsComposerItem::mComposition, mFont, mFontColor, mHeight, mLabelBarSpace, mNumMapUnitsPerScaleBarUnit, mNumSegments, mNumSegmentsLeft, mNumUnitsPerSegment, mPen, mSegmentMillimeters, mStyle, mUnitLabeling, mUnits, setStyle(), tr, and updateSegmentSize().

Referenced by QgsComposition::addItemsFromXML().

void QgsComposerScaleBar::refreshSegmentMillimeters ( ) [protected]

Calculates with of a segment in mm and stores it in mSegmentMillimeters.

Definition at line 162 of file qgscomposerscalebar.cpp.

References QgsComposerMap::extent(), mapWidth(), mComposerMap, mNumUnitsPerSegment, and mSegmentMillimeters.

Referenced by applyDefaultSize(), setComposerMap(), setNumUnitsPerSegment(), setUnits(), and updateSegmentSize().

double QgsComposerScaleBar::segmentMillimeters ( ) const [inline]

Definition at line 102 of file qgscomposerscalebar.h.

Referenced by QgsTicksScaleBarStyle::draw(), and QgsScaleBarStyle::drawLabels().

void QgsComposerScaleBar::segmentPositions ( QList< QPair< double, double > > & posWidthList ) const

Returns the x - positions of the segment borders (in item coordinates) and the width of the segment.

Definition at line 299 of file qgscomposerscalebar.cpp.

References mBoxContentSpace, mNumSegments, mNumSegmentsLeft, mPen, and mSegmentMillimeters.

Referenced by QgsScaleBarStyle::calculateBoxSize(), QgsDoubleBoxScaleBarStyle::draw(), QgsSingleBoxScaleBarStyle::draw(), QgsTicksScaleBarStyle::draw(), and QgsScaleBarStyle::drawLabels().

void QgsComposerScaleBar::setAlignment ( Alignment a ) [inline]

Note:: : this method was added in version 1.8

Definition at line 109 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setBoxContentSpace ( double space )

Definition at line 123 of file qgscomposerscalebar.cpp.

References QgsScaleBarStyle::calculateBoxSize(), correctXPositionAlignment(), QgsComposerItem::itemChanged(), mBoxContentSpace, and mStyle.

void QgsComposerScaleBar::setBrush ( const QBrush & brush ) [inline]

Definition at line 88 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setComposerMap ( const QgsComposerMap * map )

Definition at line 137 of file qgscomposerscalebar.cpp.

References invalidateCurrentMap(), QgsComposerItem::itemChanged(), mComposerMap, refreshSegmentMillimeters(), and updateSegmentSize().

Referenced by QgsComposerView::mousePressEvent().

void QgsComposerScaleBar::setFont ( const QFont & font )

Definition at line 386 of file qgscomposerscalebar.cpp.

References adjustBoxSize(), font(), QgsComposerItem::itemChanged(), mFont, and update().

void QgsComposerScaleBar::setFontColor ( const QColor & c ) [inline]

Definition at line 80 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setHeight ( double h ) [inline]

Definition at line 91 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setLabelBarSpace ( double space ) [inline]

Definition at line 97 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setNumMapUnitsPerScaleBarUnit ( double d ) [inline]

Definition at line 72 of file qgscomposerscalebar.h.

Referenced by applyDefaultSize().

void QgsComposerScaleBar::setNumSegments ( int nSegments )

Definition at line 80 of file qgscomposerscalebar.cpp.

References QgsScaleBarStyle::calculateBoxSize(), correctXPositionAlignment(), QgsComposerItem::itemChanged(), mNumSegments, and mStyle.

Referenced by applyDefaultSize().

void QgsComposerScaleBar::setNumSegmentsLeft ( int nSegmentsLeft )

Definition at line 109 of file qgscomposerscalebar.cpp.

References QgsScaleBarStyle::calculateBoxSize(), correctXPositionAlignment(), QgsComposerItem::itemChanged(), mNumSegmentsLeft, and mStyle.

Referenced by applyDefaultSize().

void QgsComposerScaleBar::setNumUnitsPerSegment ( double units )

Definition at line 94 of file qgscomposerscalebar.cpp.

References QgsScaleBarStyle::calculateBoxSize(), correctXPositionAlignment(), QgsComposerItem::itemChanged(), mNumUnitsPerSegment, mStyle, refreshSegmentMillimeters(), and units().

Referenced by applyDefaultSize().

void QgsComposerScaleBar::setPen ( const QPen & pen ) [inline]

Definition at line 85 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setStyle ( const QString & styleName )

Sets style by name.

Parameters:

styleName (untranslated) style name. Possibilities are: 'Single Box', 'Double Box', 'Line Ticks Middle', 'Line Ticks Down', 'Line Ticks Up', 'Numeric'

Definition at line 319 of file qgscomposerscalebar.cpp.

References QgsComposerItem::itemChanged(), mStyle, QgsTicksScaleBarStyle::setTickPosition(), QgsTicksScaleBarStyle::TicksDown, QgsTicksScaleBarStyle::TicksMiddle, and QgsTicksScaleBarStyle::TicksUp.

Referenced by readXML().

void QgsComposerScaleBar::setUnitLabeling ( const QString & label ) [inline]

Definition at line 75 of file qgscomposerscalebar.h.

Referenced by applyDefaultSize().

void QgsComposerScaleBar::setUnits ( ScaleBarUnits u )