Quantum GIS API Documentation
1.8
|
A scale bar item that can be added to a map composition. More...
#include <qgscomposerscalebar.h>
Public Types | |
enum | Alignment { Left = 0, Middle, Right } |
Added in version 1.8. More... | |
Public Slots | |
void | updateSegmentSize () |
void | invalidateCurrentMap () |
Sets mCompositionMap to 0 if the map is deleted. | |
Public Member Functions | |
QgsComposerScaleBar (QgsComposition *composition) | |
~QgsComposerScaleBar () | |
virtual int | type () const |
return correct graphics item type. | |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) |
Reimplementation of QCanvasItem::paint. | |
int | numSegments () const |
void | setNumSegments (int nSegments) |
int | numSegmentsLeft () const |
void | setNumSegmentsLeft (int nSegmentsLeft) |
double | numUnitsPerSegment () const |
void | setNumUnitsPerSegment (double units) |
double | numMapUnitsPerScaleBarUnit () const |
void | setNumMapUnitsPerScaleBarUnit (double d) |
QString | unitLabeling () const |
void | setUnitLabeling (const QString &label) |
QFont | font () const |
void | setFont (const QFont &font) |
QPen | pen () const |
void | setPen (const QPen &pen) |
QBrush | brush () const |
void | setBrush (const QBrush &brush) |
double | height () const |
void | setHeight (double h) |
void | setComposerMap (const QgsComposerMap *map) |
const QgsComposerMap * | composerMap () const |
double | labelBarSpace () const |
void | setLabelBarSpace (double space) |
double | boxContentSpace () const |
void | setBoxContentSpace (double space) |
double | segmentMillimeters () const |
Alignment | alignment () const |
Left / Middle/ Right. | |
void | setAlignment (Alignment a) |
void | applyDefaultSettings () |
Apply default settings. | |
void | applyDefaultSize () |
Apply default size (scale bar 1/5 of map item width) | |
void | setStyle (const QString &styleName) |
Sets style by name. | |
QString | style () const |
Returns style name. | |
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 | adjustBoxSize () |
Sets box size suitable to content. | |
void | update () |
Adjusts box size and calls QgsComposerItem::update() | |
QString | firstLabelString () const |
Returns string of first label (important for drawing, labeling, size calculation. | |
bool | writeXML (QDomElement &elem, QDomDocument &doc) const |
stores state in Dom element | |
bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) |
sets state from Dom document | |
void | correctXPositionAlignment (double width, double widthAfter) |
Moves scalebar position to the left / right depending on alignment and change in item width. | |
Protected Member Functions | |
void | refreshSegmentMillimeters () |
Calculates with of a segment in mm and stores it in mSegmentMillimeters. | |
Protected Attributes | |
const QgsComposerMap * | mComposerMap |
Reference to composer map object. | |
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) | |
double | mNumMapUnitsPerScaleBarUnit |
Number of map units per scale bar units (e.g. | |
QString | mUnitLabeling |
Labeling of map units. | |
QFont | mFont |
Font. | |
QPen | mPen |
Outline. | |
QBrush | mBrush |
Fill. | |
double | mHeight |
Height of bars/lines. | |
QgsScaleBarStyle * | mStyle |
Scalebar style. | |
double | mLabelBarSpace |
Space between bar and Text labels. | |
double | mBoxContentSpace |
Space between content and item box. | |
double | mSegmentMillimeters |
Width of a segment (in mm) | |
Alignment | mAlignment |
A scale bar item that can be added to a map composition.
Definition at line 28 of file qgscomposerscalebar.h.
Added in version 1.8.
Definition at line 36 of file qgscomposerscalebar.h.
QgsComposerScaleBar::QgsComposerScaleBar | ( | QgsComposition * | composition | ) |
Definition at line 31 of file qgscomposerscalebar.cpp.
References applyDefaultSettings(), and applyDefaultSize().
Definition at line 43 of file qgscomposerscalebar.cpp.
References mStyle.
void QgsComposerScaleBar::adjustBoxSize | ( | ) |
Sets box size suitable to content.
Definition at line 216 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.
Definition at line 94 of file qgscomposerscalebar.h.
Apply default settings.
Definition at line 171 of file qgscomposerscalebar.cpp.
References QgsComposerItem::itemChanged(), mBoxContentSpace, mBrush, mFont, mHeight, mLabelBarSpace, mNumMapUnitsPerScaleBarUnit, mNumSegments, mNumSegmentsLeft, mPen, and mStyle.
Referenced by QgsComposerScaleBar().
Apply default size (scale bar 1/5 of map item width)
Definition at line 197 of file qgscomposerscalebar.cpp.
References adjustBoxSize(), QgsComposerMap::extent(), QgsComposerItem::itemChanged(), mComposerMap, mNumSegments, mNumUnitsPerSegment, refreshSegmentMillimeters(), and QgsRectangle::width().
Referenced by QgsComposerView::mousePressEvent(), and QgsComposerScaleBar().
double QgsComposerScaleBar::boxContentSpace | ( | ) | const [inline] |
Definition at line 87 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 75 of file qgscomposerscalebar.h.
Referenced by QgsDoubleBoxScaleBarStyle::draw(), and QgsSingleBoxScaleBarStyle::draw().
const QgsComposerMap* QgsComposerScaleBar::composerMap | ( | ) | const [inline] |
Definition at line 82 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 447 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 317 of file qgscomposerscalebar.cpp.
References mNumMapUnitsPerScaleBarUnit, mNumSegmentsLeft, and mNumUnitsPerSegment.
Referenced by QgsScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::drawLabels(), and paint().
QFont QgsComposerScaleBar::font | ( | ) | const |
Definition at line 329 of file qgscomposerscalebar.cpp.
References mFont.
Referenced by QgsNumericScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::calculateBoxSize(), QgsDoubleBoxScaleBarStyle::draw(), QgsNumericScaleBarStyle::draw(), QgsSingleBoxScaleBarStyle::draw(), QgsTicksScaleBarStyle::draw(), QgsScaleBarStyle::drawLabels(), and setFont().
double QgsComposerScaleBar::height | ( | ) | const [inline] |
Definition at line 78 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 149 of file qgscomposerscalebar.cpp.
References mComposerMap, and updateSegmentSize().
Referenced by readXML(), and setComposerMap().
double QgsComposerScaleBar::labelBarSpace | ( | ) | const [inline] |
Definition at line 84 of file qgscomposerscalebar.h.
Referenced by QgsScaleBarStyle::calculateBoxSize(), QgsDoubleBoxScaleBarStyle::draw(), QgsSingleBoxScaleBarStyle::draw(), and QgsTicksScaleBarStyle::draw().
double QgsComposerScaleBar::numMapUnitsPerScaleBarUnit | ( | ) | const [inline] |
Definition at line 62 of file qgscomposerscalebar.h.
Referenced by QgsScaleBarStyle::calculateBoxSize(), and QgsScaleBarStyle::drawLabels().
int QgsComposerScaleBar::numSegments | ( | ) | const [inline] |
Definition at line 53 of file qgscomposerscalebar.h.
Referenced by QgsScaleBarStyle::calculateBoxSize().
int QgsComposerScaleBar::numSegmentsLeft | ( | ) | const [inline] |
Definition at line 56 of file qgscomposerscalebar.h.
Referenced by QgsScaleBarStyle::drawLabels().
double QgsComposerScaleBar::numUnitsPerSegment | ( | ) | const [inline] |
Definition at line 59 of file qgscomposerscalebar.h.
Referenced by QgsScaleBarStyle::calculateBoxSize(), and QgsScaleBarStyle::drawLabels().
void QgsComposerScaleBar::paint | ( | QPainter * | painter, |
const QStyleOptionGraphicsItem * | itemStyle, | ||
QWidget * | pWidget | ||
) |
Reimplementation of QCanvasItem::paint.
Definition at line 48 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 72 of file qgscomposerscalebar.h.
Referenced by QgsNumericScaleBarStyle::calculateBoxSize(), QgsScaleBarStyle::calculateBoxSize(), QgsNumericScaleBarStyle::draw(), and QgsTicksScaleBarStyle::draw().
bool QgsComposerScaleBar::readXML | ( | const QDomElement & | itemElem, |
const QDomDocument & | doc | ||
) | [virtual] |
sets state from Dom document
itemElem | is Dom node corresponding to item tag |
doc | is Dom document |
Implements QgsComposerItem.
Definition at line 389 of file qgscomposerscalebar.cpp.
References QgsComposerItem::_readXML(), composerMap(), QgsComposition::getComposerMapById(), invalidateCurrentMap(), mAlignment, mBoxContentSpace, mComposerMap, QgsComposerItem::mComposition, mFont, mHeight, mLabelBarSpace, mNumMapUnitsPerScaleBarUnit, mNumSegments, mNumSegmentsLeft, mNumUnitsPerSegment, mPen, mSegmentMillimeters, mStyle, mUnitLabeling, refreshSegmentMillimeters(), setStyle(), 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 156 of file qgscomposerscalebar.cpp.
References QgsComposerMap::extent(), mComposerMap, mNumUnitsPerSegment, mSegmentMillimeters, and QgsRectangle::width().
Referenced by applyDefaultSize(), readXML(), setComposerMap(), setNumUnitsPerSegment(), and updateSegmentSize().
double QgsComposerScaleBar::segmentMillimeters | ( | ) | const [inline] |
Definition at line 90 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 247 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] |
Definition at line 97 of file qgscomposerscalebar.h.
void QgsComposerScaleBar::setBoxContentSpace | ( | double | space | ) |
Definition at line 117 of file qgscomposerscalebar.cpp.
References QgsScaleBarStyle::calculateBoxSize(), correctXPositionAlignment(), QgsComposerItem::itemChanged(), mBoxContentSpace, and mStyle.
void QgsComposerScaleBar::setBrush | ( | const QBrush & | brush | ) | [inline] |
Definition at line 76 of file qgscomposerscalebar.h.
void QgsComposerScaleBar::setComposerMap | ( | const QgsComposerMap * | map | ) |
Definition at line 131 of file qgscomposerscalebar.cpp.
References invalidateCurrentMap(), QgsComposerItem::itemChanged(), mComposerMap, refreshSegmentMillimeters(), and updateSegmentSize().
Referenced by QgsComposition::addComposerScaleBar(), and QgsComposerView::mousePressEvent().
void QgsComposerScaleBar::setFont | ( | const QFont & | font | ) |
Definition at line 334 of file qgscomposerscalebar.cpp.
References adjustBoxSize(), font(), QgsComposerItem::itemChanged(), mFont, and update().
void QgsComposerScaleBar::setHeight | ( | double | h | ) | [inline] |
Definition at line 79 of file qgscomposerscalebar.h.
void QgsComposerScaleBar::setLabelBarSpace | ( | double | space | ) | [inline] |
Definition at line 85 of file qgscomposerscalebar.h.
void QgsComposerScaleBar::setNumMapUnitsPerScaleBarUnit | ( | double | d | ) | [inline] |
Definition at line 63 of file qgscomposerscalebar.h.
void QgsComposerScaleBar::setNumSegments | ( | int | nSegments | ) |
Definition at line 74 of file qgscomposerscalebar.cpp.
References QgsScaleBarStyle::calculateBoxSize(), correctXPositionAlignment(), QgsComposerItem::itemChanged(), mNumSegments, and mStyle.
void QgsComposerScaleBar::setNumSegmentsLeft | ( | int | nSegmentsLeft | ) |
Definition at line 103 of file qgscomposerscalebar.cpp.
References QgsScaleBarStyle::calculateBoxSize(), correctXPositionAlignment(), QgsComposerItem::itemChanged(), mNumSegmentsLeft, and mStyle.
void QgsComposerScaleBar::setNumUnitsPerSegment | ( | double | units | ) |
Definition at line 88 of file qgscomposerscalebar.cpp.
References QgsScaleBarStyle::calculateBoxSize(), correctXPositionAlignment(), QgsComposerItem::itemChanged(), mNumUnitsPerSegment, mStyle, and refreshSegmentMillimeters().
void QgsComposerScaleBar::setPen | ( | const QPen & | pen | ) | [inline] |
Definition at line 73 of file qgscomposerscalebar.h.
void QgsComposerScaleBar::setStyle | ( | const QString & | styleName | ) |
Sets style by name.
styleName | (untranslated) style name. Possibilities are: 'Single Box', 'Double Box', 'Line Ticks Middle', 'Line Ticks Down', 'Line Ticks Up', 'Numeric' |
Definition at line 267 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 66 of file qgscomposerscalebar.h.
QString QgsComposerScaleBar::style | ( | ) | const |
Returns style name.
Definition at line 305 of file qgscomposerscalebar.cpp.
References mStyle, and QgsScaleBarStyle::name().
virtual int QgsComposerScaleBar::type | ( | ) | const [inline, virtual] |
return correct graphics item type.
Added in v1.7
Reimplemented from QgsComposerItem.
Definition at line 47 of file qgscomposerscalebar.h.
References QgsComposerItem::ComposerScaleBar.
QString QgsComposerScaleBar::unitLabeling | ( | ) | const [inline] |
Definition at line 65 of file qgscomposerscalebar.h.
Referenced by QgsScaleBarStyle::calculateBoxSize(), and QgsScaleBarStyle::drawLabels().
void QgsComposerScaleBar::update | ( | ) |
Adjusts box size and calls QgsComposerItem::update()
Definition at line 227 of file qgscomposerscalebar.cpp.
References adjustBoxSize().
Referenced by setFont(), and updateSegmentSize().
void QgsComposerScaleBar::updateSegmentSize | ( | ) | [slot] |
Definition at line 233 of file qgscomposerscalebar.cpp.
References QgsScaleBarStyle::calculateBoxSize(), correctXPositionAlignment(), QgsComposerItem::itemChanged(), mStyle, refreshSegmentMillimeters(), and update().
Referenced by invalidateCurrentMap(), readXML(), and setComposerMap().
bool QgsComposerScaleBar::writeXML | ( | QDomElement & | elem, |
QDomDocument & | doc | ||
) | const [virtual] |
stores state in Dom element
elem | is Dom element corresponding to 'Composer' tag |
doc | Dom document |
Implements QgsComposerItem.
Definition at line 342 of file qgscomposerscalebar.cpp.
References QgsComposerItem::_writeXML(), QgsComposerMap::id(), mAlignment, mBoxContentSpace, mBrush, mComposerMap, mFont, mHeight, mLabelBarSpace, mNumMapUnitsPerScaleBarUnit, mNumSegments, mNumSegmentsLeft, mNumUnitsPerSegment, mPen, mSegmentMillimeters, mStyle, mUnitLabeling, and QgsScaleBarStyle::name().
Alignment QgsComposerScaleBar::mAlignment [protected] |
Definition at line 180 of file qgscomposerscalebar.h.
Referenced by correctXPositionAlignment(), readXML(), and writeXML().
double QgsComposerScaleBar::mBoxContentSpace [protected] |
Space between content and item box.
Definition at line 175 of file qgscomposerscalebar.h.
Referenced by applyDefaultSettings(), readXML(), segmentPositions(), setBoxContentSpace(), and writeXML().
QBrush QgsComposerScaleBar::mBrush [protected] |
Fill.
Definition at line 165 of file qgscomposerscalebar.h.
Referenced by applyDefaultSettings(), and writeXML().
const QgsComposerMap* QgsComposerScaleBar::mComposerMap [protected] |
Reference to composer map object.
Definition at line 148 of file qgscomposerscalebar.h.
Referenced by applyDefaultSize(), invalidateCurrentMap(), readXML(), refreshSegmentMillimeters(), setComposerMap(), and writeXML().
QFont QgsComposerScaleBar::mFont [protected] |
Font.
Definition at line 161 of file qgscomposerscalebar.h.
Referenced by applyDefaultSettings(), font(), paint(), readXML(), setFont(), and writeXML().
double QgsComposerScaleBar::mHeight [protected] |
Height of bars/lines.
Definition at line 167 of file qgscomposerscalebar.h.
Referenced by applyDefaultSettings(), readXML(), and writeXML().
double QgsComposerScaleBar::mLabelBarSpace [protected] |
Space between bar and Text labels.
Definition at line 172 of file qgscomposerscalebar.h.
Referenced by applyDefaultSettings(), readXML(), and writeXML().
double QgsComposerScaleBar::mNumMapUnitsPerScaleBarUnit [protected] |
Number of map units per scale bar units (e.g.
1000 to have km for a map with m units)
Definition at line 156 of file qgscomposerscalebar.h.
Referenced by applyDefaultSettings(), firstLabelString(), readXML(), and writeXML().
int QgsComposerScaleBar::mNumSegments [protected] |
Number of segments on right side.
Definition at line 150 of file qgscomposerscalebar.h.
Referenced by applyDefaultSettings(), applyDefaultSize(), readXML(), segmentPositions(), setNumSegments(), and writeXML().
int QgsComposerScaleBar::mNumSegmentsLeft [protected] |
Number of segments on left side.
Definition at line 152 of file qgscomposerscalebar.h.
Referenced by applyDefaultSettings(), firstLabelString(), readXML(), segmentPositions(), setNumSegmentsLeft(), and writeXML().
double QgsComposerScaleBar::mNumUnitsPerSegment [protected] |
Size of a segment (in map units)
Definition at line 154 of file qgscomposerscalebar.h.
Referenced by applyDefaultSize(), firstLabelString(), readXML(), refreshSegmentMillimeters(), setNumUnitsPerSegment(), and writeXML().
QPen QgsComposerScaleBar::mPen [protected] |
Outline.
Definition at line 163 of file qgscomposerscalebar.h.
Referenced by applyDefaultSettings(), readXML(), segmentPositions(), and writeXML().
double QgsComposerScaleBar::mSegmentMillimeters [protected] |
Width of a segment (in mm)
Definition at line 178 of file qgscomposerscalebar.h.
Referenced by readXML(), refreshSegmentMillimeters(), segmentPositions(), and writeXML().
QgsScaleBarStyle* QgsComposerScaleBar::mStyle [protected] |
Scalebar style.
Definition at line 169 of file qgscomposerscalebar.h.
Referenced by adjustBoxSize(), applyDefaultSettings(), paint(), readXML(), setBoxContentSpace(), setNumSegments(), setNumSegmentsLeft(), setNumUnitsPerSegment(), setStyle(), style(), updateSegmentSize(), writeXML(), and ~QgsComposerScaleBar().
QString QgsComposerScaleBar::mUnitLabeling [protected] |
Labeling of map units.
Definition at line 159 of file qgscomposerscalebar.h.
Referenced by readXML(), and writeXML().