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.h"
#include "qgis_core.h"
#include "qgstextformat.h"
 
#include <QBrush>
#include <QColor>
#include <QFont>
#include <QPen>
 
class QgsNumericFormat;
class QgsLineSymbol;
class QgsFillSymbol;

class CORE_EXPORT QgsScaleBarSettings
{
  public:
    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; }

    int numberOfSubdivisions() const { return mNumSubdivisions; }

    void setNumberOfSubdivisions( int subdivisions ) { mNumSubdivisions = subdivisions; }

    double subdivisionsHeight() const { return mSubdivisionsHeight; }

    void setSubdivisionsHeight( double height ) { mSubdivisionsHeight = height; }

    double unitsPerSegment() const { return mNumUnitsPerSegment; }

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

    Qgis::ScaleBarSegmentSizeMode segmentSizeMode() const { return mSegmentSizeMode; }

    void setSegmentSizeMode( Qgis::ScaleBarSegmentSizeMode 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; }

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

    void setUnits( Qgis::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( Qgis::RenderUnit::Points );
      }
      else if ( font.pixelSize() > 0 )
      {
        mTextFormat.setSize( font.pixelSize() );
        mTextFormat.setSizeUnit( Qgis::RenderUnit::Pixels );
      }
    }

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

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

    Q_DECL_DEPRECATED QColor fillColor() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setFillColor( const QColor &color ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QColor fillColor2() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setFillColor2( const QColor &color ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QColor lineColor() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setLineColor( const QColor &color ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED double lineWidth() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setLineWidth( double width ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QPen pen() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setPen( const QPen &pen ) SIP_DEPRECATED;

    QgsLineSymbol *lineSymbol() const;

    void setLineSymbol( QgsLineSymbol *symbol SIP_TRANSFER );

    QgsLineSymbol *divisionLineSymbol() const;

    void setDivisionLineSymbol( QgsLineSymbol *symbol SIP_TRANSFER );

    QgsLineSymbol *subdivisionLineSymbol() const;

    void setSubdivisionLineSymbol( QgsLineSymbol *symbol SIP_TRANSFER );

    QgsFillSymbol *fillSymbol() const;

    void setFillSymbol( QgsFillSymbol *symbol SIP_TRANSFER );
 

    QgsFillSymbol *alternateFillSymbol() const;

    void setAlternateFillSymbol( QgsFillSymbol *symbol SIP_TRANSFER );

    Q_DECL_DEPRECATED QBrush brush() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setBrush( const QBrush &brush ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QBrush brush2() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setBrush2( const QBrush &brush ) SIP_DEPRECATED;

    double height() const { return mHeight; }

    void setHeight( double height ) { mHeight = height; }

    double labelBarSpace() const { return mLabelBarSpace; }

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

    Qgis::ScaleBarDistanceLabelVerticalPlacement labelVerticalPlacement() const { return mLabelVerticalPlacement; }

    void setLabelVerticalPlacement( Qgis::ScaleBarDistanceLabelVerticalPlacement placement ) { mLabelVerticalPlacement = placement; }

    Qgis::ScaleBarDistanceLabelHorizontalPlacement labelHorizontalPlacement() const { return mLabelHorizontalPlacement; }

    void setLabelHorizontalPlacement( Qgis::ScaleBarDistanceLabelHorizontalPlacement placement ) { mLabelHorizontalPlacement = placement; }

    Qgis::ScaleBarUnitLabelPlacements unitLabelPlacements() const { return mUnitLabelPlacements; }

    void setUnitLabelPlacements( Qgis::ScaleBarUnitLabelPlacements placements ) { mUnitLabelPlacements = placements; }

    double boxContentSpace() const { return mBoxContentSpace; }

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

    Qgis::ScaleBarAlignment alignment() const { return mAlignment; }

    void setAlignment( Qgis::ScaleBarAlignment alignment ) { mAlignment = alignment; }

    Q_DECL_DEPRECATED Qt::PenJoinStyle lineJoinStyle() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setLineJoinStyle( Qt::PenJoinStyle style ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED Qt::PenCapStyle lineCapStyle() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setLineCapStyle( Qt::PenCapStyle style ) SIP_DEPRECATED;

    const QgsNumericFormat *numericFormat() const;

    void setNumericFormat( QgsNumericFormat *format SIP_TRANSFER );
 
  private:
    int mNumSegments = 2;
    int mNumSegmentsLeft = 0;
    int mNumSubdivisions = 1;
    double mSubdivisionsHeight = 1.5;
    double mNumUnitsPerSegment = 0;
    double mNumMapUnitsPerScaleBarUnit = 1.0;
    Qgis::ScaleBarSegmentSizeMode mSegmentSizeMode = Qgis::ScaleBarSegmentSizeMode::Fixed;
    double mMinBarWidth = 50.0;
    double mMaxBarWidth = 150.0;

    QString mUnitLabeling;

    QgsTextFormat mTextFormat;

    double mHeight = 3.0;
 
    std::unique_ptr< QgsLineSymbol > mLineSymbol;
    std::unique_ptr< QgsLineSymbol > mDivisionLineSymbol;
    std::unique_ptr< QgsLineSymbol > mSubdivisionLineSymbol;
    std::unique_ptr< QgsFillSymbol > mFillSymbol;
    std::unique_ptr< QgsFillSymbol > mAlternateFillSymbol;

    double mLabelBarSpace = 3.0;
    Qgis::ScaleBarDistanceLabelVerticalPlacement mLabelVerticalPlacement = Qgis::ScaleBarDistanceLabelVerticalPlacement::AboveSegment;
    Qgis::ScaleBarDistanceLabelHorizontalPlacement mLabelHorizontalPlacement = Qgis::ScaleBarDistanceLabelHorizontalPlacement::CenteredEdge;
 
    Qgis::ScaleBarUnitLabelPlacements mUnitLabelPlacements = Qgis::ScaleBarUnitLabelPlacement::AfterLastDistanceLabel;

    double mBoxContentSpace = 1.0;
 
    Qgis::ScaleBarAlignment mAlignment = Qgis::ScaleBarAlignment::Left;
 
    Qgis::DistanceUnit mUnits = Qgis::DistanceUnit::Meters;
 
    std::unique_ptr< QgsNumericFormat > mNumericFormat;
};
 
#endif // QGSSCALEBARSETTINGS_H