Quantum GIS API Documentation  1.8
Public Types | Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes
QgsComposerScaleBar Class Reference

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 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 QgsComposerMapcomposerMap () 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 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)
Alignment mAlignment

Detailed Description

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

Definition at line 28 of file qgscomposerscalebar.h.


Member Enumeration Documentation

Added in version 1.8.

Enumerator:
Left 
Middle 
Right 

Definition at line 36 of file qgscomposerscalebar.h.


Constructor & Destructor Documentation

Definition at line 31 of file qgscomposerscalebar.cpp.

References applyDefaultSettings(), and applyDefaultSize().

Definition at line 43 of file qgscomposerscalebar.cpp.

References mStyle.


Member Function Documentation

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.

Note:
: this method was added in version 1.8

Definition at line 94 of file qgscomposerscalebar.h.

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

Note:
this method was added in version 1.7

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]
QBrush QgsComposerScaleBar::brush ( ) 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().

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
double QgsComposerScaleBar::height ( ) const [inline]

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]
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]
void QgsComposerScaleBar::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
)
QPen QgsComposerScaleBar::pen ( ) const [inline]
bool QgsComposerScaleBar::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
) [virtual]

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]
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().

Note:
: this method was added in version 1.8

Definition at line 97 of file qgscomposerscalebar.h.

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

Definition at line 76 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setFont ( const QFont &  font)
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.

Definition at line 63 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setNumSegments ( int  nSegments)
void QgsComposerScaleBar::setNumSegmentsLeft ( int  nSegmentsLeft)
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.

Parameters:
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]

Adjusts box size and calls QgsComposerItem::update()

Definition at line 227 of file qgscomposerscalebar.cpp.

References adjustBoxSize().

Referenced by setFont(), and updateSegmentSize().

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

stores state in Dom element

Parameters:
elemis Dom element corresponding to 'Composer' tag
docDom 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().


Member Data Documentation

Definition at line 180 of file qgscomposerscalebar.h.

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

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().

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().

Space between bar and Text labels.

Definition at line 172 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), readXML(), 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 156 of file qgscomposerscalebar.h.

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

Number of segments on right side.

Definition at line 150 of file qgscomposerscalebar.h.

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

Number of segments on left side.

Definition at line 152 of file qgscomposerscalebar.h.

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

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().

Width of a segment (in mm)

Definition at line 178 of file qgscomposerscalebar.h.

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

Labeling of map units.

Definition at line 159 of file qgscomposerscalebar.h.

Referenced by readXML(), and writeXML().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines