Quantum GIS API Documentation  1.7.5-Wroclaw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 Slots

void updateSegmentSize ()
void invalidateCurrentMap ()
 Sets mCompositionMap to 0 if the map is deleted.
- Public Slots inherited from QgsComposerItem
virtual void setRotation (double r)
void repaint ()

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
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
- Public Member Functions inherited from QgsComposerItem
 QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
 Constructor.
 QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
 Constructor with box position and composer object.
virtual ~QgsComposerItem ()
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted.
virtual bool selected (void)
 Is selected.
virtual bool writeSettings (void)
 stores state in project
virtual bool readSettings (void)
 read state from project
virtual bool removeSettings (void)
 delete settings from project file
void move (double dx, double dy)
 Moves item in canvas coordinates.
virtual void moveContent (double dx, double dy)
 Move Content of item.
virtual void zoomContent (int delta, double x, double y)
 Zoom content of item.
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft)
 Moves the item to a new position (in canvas coordinates)
void setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft)
 Sets item position and width / height in one go.
virtual void setSceneRect (const QRectF &rectangle)
 Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document.
bool _readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document.
bool frame () const
void setFrame (bool drawFrame)
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default.
virtual void removeItems ()
const QgsCompositioncomposition () const
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command.
void endCommand ()
 Finish current command and push it onto the undo stack.
void cancelCommand ()
void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const
 Draws Text.
void drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignement=Qt::AlignLeft, Qt::AlignmentFlag valignement=Qt::AlignTop) const
 Like the above, but with a rectangle for multiline text.
double textWidthMillimeters (const QFont &font, const QString &text) const
 Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters.
double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double pixelFontSize (double pointSize) const
 Calculates font to from point size to pixel size.
QFont scaledFontPixelSize (const QFont &font) const
 Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.
void setPositionLock (bool lock)
 Locks / unlocks the item position for mouse drags.
bool positionLock () const
 Returns position lock for mouse drags (true means locked)
void updateCursor (const QPointF &itemPos)
 Update mouse cursor at (item) position.
double rotation () const

Protected Member Functions

void refreshSegmentMillimeters ()
 Calculates with of a segment in mm and stores it in mSegmentMillimeters.
- Protected Member Functions inherited from QgsComposerItem
virtual void mouseMoveEvent (QGraphicsSceneMouseEvent *event)
virtual void mousePressEvent (QGraphicsSceneMouseEvent *event)
virtual void mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
virtual void hoverMoveEvent (QGraphicsSceneHoverEvent *event)
Qt::CursorShape cursorForPosition (const QPointF &itemCoordPos)
 Finds out the appropriate cursor for the current mouse position in the widget (e.g.
QgsComposerItem::MouseMoveAction mouseMoveActionForPosition (const QPointF &itemCoordPos)
 Finds out which mouse move action to choose depending on the cursor position inside the widget.
void changeItemRectangle (const QPointF &currentPosition, const QPointF &mouseMoveStartPos, const QGraphicsRectItem *originalItem, double dx, double dy, QGraphicsRectItem *changeItem)
 Changes the rectangle of an item depending on current mouse action (resize or move)
virtual void drawSelectionBoxes (QPainter *p)
 Draw selection boxes around item.
virtual void drawFrame (QPainter *p)
 Draw black frame around item.
virtual void drawBackground (QPainter *p)
 Draw background.
void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead.
double angle (const QPointF &p1, const QPointF &p2) const
 Returns angle of the line from p1 to p2 (clockwise, starting at N)
double rectHandlerBorderTolerance () const
 Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the \ item border for resizing.
double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size.
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view.
bool imageSizeConsideringRotation (double &width, double &height) const
 Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation.
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling.
QPointF pointOnLineWithDistance (const QPointF &startPoint, const QPointF &directionPoint, double distance) const
 Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point.
void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle (mRotation)
void rotate (double angle, double &x, double &y) const
 Rotates a point / vector.

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)
- Protected Attributes inherited from QgsComposerItem
QgsCompositionmComposition
QgsComposerItem::MouseMoveAction mCurrentMouseMoveAction
QPointF mMouseMoveStartPos
 Start point of the last mouse move action (in scene coordinates)
QPointF mLastMouseEventPos
 Position of the last mouse move event (in scene coordinates)
QGraphicsRectItem * mBoundingResizeRectangle
 Rectangle used during move and resize actions.
bool mFrame
 True if item fram needs to be painted.
bool mItemPositionLocked
 True if item position and size cannot be changed with mouse move.
double mLastValidViewScaleFactor
 Backup to restore item appearance if no view scale factor is available.
double mRotation
 Item rotation in degrees, clockwise.

Additional Inherited Members

- Public Types inherited from QgsComposerItem
enum  ItemType {
  ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel,
  ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture,
  ComposerScaleBar, ComposerShape, ComposerTable, ComposerAttributeTable,
  ComposerTextTable
}
enum  MouseMoveAction {
  MoveItem, ResizeUp, ResizeDown, ResizeLeft,
  ResizeRight, ResizeLeftUp, ResizeRightUp, ResizeLeftDown,
  ResizeRightDown, NoAction
}
 Describes the action (move or resize in different directon) to be done during mouse move. More...
enum  ItemPositionMode {
  UpperLeft, UpperMiddle, UpperRight, MiddleLeft,
  Middle, MiddleRight, LowerLeft, LowerMiddle,
  LowerRight
}
- Signals inherited from QgsComposerItem
void rotationChanged (double newRotation)
 Is emitted on rotation change to notify north arrow pictures.
void itemChanged ()
 Used e.g.

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(), and applyDefaultSize().

QgsComposerScaleBar::~QgsComposerScaleBar ( )

Definition at line 37 of file qgscomposerscalebar.cpp.

References mStyle.


Member Function Documentation

void QgsComposerScaleBar::adjustBoxSize ( )

Sets box size suitable to content.

Definition at line 154 of file qgscomposerscalebar.cpp.

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

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

void QgsComposerScaleBar::applyDefaultSettings ( )
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 136 of file qgscomposerscalebar.cpp.

References adjustBoxSize(), QgsComposerMap::extent(), mComposerMap, mNumSegments, mNumUnitsPerSegment, refreshSegmentMillimeters(), and QgsRectangle::width().

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

double QgsComposerScaleBar::boxContentSpace ( ) const
inline
QBrush QgsComposerScaleBar::brush ( ) const
inline
const QgsComposerMap* QgsComposerScaleBar::composerMap ( ) const
inline

Definition at line 74 of file qgscomposerscalebar.h.

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

QString QgsComposerScaleBar::firstLabelString ( ) const

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

Definition at line 246 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
void QgsComposerScaleBar::invalidateCurrentMap ( )
slot

Sets mCompositionMap to 0 if the map is deleted.

Definition at line 89 of file qgscomposerscalebar.cpp.

References mComposerMap, and updateSegmentSize().

Referenced by readXML(), and setComposerMap().

double QgsComposerScaleBar::labelBarSpace ( ) const
inline
double QgsComposerScaleBar::numMapUnitsPerScaleBarUnit ( ) const
inline
int QgsComposerScaleBar::numSegments ( ) const
inline

Definition at line 45 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::calculateBoxSize().

int QgsComposerScaleBar::numSegmentsLeft ( ) const
inline

Definition at line 48 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
void QgsComposerScaleBar::refreshSegmentMillimeters ( )
protected

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

Definition at line 96 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 177 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::setBoxContentSpace ( double  space)
inline

Definition at line 80 of file qgscomposerscalebar.h.

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

Definition at line 68 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setComposerMap ( const QgsComposerMap map)
void QgsComposerScaleBar::setFont ( const QFont &  font)

Definition at line 263 of file qgscomposerscalebar.cpp.

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

void QgsComposerScaleBar::setHeight ( double  h)
inline

Definition at line 71 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setLabelBarSpace ( double  space)
inline

Definition at line 77 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setNumMapUnitsPerScaleBarUnit ( double  d)
inline

Definition at line 55 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setNumSegments ( int  nSegments)
inline

Definition at line 46 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setNumSegmentsLeft ( int  nSegmentsLeft)
inline

Definition at line 49 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setNumUnitsPerSegment ( double  units)

Definition at line 66 of file qgscomposerscalebar.cpp.

References mNumUnitsPerSegment, and refreshSegmentMillimeters().

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

Definition at line 65 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 197 of file qgscomposerscalebar.cpp.

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

Referenced by readXML().

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

Definition at line 58 of file qgscomposerscalebar.h.

QString QgsComposerScaleBar::style ( ) const

Returns style name.

Definition at line 234 of file qgscomposerscalebar.cpp.

References mStyle, and QgsScaleBarStyle::name().

virtual int QgsComposerScaleBar::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 39 of file qgscomposerscalebar.h.

References QgsComposerItem::ComposerScaleBar.

QString QgsComposerScaleBar::unitLabeling ( ) const
inline
void QgsComposerScaleBar::update ( )

Adjusts box size and calls QgsComposerItem::update()

Definition at line 165 of file qgscomposerscalebar.cpp.

References adjustBoxSize().

Referenced by setFont(), and updateSegmentSize().

void QgsComposerScaleBar::updateSegmentSize ( )
slot

Definition at line 171 of file qgscomposerscalebar.cpp.

References refreshSegmentMillimeters(), and update().

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

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


Member Data Documentation

double QgsComposerScaleBar::mBoxContentSpace
protected

Space between content and item box.

Definition at line 157 of file qgscomposerscalebar.h.

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

QBrush QgsComposerScaleBar::mBrush
protected

Fill.

Definition at line 147 of file qgscomposerscalebar.h.

Referenced by applyDefaultSettings(), and writeXML().

const QgsComposerMap* QgsComposerScaleBar::mComposerMap
protected

Reference to composer map object.

Definition at line 130 of file qgscomposerscalebar.h.

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

QFont QgsComposerScaleBar::mFont
protected

Font.

Definition at line 143 of file qgscomposerscalebar.h.

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

double QgsComposerScaleBar::mHeight
protected

Height of bars/lines.

Definition at line 149 of file qgscomposerscalebar.h.

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

double QgsComposerScaleBar::mLabelBarSpace
protected

Space between bar and Text labels.

Definition at line 154 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 138 of file qgscomposerscalebar.h.

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

int QgsComposerScaleBar::mNumSegments
protected

Number of segments on right side.

Definition at line 132 of file qgscomposerscalebar.h.

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

int QgsComposerScaleBar::mNumSegmentsLeft
protected

Number of segments on left side.

Definition at line 134 of file qgscomposerscalebar.h.

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

double QgsComposerScaleBar::mNumUnitsPerSegment
protected

Size of a segment (in map units)

Definition at line 136 of file qgscomposerscalebar.h.

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

QPen QgsComposerScaleBar::mPen
protected

Outline.

Definition at line 145 of file qgscomposerscalebar.h.

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

double QgsComposerScaleBar::mSegmentMillimeters
protected

Width of a segment (in mm)

Definition at line 160 of file qgscomposerscalebar.h.

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

QgsScaleBarStyle* QgsComposerScaleBar::mStyle
protected
QString QgsComposerScaleBar::mUnitLabeling
protected

Labeling of map units.

Definition at line 141 of file qgscomposerscalebar.h.

Referenced by readXML(), and writeXML().


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