QgsComposerScaleBar Class Reference
[MapComposer]

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

#include <qgscomposerscalebar.h>

Inheritance diagram for QgsComposerScaleBar:

Inheritance graph
[legend]
Collaboration diagram for QgsComposerScaleBar:

Collaboration graph
[legend]

List of all members.

Public Slots

void updateSegmentSize ()
void invalidateCurrentMap ()
 Sets mCompositionMap to 0 if the map is deleted.

Public Member Functions

 QgsComposerScaleBar (QgsComposition *composition)
 ~QgsComposerScaleBar ()
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 QgsComposerMapcomposerMap () const
double labelBarSpace () const
void setLabelBarSpace (double space)
double boxContentSpace () const
void setBoxContentSpace (double space)
double segmentMillimeters () const
void applyDefaultSettings ()
 Apply default settings (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

Protected Member Functions

void refreshSegmentMillimeters ()
 Calculates with of a segment in mm and stores it in mSegmentMillimeters.

Protected Attributes

const QgsComposerMapmComposerMap
 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.
QgsScaleBarStylemStyle
 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).


Detailed Description

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

Definition at line 28 of file qgscomposerscalebar.h.


Constructor & Destructor Documentation

QgsComposerScaleBar::QgsComposerScaleBar ( QgsComposition composition  ) 

Definition at line 31 of file qgscomposerscalebar.cpp.

References applyDefaultSettings().

QgsComposerScaleBar::~QgsComposerScaleBar (  ) 

Definition at line 36 of file qgscomposerscalebar.cpp.

References mStyle.


Member Function Documentation

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

int QgsComposerScaleBar::numSegments (  )  const [inline]

Definition at line 42 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::calculateBoxSize().

void QgsComposerScaleBar::setNumSegments ( int  nSegments  )  [inline]

Definition at line 43 of file qgscomposerscalebar.h.

int QgsComposerScaleBar::numSegmentsLeft (  )  const [inline]

Definition at line 45 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::drawLabels().

void QgsComposerScaleBar::setNumSegmentsLeft ( int  nSegmentsLeft  )  [inline]

Definition at line 46 of file qgscomposerscalebar.h.

double QgsComposerScaleBar::numUnitsPerSegment (  )  const [inline]

void QgsComposerScaleBar::setNumUnitsPerSegment ( double  units  ) 

Definition at line 65 of file qgscomposerscalebar.cpp.

References mNumUnitsPerSegment, and refreshSegmentMillimeters().

double QgsComposerScaleBar::numMapUnitsPerScaleBarUnit (  )  const [inline]

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

Definition at line 52 of file qgscomposerscalebar.h.

QString QgsComposerScaleBar::unitLabeling (  )  const [inline]

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

Definition at line 55 of file qgscomposerscalebar.h.

QFont QgsComposerScaleBar::font (  )  const

void QgsComposerScaleBar::setFont ( const QFont &  font  ) 

Definition at line 260 of file qgscomposerscalebar.cpp.

References adjustBoxSize(), mFont, and update().

QPen QgsComposerScaleBar::pen (  )  const [inline]

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

Definition at line 62 of file qgscomposerscalebar.h.

QBrush QgsComposerScaleBar::brush (  )  const [inline]

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

Definition at line 65 of file qgscomposerscalebar.h.

double QgsComposerScaleBar::height (  )  const [inline]

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

Definition at line 68 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setComposerMap ( const QgsComposerMap map  ) 

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

Definition at line 71 of file qgscomposerscalebar.h.

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

double QgsComposerScaleBar::labelBarSpace (  )  const [inline]

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

Definition at line 74 of file qgscomposerscalebar.h.

double QgsComposerScaleBar::boxContentSpace (  )  const [inline]

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

Definition at line 77 of file qgscomposerscalebar.h.

double QgsComposerScaleBar::segmentMillimeters (  )  const [inline]

void QgsComposerScaleBar::applyDefaultSettings (  ) 

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 194 of file qgscomposerscalebar.cpp.

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

Referenced by readXML().

QString QgsComposerScaleBar::style (  )  const

Returns style name.

Definition at line 231 of file qgscomposerscalebar.cpp.

References mStyle, and QgsScaleBarStyle::name().

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 174 of file qgscomposerscalebar.cpp.

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

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

void QgsComposerScaleBar::adjustBoxSize (  ) 

Sets box size suitable to content.

Definition at line 151 of file qgscomposerscalebar.cpp.

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

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

void QgsComposerScaleBar::update (  ) 

Adjusts box size and calls QgsComposerItem::update().

Definition at line 162 of file qgscomposerscalebar.cpp.

References adjustBoxSize().

Referenced by setFont(), and updateSegmentSize().

QString QgsComposerScaleBar::firstLabelString (  )  const

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

Definition at line 243 of file qgscomposerscalebar.cpp.

References mNumMapUnitsPerScaleBarUnit, mNumSegmentsLeft, and mNumUnitsPerSegment.

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

bool QgsComposerScaleBar::writeXML ( QDomElement &  elem,
QDomDocument &  doc 
) const [virtual]

stores state in Dom element

Parameters:
elem is Dom element corresponding to 'Composer' tag
doc Dom document

Implements QgsComposerItem.

Definition at line 267 of file qgscomposerscalebar.cpp.

References QgsComposerItem::_writeXML(), QgsComposerMap::id(), mBoxContentSpace, mBrush, mComposerMap, mFont, mHeight, mLabelBarSpace, mNumMapUnitsPerScaleBarUnit, mNumSegments, mNumSegmentsLeft, mNumUnitsPerSegment, mPen, mSegmentMillimeters, mStyle, mUnitLabeling, and QgsScaleBarStyle::name().

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

void QgsComposerScaleBar::updateSegmentSize (  )  [slot]

Definition at line 168 of file qgscomposerscalebar.cpp.

References refreshSegmentMillimeters(), and update().

Referenced by invalidateCurrentMap(), readXML(), and setComposerMap().

void QgsComposerScaleBar::invalidateCurrentMap (  )  [slot]

Sets mCompositionMap to 0 if the map is deleted.

Definition at line 88 of file qgscomposerscalebar.cpp.

References mComposerMap, and updateSegmentSize().

Referenced by readXML(), and setComposerMap().

void QgsComposerScaleBar::refreshSegmentMillimeters (  )  [protected]

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

Definition at line 95 of file qgscomposerscalebar.cpp.

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

Referenced by applyDefaultSettings(), readXML(), setComposerMap(), setNumUnitsPerSegment(), and updateSegmentSize().


Member Data Documentation

Reference to composer map object.

Definition at line 124 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), invalidateCurrentMap(), readXML(), refreshSegmentMillimeters(), setComposerMap(), and writeXML().

Number of segments on right side.

Definition at line 126 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), readXML(), segmentPositions(), and writeXML().

Number of segments on left side.

Definition at line 128 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), firstLabelString(), readXML(), segmentPositions(), and writeXML().

Size of a segment (in map units).

Definition at line 130 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), firstLabelString(), readXML(), refreshSegmentMillimeters(), setNumUnitsPerSegment(), and writeXML().

Number of map units per scale bar units (e.g.

1000 to have km for a map with m units)

Definition at line 132 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), firstLabelString(), readXML(), and writeXML().

Labeling of map units.

Definition at line 135 of file qgscomposerscalebar.h.

Referenced by readXML(), and writeXML().

QFont QgsComposerScaleBar::mFont [protected]

Font.

Definition at line 137 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), font(), paint(), readXML(), setFont(), and writeXML().

QPen QgsComposerScaleBar::mPen [protected]

Outline.

Definition at line 139 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), readXML(), segmentPositions(), and writeXML().

QBrush QgsComposerScaleBar::mBrush [protected]

Fill.

Definition at line 141 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), and writeXML().

double QgsComposerScaleBar::mHeight [protected]

Height of bars/lines.

Definition at line 143 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), readXML(), and writeXML().

Space between bar and Text labels.

Definition at line 148 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), readXML(), and writeXML().

Space between content and item box.

Definition at line 151 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), readXML(), segmentPositions(), and writeXML().

Width of a segment (in mm).

Definition at line 154 of file qgscomposerscalebar.h.

Referenced by readXML(), refreshSegmentMillimeters(), segmentPositions(), and writeXML().


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

Generated on Sat Feb 4 19:17:28 2012 for Quantum GIS API Documentation by  doxygen 1.5.6