QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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]

Public Types

enum  Alignment { Left = 0, Middle, Right }
 Added in version 1.8. More...
 
enum  ScaleBarUnits { MapUnits = 0, Meters, Feet, NauticalMiles }
 Added in version 1.9. More...
 
- Public Types inherited from QgsComposerItem
enum  ItemType {
  ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel,
  ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture,
  ComposerScaleBar, ComposerShape, ComposerTable, ComposerAttributeTable,
  ComposerTextTable, ComposerFrame
}
 
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
}
 
- Public Types inherited from QgsComposerObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, BlendMode,
  MapRotation, MapScale, MapXMin, MapYMin,
  MapXMax, MapYMax, PictureSource, SourceUrl
}
 Data defined properties for different item types. More...
 
enum  PropertyValueType { EvaluatedValue = 0, OriginalValue }
 Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...
 

Public Slots

void updateSegmentSize ()
 
void invalidateCurrentMap ()
 Sets mCompositionMap to 0 if the map is deleted. More...
 
- Public Slots inherited from QgsComposerItem
virtual void setRotation (double r)
 Sets the item rotation. More...
 
virtual void setItemRotation (const double r, const bool adjustPosition=false)
 Sets the item rotation. More...
 
void repaint ()
 
virtual void refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties)
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
- Public Slots inherited from QgsComposerObject
virtual void repaint ()
 Triggers a redraw for the item. More...
 
virtual void refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties)
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 

Public Member Functions

 QgsComposerScaleBar (QgsComposition *composition)
 
 ~QgsComposerScaleBar ()
 
virtual int type () const
 return correct graphics item type. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint. More...
 
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)
 
QColor fontColor () const
 Returns the color used for drawing text in the scalebar. More...
 
void setFontColor (const QColor &c)
 Sets the color used for drawing text in the scalebar. More...
 
QPen pen () const
 Returns the pen used for drawing the scalebar. More...
 
void setPen (const QPen &pen)
 Sets the pen used for drawing the scalebar. More...
 
QBrush brush () const
 Returns the primary brush for the scalebar. More...
 
void setBrush (const QBrush &brush)
 Sets primary brush for the scalebar. More...
 
QBrush brush2 () const
 Returns the secondary brush for the scalebar. More...
 
void setBrush2 (const QBrush &brush)
 Sets secondary brush for the scalebar. More...
 
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. More...
 
void setAlignment (Alignment a)
 
ScaleBarUnits units () const
 
void setUnits (ScaleBarUnits u)
 
Qt::PenJoinStyle lineJoinStyle () const
 Returns the join style used for drawing lines in the scalebar. More...
 
void setLineJoinStyle (Qt::PenJoinStyle style)
 Sets join style used when drawing the lines in the scalebar. More...
 
Qt::PenCapStyle lineCapStyle () const
 Returns the cap style used for drawing lines in the scalebar. More...
 
void setLineCapStyle (Qt::PenCapStyle style)
 Sets cap style used when drawing the lines in the scalebar. More...
 
void applyDefaultSettings ()
 Apply default settings. More...
 
void applyDefaultSize (ScaleBarUnits u=Meters)
 Apply default size (scale bar 1/5 of map item width) More...
 
void setStyle (const QString &styleName)
 Sets style by name. More...
 
QString style () const
 Returns style name. More...
 
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. More...
 
void adjustBoxSize ()
 Sets box size suitable to content. More...
 
void update ()
 Adjusts box size and calls QgsComposerItem::update() More...
 
QString firstLabelString () const
 Returns string of first label (important for drawing, labeling, size calculation. More...
 
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 stores state in Dom element More...
 
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document More...
 
void correctXPositionAlignment (double width, double widthAfter)
 Moves scalebar position to the left / right depending on alignment and change in item width. More...
 
- Public Member Functions inherited from QgsComposerItem
 QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
 Constructor. More...
 
 QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
 Constructor with box position and composer object. More...
 
virtual ~QgsComposerItem ()
 
virtual bool isRemoved () const
 Returns whether this item has been removed from the composition. More...
 
void setIsRemoved (const bool removed)
 Sets whether this item has been removed from the composition. More...
 
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
virtual bool selected () const
 Is selected. More...
 
void move (double dx, double dy)
 Moves item in canvas coordinates. More...
 
virtual void moveContent (double dx, double dy)
 Move Content of item. More...
 
virtual void zoomContent (int delta, double x, double y)
 Zoom content of item. More...
 
int page () const
 Gets the page the item is currently on. More...
 
QPointF pagePos () const
 Returns the item's position relative to its current page. More...
 
void updatePagePos (double newPageWidth, double newPageHeight)
 Moves the item so that it retains its relative position on the page when the paper size changes. More...
 
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1)
 Moves the item to a new position (in canvas coordinates) More...
 
void setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft, bool posIncludesFrame=false, int page=-1)
 Sets item position and width / height in one go. More...
 
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode. More...
 
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. More...
 
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document. More...
 
bool _readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document. More...
 
bool hasFrame () const
 Whether this item has a frame or not. More...
 
void setFrameEnabled (const bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
virtual void setFrameOutlineWidth (const double outlineWidth)
 Sets frame outline width. More...
 
double frameOutlineWidth () const
 Returns the frame's outline width. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
void setFrameJoinStyle (const Qt::PenJoinStyle style)
 Sets join style used when drawing the item's frame. More...
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
bool hasBackground () const
 Whether this item has a Background or not. More...
 
void setBackgroundEnabled (const bool drawBackground)
 Set whether this item has a Background drawn around it or not. More...
 
QColor backgroundColor () const
 Gets the background color for this item. More...
 
void setBackgroundColor (const QColor &backgroundColor)
 Sets the background color for this item. More...
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void setBlendMode (const QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
int transparency () const
 Returns the item's transparency. More...
 
void setTransparency (const int transparency)
 Sets the item's transparency. More...
 
bool effectsEnabled () const
 Returns whether effects (eg blend modes) are enabled for the item. More...
 
void setEffectsEnabled (const bool effectsEnabled)
 Sets whether effects (eg blend modes) are enabled for the item. More...
 
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default. More...
 
virtual void removeItems ()
 
virtual void beginItemCommand (const QString &text)
 
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command. More...
 
virtual void endItemCommand ()
 
void endCommand ()
 Finish current command and push it onto the undo stack. More...
 
void cancelCommand ()
 
Q_DECL_DEPRECATED void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const
 Draws Text. More...
 
Q_DECL_DEPRECATED void drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment=Qt::AlignLeft, Qt::AlignmentFlag valignment=Qt::AlignTop, int flags=Qt::TextWordWrap) const
 Like the above, but with a rectangle for multiline text. More...
 
Q_DECL_DEPRECATED double textWidthMillimeters (const QFont &font, const QString &text) const
 Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters. More...
 
Q_DECL_DEPRECATED double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontDescentMillimeters (const QFont &font) const
 Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontHeightMillimeters (const QFont &font) const
 Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double pixelFontSize (double pointSize) const
 Calculates font size in mm from a font point size. More...
 
Q_DECL_DEPRECATED QFont scaledFontPixelSize (const QFont &font) const
 Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE. More...
 
void setPositionLock (const bool lock)
 Locks / unlocks the item position for mouse drags. More...
 
bool positionLock () const
 Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. More...
 
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current rotation for the composer item. More...
 
Q_DECL_DEPRECATED double rotation () const
 Returns the rotation for the composer item. More...
 
virtual void updateItem ()
 Updates item, with the possibility to do custom update for subclasses. More...
 
QString id () const
 Get item's id (which is not necessarly unique) More...
 
virtual void setId (const QString &id)
 Set item's id (which is not necessarly unique) More...
 
QString uuid () const
 Get item identification name. More...
 
virtual QString displayName () const
 Get item display name. More...
 
virtual void setVisibility (const bool visible)
 Sets visibility for item. More...
 
bool isGroupMember () const
 Returns whether this item is part of a group. More...
 
void setIsGroupMember (const bool isGroupMember)
 Sets whether this item is part of a group. More...
 
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
virtual void setCurrentExportLayer (const int layerIdx=-1)
 Sets the current layer to draw for exporting. More...
 
- Public Member Functions inherited from QgsComposerObject
 QgsComposerObject (QgsComposition *composition)
 Constructor. More...
 
virtual ~QgsComposerObject ()
 
const QgsCompositioncomposition () const
 Returns the composition the item is attached to. More...
 
QgsCompositioncomposition ()
 
QgsDataDefineddataDefinedProperty (const DataDefinedProperty property) const
 Returns a reference to the data defined settings for one of the item's data defined properties. More...
 
void setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field)
 Sets parameters for a data defined property for the item. More...
 

Protected Member Functions

void refreshSegmentMillimeters ()
 Calculates with of a segment in mm and stores it in mSegmentMillimeters. More...
 
double mapWidth () const
 Returns diagonal of composer map in selected units (map units / meters / feet / nautical miles) More...
 
- Protected Member Functions inherited from QgsComposerItem
virtual void drawSelectionBoxes (QPainter *p)
 Draws additional graphics on selected items. More...
 
virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
Q_DECL_DEPRECATED void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead. More...
 
Q_DECL_DEPRECATED double angle (const QPointF &p1, const QPointF &p2) const
 Returns angle of the line from p1 to p2 (clockwise, starting at N) More...
 
double rectHandlerBorderTolerance () const
 Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing. More...
 
Q_DECL_DEPRECATED double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size. More...
 
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view. More...
 
Q_DECL_DEPRECATED bool imageSizeConsideringRotation (double &width, double &height, double rotation) const
 Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...
 
Q_DECL_DEPRECATED 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. More...
 
Q_DECL_DEPRECATED QRectF largestRotatedRectWithinBounds (QRectF originalRect, QRectF boundsRect, double rotation) const
 Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by a specified amount. More...
 
Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
 Calculates corner point after rotation and scaling. More...
 
Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling. More...
 
Q_DECL_DEPRECATED void sizeChangedByRotation (double &width, double &height, double rotation)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
Q_DECL_DEPRECATED void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
Q_DECL_DEPRECATED void rotate (double angle, double &x, double &y) const
 Rotates a point / vector. More...
 
QGraphicsLineItem * hAlignSnapItem ()
 Return horizontal align snap item. More...
 
void deleteHAlignSnapItem ()
 
QGraphicsLineItem * vAlignSnapItem ()
 Return vertical align snap item. More...
 
void deleteVAlignSnapItem ()
 
void deleteAlignItems ()
 
QRectF evalItemRect (const QRectF &newRect)
 Update an item rect to consider data defined position and size of item. More...
 
- Protected Member Functions inherited from QgsComposerObject
bool dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
 Evaluate a data defined property and return the calculated value. More...
 

Protected Attributes

const QgsComposerMapmComposerMap
 Reference to composer map object. More...
 
int mNumSegments
 Number of segments on right side. More...
 
int mNumSegmentsLeft
 Number of segments on left side. More...
 
double mNumUnitsPerSegment
 Size of a segment (in map units) More...
 
double mNumMapUnitsPerScaleBarUnit
 Number of map units per scale bar units (e.g. More...
 
QString mUnitLabeling
 Labeling of map units. More...
 
QFont mFont
 Font. More...
 
QColor mFontColor
 
QPen mPen
 Outline. More...
 
QBrush mBrush
 Fill. More...
 
QBrush mBrush2
 Secondary fill. More...
 
double mHeight
 Height of bars/lines. More...
 
QgsScaleBarStylemStyle
 Scalebar style. More...
 
double mLabelBarSpace
 Space between bar and Text labels. More...
 
double mBoxContentSpace
 Space between content and item box. More...
 
double mSegmentMillimeters
 Width of a segment (in mm) More...
 
Alignment mAlignment
 
ScaleBarUnits mUnits
 
Qt::PenJoinStyle mLineJoinStyle
 
Qt::PenCapStyle mLineCapStyle
 
- Protected Attributes inherited from QgsComposerItem
bool mRemovedFromComposition
 True if item has been removed from the composition. More...
 
QgsComposerItem::MouseMoveAction mCurrentMouseMoveAction
 
QPointF mMouseMoveStartPos
 Start point of the last mouse move action (in scene coordinates) More...
 
QPointF mLastMouseEventPos
 Position of the last mouse move event (in scene coordinates) More...
 
QGraphicsRectItem * mBoundingResizeRectangle
 Rectangle used during move and resize actions. More...
 
QGraphicsLineItem * mHAlignSnapItem
 
QGraphicsLineItem * mVAlignSnapItem
 
bool mFrame
 True if item fram needs to be painted. More...
 
bool mBackground
 True if item background needs to be painted. More...
 
QColor mBackgroundColor
 Background color. More...
 
Qt::PenJoinStyle mFrameJoinStyle
 Frame join style. More...
 
bool mItemPositionLocked
 True if item position and size cannot be changed with mouse move. More...
 
double mLastValidViewScaleFactor
 Backup to restore item appearance if no view scale factor is available. More...
 
double mItemRotation
 Item rotation in degrees, clockwise. More...
 
double mEvaluatedItemRotation
 Temporary evaluated item rotation in degrees, clockwise. More...
 
QPainter::CompositionMode mBlendMode
 Composition blend mode for item. More...
 
bool mEffectsEnabled
 
QgsComposerEffectmEffect
 
int mTransparency
 Item transparency. More...
 
ItemPositionMode mLastUsedPositionMode
 The item's position mode. More...
 
bool mIsGroupMember
 Whether or not this item is part of a group. More...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 
- Protected Attributes inherited from QgsComposerObject
QgsCompositionmComposition
 
QMap
< QgsComposerObject::DataDefinedProperty,
QString > 
mDataDefinedNames
 Map of data defined properties for the item to string name to use when exporting item to xml. More...
 

Additional Inherited Members

- Signals inherited from QgsComposerItem
void itemRotationChanged (double newRotation)
 Is emitted on item rotation change. More...
 
void sizeChanged ()
 Emitted if the rectangle changes. More...
 
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
- Signals inherited from QgsComposerObject
void itemChanged ()
 Emitted when the item changes. More...
 

Detailed Description

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

Definition at line 30 of file qgscomposerscalebar.h.

Constructor & Destructor Documentation

QgsComposerScaleBar::QgsComposerScaleBar ( QgsComposition composition)

Definition at line 38 of file qgscomposerscalebar.cpp.

References applyDefaultSettings(), and applyDefaultSize().

QgsComposerScaleBar::~QgsComposerScaleBar ( )

Definition at line 54 of file qgscomposerscalebar.cpp.

References mStyle.

Member Function Documentation

void QgsComposerScaleBar::adjustBoxSize ( )

Sets box size suitable to content.

Definition at line 378 of file qgscomposerscalebar.cpp.

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

Referenced by applyDefaultSize(), and update().

Alignment QgsComposerScaleBar::alignment ( void  ) const
inline

Left / Middle/ Right.

Note
: this method was added in version 1.8

Definition at line 157 of file qgscomposerscalebar.h.

Referenced by QgsNumericScaleBarStyle::draw().

void QgsComposerScaleBar::applyDefaultSettings ( )
void QgsComposerScaleBar::applyDefaultSize ( QgsComposerScaleBar::ScaleBarUnits  u = Meters)
double QgsComposerScaleBar::boxContentSpace ( ) const
inline
QBrush QgsComposerScaleBar::brush ( ) const
inline

Returns the primary brush for the scalebar.

Returns
QBrush used for filling the scalebar
See also
setBrush
brush2
pen

Definition at line 115 of file qgscomposerscalebar.h.

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

QBrush QgsComposerScaleBar::brush2 ( ) const
inline

Returns the secondary brush for the scalebar.

This is used for alternating color style scalebars, such as single and double box styles.

Returns
QBrush used for secondary color areas
See also
setBrush2
brush

Definition at line 131 of file qgscomposerscalebar.h.

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

const QgsComposerMap* QgsComposerScaleBar::composerMap ( ) const
inline

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

References mAlignment, Middle, QgsComposerItem::move(), mStyle, QgsScaleBarStyle::name(), 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 497 of file qgscomposerscalebar.cpp.

References mNumMapUnitsPerScaleBarUnit, mNumSegmentsLeft, and mNumUnitsPerSegment.

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

QFont QgsComposerScaleBar::font ( ) const
QColor QgsComposerScaleBar::fontColor ( ) const
inline

Returns the color used for drawing text in the scalebar.

Returns
font color for scalebar.
See also
setFontColor
font

Definition at line 86 of file qgscomposerscalebar.h.

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

double QgsComposerScaleBar::height ( ) const
inline
void QgsComposerScaleBar::invalidateCurrentMap ( )
slot

Sets mCompositionMap to 0 if the map is deleted.

Definition at line 162 of file qgscomposerscalebar.cpp.

References mComposerMap, and updateSegmentSize().

Referenced by readXML(), and setComposerMap().

double QgsComposerScaleBar::labelBarSpace ( ) const
inline
Qt::PenCapStyle QgsComposerScaleBar::lineCapStyle ( ) const
inline

Returns the cap style used for drawing lines in the scalebar.

Returns
Cap style for lines
Note
introduced in 2.3
See also
setLineCapStyle

Definition at line 187 of file qgscomposerscalebar.h.

Qt::PenJoinStyle QgsComposerScaleBar::lineJoinStyle ( ) const
inline

Returns the join style used for drawing lines in the scalebar.

Returns
Join style for lines
Note
introduced in 2.3
See also
setLineJoinStyle

Definition at line 173 of file qgscomposerscalebar.h.

double QgsComposerScaleBar::mapWidth ( ) const
protected
double QgsComposerScaleBar::numMapUnitsPerScaleBarUnit ( ) const
inline
int QgsComposerScaleBar::numSegments ( ) const
inline

Definition at line 63 of file qgscomposerscalebar.h.

Referenced by QgsScaleBarStyle::calculateBoxSize().

int QgsComposerScaleBar::numSegmentsLeft ( ) const
inline

Definition at line 66 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

Returns the pen used for drawing the scalebar.

Returns
QPen used for drawing the scalebar outlines.
See also
setPen
brush

Definition at line 100 of file qgscomposerscalebar.h.

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

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

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

Referenced by applyDefaultSize(), setComposerMap(), setNumUnitsPerSegment(), setUnits(), 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.

Note
python bindings not available on android

Definition at line 427 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)
Note
: this method was added in version 1.8

Definition at line 221 of file qgscomposerscalebar.cpp.

References QgsComposerObject::itemChanged(), mAlignment, and update().

void QgsComposerScaleBar::setBoxContentSpace ( double  space)
void QgsComposerScaleBar::setBrush ( const QBrush &  brush)
inline

Sets primary brush for the scalebar.

Parameters
brushQBrush to use for filling the scalebar
See also
brush
setBrush2
setPen

Definition at line 123 of file qgscomposerscalebar.h.

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

Sets secondary brush for the scalebar.

This is used for alternating color style scalebars, such as single and double box styles.

Parameters
brushQBrush to use for secondary color areas
See also
brush2
setBrush

Definition at line 139 of file qgscomposerscalebar.h.

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

Definition at line 514 of file qgscomposerscalebar.cpp.

References font(), QgsComposerObject::itemChanged(), mFont, and update().

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

Sets the color used for drawing text in the scalebar.

Parameters
cfont color for scalebar.
See also
fontColor
setFont

Definition at line 93 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setHeight ( double  h)
inline

Definition at line 142 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setLabelBarSpace ( double  space)
inline

Definition at line 148 of file qgscomposerscalebar.h.

void QgsComposerScaleBar::setLineCapStyle ( Qt::PenCapStyle  style)

Sets cap style used when drawing the lines in the scalebar.

Parameters
styleCap style for lines
Returns
nothing
Note
introduced in 2.3
See also
lineCapStyle

Definition at line 248 of file qgscomposerscalebar.cpp.

References QgsComposerObject::itemChanged(), mLineCapStyle, mPen, style(), and update().

void QgsComposerScaleBar::setLineJoinStyle ( Qt::PenJoinStyle  style)

Sets join style used when drawing the lines in the scalebar.

Parameters
styleJoin style for lines
Returns
nothing
Note
introduced in 2.3
See also
lineJoinStyle

Definition at line 235 of file qgscomposerscalebar.cpp.

References QgsComposerObject::itemChanged(), mLineJoinStyle, mPen, style(), and update().

void QgsComposerScaleBar::setNumMapUnitsPerScaleBarUnit ( double  d)
inline

Definition at line 73 of file qgscomposerscalebar.h.

Referenced by applyDefaultSize().

void QgsComposerScaleBar::setNumSegments ( int  nSegments)
void QgsComposerScaleBar::setNumSegmentsLeft ( int  nSegmentsLeft)
void QgsComposerScaleBar::setNumUnitsPerSegment ( double  units)
void QgsComposerScaleBar::setPen ( const QPen &  pen)
inline

Sets the pen used for drawing the scalebar.

Parameters
penQPen to use for drawing the scalebar outlines.
See also
pen
setBrush

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

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

Referenced by readXML().

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

Definition at line 76 of file qgscomposerscalebar.h.

Referenced by applyDefaultSize().

void QgsComposerScaleBar::setUnits ( ScaleBarUnits  u)
Note
: this method was added in version 1.9

Definition at line 228 of file qgscomposerscalebar.cpp.

References QgsComposerObject::itemChanged(), mUnits, and refreshSegmentMillimeters().

Referenced by applyDefaultSize().

QString QgsComposerScaleBar::style ( ) const

Returns style name.

Definition at line 485 of file qgscomposerscalebar.cpp.

References mStyle, and QgsScaleBarStyle::name().

Referenced by setLineCapStyle(), and setLineJoinStyle().

virtual int QgsComposerScaleBar::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 57 of file qgscomposerscalebar.h.

References QgsComposerItem::ComposerScaleBar.

QString QgsComposerScaleBar::unitLabeling ( ) const
inline
ScaleBarUnits QgsComposerScaleBar::units ( ) const
inline
Note
: this method was added in version 1.9

Definition at line 163 of file qgscomposerscalebar.h.

Referenced by setNumUnitsPerSegment().

void QgsComposerScaleBar::update ( )

Adjusts box size and calls QgsComposerItem::update()

Definition at line 403 of file qgscomposerscalebar.cpp.

References adjustBoxSize(), mStyle, and QgsScaleBarStyle::name().

Referenced by setAlignment(), setFont(), setLineCapStyle(), setLineJoinStyle(), and updateSegmentSize().

void QgsComposerScaleBar::updateSegmentSize ( )
slot
bool QgsComposerScaleBar::writeXML ( QDomElement &  elem,
QDomDocument &  doc 
) const
virtual

Member Data Documentation

Alignment QgsComposerScaleBar::mAlignment
protected

Definition at line 282 of file qgscomposerscalebar.h.

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

double QgsComposerScaleBar::mBoxContentSpace
protected

Space between content and item box.

Definition at line 277 of file qgscomposerscalebar.h.

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

QBrush QgsComposerScaleBar::mBrush
protected

Fill.

Definition at line 265 of file qgscomposerscalebar.h.

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

QBrush QgsComposerScaleBar::mBrush2
protected

Secondary fill.

Definition at line 267 of file qgscomposerscalebar.h.

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

const QgsComposerMap* QgsComposerScaleBar::mComposerMap
protected

Reference to composer map object.

Definition at line 247 of file qgscomposerscalebar.h.

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

QFont QgsComposerScaleBar::mFont
protected

Font.

Definition at line 260 of file qgscomposerscalebar.h.

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

QColor QgsComposerScaleBar::mFontColor
protected

Definition at line 261 of file qgscomposerscalebar.h.

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

double QgsComposerScaleBar::mHeight
protected

Height of bars/lines.

Definition at line 269 of file qgscomposerscalebar.h.

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

double QgsComposerScaleBar::mLabelBarSpace
protected

Space between bar and Text labels.

Definition at line 274 of file qgscomposerscalebar.h.

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

Qt::PenCapStyle QgsComposerScaleBar::mLineCapStyle
protected

Definition at line 287 of file qgscomposerscalebar.h.

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

Qt::PenJoinStyle QgsComposerScaleBar::mLineJoinStyle
protected

Definition at line 286 of file qgscomposerscalebar.h.

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

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

int QgsComposerScaleBar::mNumSegments
protected

Number of segments on right side.

Definition at line 249 of file qgscomposerscalebar.h.

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

int QgsComposerScaleBar::mNumSegmentsLeft
protected

Number of segments on left side.

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

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

QPen QgsComposerScaleBar::mPen
protected
double QgsComposerScaleBar::mSegmentMillimeters
protected

Width of a segment (in mm)

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

Referenced by readXML(), and writeXML().

ScaleBarUnits QgsComposerScaleBar::mUnits
protected

Definition at line 284 of file qgscomposerscalebar.h.

Referenced by applyDefaultSize(), mapWidth(), readXML(), setUnits(), and writeXML().


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