qgscomposerscalebar.h

Go to the documentation of this file.

/***************************************************************************
                            qgscomposerscalebar.h
                             -------------------
    begin                : March 2005
    copyright            : (C) 2005 by Radim Blazek
    email                : [email protected]
 ***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSCOMPOSERSCALEBAR_H
#define QGSCOMPOSERSCALEBAR_H

#include "qgscomposeritem.h"
#include <QFont>
#include <QPen>
#include <QColor>

class QgsComposerMap;
class QgsScaleBarStyle;
class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
{
    Q_OBJECT

  public:

    enum Alignment
    {
      Left = 0,
      Middle,
      Right
    };

    enum ScaleBarUnits
    {
      MapUnits = 0,
      Meters,
      Feet,
      NauticalMiles
    };

    enum SegmentSizeMode
    {
      SegmentSizeFixed = 0, 
      SegmentSizeFitWidth = 1 
    };

    QgsComposerScaleBar( QgsComposition* composition );
    ~QgsComposerScaleBar();

    virtual int type() const override { return ComposerScaleBar; }

    void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override;

    //getters and setters
    int numSegments() const {return mNumSegments;}
    void setNumSegments( int nSegments );

    int numSegmentsLeft() const {return mNumSegmentsLeft;}
    void setNumSegmentsLeft( int nSegmentsLeft );

    double numUnitsPerSegment() const {return mNumUnitsPerSegment;}
    void setNumUnitsPerSegment( double units );

    SegmentSizeMode segmentSizeMode() const { return mSegmentSizeMode; }

    void setSegmentSizeMode( SegmentSizeMode mode );

    double minBarWidth() const { return mMinBarWidth; }

    void setMinBarWidth( double minWidth );

    double maxBarWidth() const { return mMaxBarWidth; }

    void setMaxBarWidth( double maxWidth );

    double numMapUnitsPerScaleBarUnit() const {return mNumMapUnitsPerScaleBarUnit;}
    void setNumMapUnitsPerScaleBarUnit( double d ) {mNumMapUnitsPerScaleBarUnit = d;}

    QString unitLabeling() const {return mUnitLabeling;}
    void setUnitLabeling( const QString& label ) {mUnitLabeling = label;}

    QFont font() const;
    void setFont( const QFont& font );

    QColor fontColor() const {return mFontColor;}

    void setFontColor( const QColor& c ) {mFontColor = c;}

    QPen pen() const {return mPen;}

    void setPen( const QPen& pen ) {mPen = pen;}

    QBrush brush() const {return mBrush;}

    void setBrush( const QBrush& brush ) {mBrush = brush;}

    QBrush brush2() const {return mBrush2;}

    void setBrush2( const QBrush& brush ) {mBrush2 = brush;}

    double height() const {return mHeight;}
    void setHeight( double h ) {mHeight = h;}

    void setComposerMap( const QgsComposerMap* map );
    const QgsComposerMap* composerMap() const {return mComposerMap;}

    double labelBarSpace() const {return mLabelBarSpace;}
    void setLabelBarSpace( double space ) {mLabelBarSpace = space;}

    double boxContentSpace() const {return mBoxContentSpace;}
    void setBoxContentSpace( double space );

    double segmentMillimeters() const {return mSegmentMillimeters;}

    Alignment alignment() const { return mAlignment; }

    void setAlignment( Alignment a );

    ScaleBarUnits units() const { return mUnits; }

    void setUnits( ScaleBarUnits u );

    Qt::PenJoinStyle lineJoinStyle() const { return mLineJoinStyle; }
    void setLineJoinStyle( Qt::PenJoinStyle style );

    Qt::PenCapStyle lineCapStyle() const { return mLineCapStyle; }
    void setLineCapStyle( Qt::PenCapStyle style );

    void applyDefaultSettings();
    void applyDefaultSize( ScaleBarUnits u = Meters );

    void setStyle( const QString& styleName );

    QString style() const;

    void segmentPositions( QList<QPair<double, double> >& posWidthList ) const;

    void adjustBoxSize();

    void update();

    QString firstLabelString() const;

    bool writeXML( QDomElement& elem, QDomDocument & doc ) const override;

    bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) override;

    void correctXPositionAlignment( double width, double widthAfter );

    //overridden to apply minimum size
    void setSceneRect( const QRectF &rectangle ) override;

  public slots:
    void updateSegmentSize();
    void invalidateCurrentMap();

  protected:

    const QgsComposerMap* mComposerMap;
    int mNumSegments;
    int mNumSegmentsLeft;
    double mNumUnitsPerSegment;
    double mNumMapUnitsPerScaleBarUnit;
    SegmentSizeMode mSegmentSizeMode;
    double mMinBarWidth;
    double mMaxBarWidth;

    QString mUnitLabeling;
    QFont mFont;
    QColor mFontColor;
    QPen mPen;
    QBrush mBrush;
    QBrush mBrush2;
    double mHeight;
    QgsScaleBarStyle* mStyle;

    double mLabelBarSpace;

    double mBoxContentSpace;

    double mSegmentMillimeters;

    Alignment mAlignment;

    ScaleBarUnits mUnits;

    Qt::PenJoinStyle mLineJoinStyle;
    Qt::PenCapStyle mLineCapStyle;

    void refreshSegmentMillimeters();

    double mapWidth() const;
};

#endif //QGSCOMPOSERSCALEBAR_H