qgsscalebarsettings.h

Go to the documentation of this file.

/***************************************************************************
                            qgsscalebarsettings.h
                            ---------------------
    begin                : April 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   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 QGSSCALEBARSETTINGS_H
#define QGSSCALEBARSETTINGS_H

#include "qgis_core.h"
#include "qgis.h"
#include "qgsunittypes.h"
#include "qgstextrenderer.h"
#include <QColor>
#include <QFont>
#include <QPen>
#include <QBrush>

class QgsNumericFormat;


class CORE_EXPORT QgsScaleBarSettings
{
  public:

    enum Alignment
    {
      AlignLeft = 0, 
      AlignMiddle, 
      AlignRight, 
    };

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

    enum LabelVerticalPlacement
    {
      LabelAboveSegment = 0, 
      LabelBelowSegment, 
    };

    enum LabelHorizontalPlacement
    {
      LabelCenteredEdge = 0, 
      LabelCenteredSegment, 
    };

    QgsScaleBarSettings();

    ~QgsScaleBarSettings();

    QgsScaleBarSettings( const QgsScaleBarSettings &other );

    QgsScaleBarSettings &operator=( const QgsScaleBarSettings &other );

    int numberOfSegments() const { return mNumSegments; }

    void setNumberOfSegments( int segments ) { mNumSegments = segments; }

    int numberOfSegmentsLeft() const { return mNumSegmentsLeft; }

    void setNumberOfSegmentsLeft( int segments ) { mNumSegmentsLeft = segments; }

    double unitsPerSegment() const { return mNumUnitsPerSegment; }

    void setUnitsPerSegment( double units ) { mNumUnitsPerSegment = units; }

    SegmentSizeMode segmentSizeMode() const { return mSegmentSizeMode; }

    void setSegmentSizeMode( SegmentSizeMode mode ) { mSegmentSizeMode = mode; }

    double minimumBarWidth() const { return mMinBarWidth; }

    void setMinimumBarWidth( double width ) { mMinBarWidth = width; }

    double maximumBarWidth() const { return mMaxBarWidth; }

    void setMaximumBarWidth( double width ) { mMaxBarWidth = width; }

    QgsUnitTypes::DistanceUnit units() const { return mUnits; }

    void setUnits( QgsUnitTypes::DistanceUnit units ) { mUnits = units; }

    double mapUnitsPerScaleBarUnit() const { return mNumMapUnitsPerScaleBarUnit; }

    void setMapUnitsPerScaleBarUnit( double units ) { mNumMapUnitsPerScaleBarUnit = units; }

    QString unitLabel() const { return mUnitLabeling; }

    void setUnitLabel( const QString &label ) { mUnitLabeling = label; }

    QgsTextFormat &textFormat() { return mTextFormat; }

    QgsTextFormat textFormat() const SIP_SKIP { return mTextFormat; }

    void setTextFormat( const QgsTextFormat &format ) { mTextFormat = format; }

    Q_DECL_DEPRECATED QFont font() const SIP_DEPRECATED { return mTextFormat.font(); }

    Q_DECL_DEPRECATED void setFont( const QFont &font ) SIP_DEPRECATED
    {
      mTextFormat.setFont( font );
      if ( font.pointSizeF() > 0 )
      {
        mTextFormat.setSize( font.pointSizeF() );
        mTextFormat.setSizeUnit( QgsUnitTypes::RenderPoints );
      }
      else if ( font.pixelSize() > 0 )
      {
        mTextFormat.setSize( font.pixelSize() );
        mTextFormat.setSizeUnit( QgsUnitTypes::RenderPixels );
      }
    }

    Q_DECL_DEPRECATED QColor fontColor() const SIP_DEPRECATED { return mTextFormat.color(); }

    Q_DECL_DEPRECATED void setFontColor( const QColor &color ) SIP_DEPRECATED { mTextFormat.setColor( color ); }

    QColor fillColor() const { return mFillColor; }

    void setFillColor( const QColor &color ) { mFillColor = color; mBrush.setColor( color ); }

    QColor fillColor2() const {return mFillColor2;}

    void setFillColor2( const QColor &color ) { mFillColor2 = color; mBrush2.setColor( color ); }

    QColor lineColor() const { return mLineColor; }

    void setLineColor( const QColor &color ) { mLineColor = color; mPen.setColor( mLineColor ); }

    double lineWidth() const { return mLineWidth; }

    void setLineWidth( double width ) { mLineWidth = width; mPen.setWidthF( width ); }

    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 height ) { mHeight = height; }

    double labelBarSpace() const { return mLabelBarSpace; }

    void setLabelBarSpace( double space ) { mLabelBarSpace = space; }

    LabelVerticalPlacement labelVerticalPlacement() const { return mLabelVerticalPlacement; }

    void setLabelVerticalPlacement( LabelVerticalPlacement placement ) { mLabelVerticalPlacement = placement; }

    LabelHorizontalPlacement labelHorizontalPlacement() const { return mLabelHorizontalPlacement; }

    void setLabelHorizontalPlacement( LabelHorizontalPlacement placement ) { mLabelHorizontalPlacement = placement; }

    double boxContentSpace() const { return mBoxContentSpace; }

    void setBoxContentSpace( double space ) { mBoxContentSpace = space; }

    Alignment alignment() const { return mAlignment; }

    void setAlignment( Alignment alignment ) { mAlignment = alignment; }

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

    void setLineJoinStyle( Qt::PenJoinStyle style ) { mLineJoinStyle = style; mPen.setJoinStyle( style ); }

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

    void setLineCapStyle( Qt::PenCapStyle style ) { mLineCapStyle = style; mPen.setCapStyle( style ); }

    const QgsNumericFormat *numericFormat() const;

    void setNumericFormat( QgsNumericFormat *format SIP_TRANSFER );

  private:

    int mNumSegments = 2;
    int mNumSegmentsLeft = 0;
    double mNumUnitsPerSegment = 0;
    double mNumMapUnitsPerScaleBarUnit = 1.0;
    SegmentSizeMode mSegmentSizeMode = SegmentSizeFixed;
    double mMinBarWidth = 50.0;
    double mMaxBarWidth = 150.0;

    QString mUnitLabeling;

    QgsTextFormat mTextFormat;

    QColor mFillColor = QColor( 0, 0, 0 );
    QColor mFillColor2 = QColor( 255, 255, 255 );
    QColor mLineColor = QColor( 0, 0, 0 );
    double mLineWidth = 0.3;
    QPen mPen;
    QBrush mBrush;
    QBrush mBrush2;
    double mHeight = 3.0;

    double mLabelBarSpace = 3.0;
    LabelVerticalPlacement mLabelVerticalPlacement = LabelAboveSegment;
    LabelHorizontalPlacement mLabelHorizontalPlacement = LabelCenteredEdge;

    double mBoxContentSpace = 1.0;

    Alignment mAlignment = AlignLeft;

    QgsUnitTypes::DistanceUnit mUnits = QgsUnitTypes::DistanceMeters;

    Qt::PenJoinStyle mLineJoinStyle = Qt::MiterJoin;
    Qt::PenCapStyle mLineCapStyle = Qt::SquareCap;

    std::unique_ptr< QgsNumericFormat > mNumericFormat;

};

#endif // QGSSCALEBARSETTINGS_H