qgslayoutitemscalebar.h

Go to the documentation of this file.

/***************************************************************************
                            qgslayoutitemscalebar.h
                            ------------------------
    begin                : November 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 QGSLAYOUTITEMSCALEBAR_H
#define QGSLAYOUTITEMSCALEBAR_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayoutitem.h"
#include "qgsscalebarrenderer.h"
#include "qgsscalebarsettings.h"
 
#include <QColor>
#include <QFont>
#include <QPen>
 
class QgsLayoutItemMap;

class CORE_EXPORT QgsLayoutItemScaleBar: public QgsLayoutItem
{
    Q_OBJECT
 
  public:

    QgsLayoutItemScaleBar( QgsLayout *layout );
 
    int type() const override;
    QIcon icon() const override;

    static QgsLayoutItemScaleBar *create( QgsLayout *layout ) SIP_FACTORY;
    QgsLayoutSize minimumSize() const override;

    int numberOfSegments() const { return mSettings.numberOfSegments(); }

    void setNumberOfSegments( int segments );

    int numberOfSegmentsLeft() const { return mSettings.numberOfSegmentsLeft(); }

    void setNumberOfSegmentsLeft( int segments );

    int numberOfSubdivisions()  const { return mSettings.numberOfSubdivisions(); }

    void setNumberOfSubdivisions( int subdivisions ) { mSettings.setNumberOfSubdivisions( subdivisions ); }

    double subdivisionsHeight() const { return mSettings.subdivisionsHeight(); }

    void setSubdivisionsHeight( double height ) { mSettings.setSubdivisionsHeight( height ); }

    double unitsPerSegment() const { return mSettings.unitsPerSegment(); }

    void setUnitsPerSegment( double units );

    Qgis::ScaleBarSegmentSizeMode segmentSizeMode() const { return mSettings.segmentSizeMode(); }

    void setSegmentSizeMode( Qgis::ScaleBarSegmentSizeMode mode );

    double minimumBarWidth() const { return mSettings.minimumBarWidth(); }

    void setMinimumBarWidth( double minWidth );

    double maximumBarWidth() const { return mSettings.maximumBarWidth(); }

    void setMaximumBarWidth( double maxWidth );

    double mapUnitsPerScaleBarUnit() const { return mSettings.mapUnitsPerScaleBarUnit(); }

    void setMapUnitsPerScaleBarUnit( double units ) { mSettings.setMapUnitsPerScaleBarUnit( units ); }

    QString unitLabel() const { return mSettings.unitLabel(); }

    void setUnitLabel( const QString &label ) { mSettings.setUnitLabel( label );}

    QgsTextFormat textFormat() const;

    void setTextFormat( const QgsTextFormat &format );
 

    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 QFont font() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setFont( const QFont &font ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QColor fontColor() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setFontColor( const QColor &color ) SIP_DEPRECATED;

    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 QBrush brush() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED QBrush brush2() const SIP_DEPRECATED;

    double height() const { return mSettings.height(); }

    void setHeight( double height ) { mSettings.setHeight( height ); }

    void setLinkedMap( QgsLayoutItemMap *map );

    QgsLayoutItemMap *linkedMap() const { return mMap; }

    double labelBarSpace() const { return mSettings.labelBarSpace(); }

    void setLabelBarSpace( double space ) {mSettings.setLabelBarSpace( space );}

    double boxContentSpace() const { return mSettings.boxContentSpace(); }

    void setBoxContentSpace( double space );

    Qgis::ScaleBarDistanceLabelVerticalPlacement labelVerticalPlacement() const { return mSettings.labelVerticalPlacement(); }

    void setLabelVerticalPlacement( Qgis::ScaleBarDistanceLabelVerticalPlacement placement );

    Qgis::ScaleBarDistanceLabelHorizontalPlacement labelHorizontalPlacement() const { return mSettings.labelHorizontalPlacement(); }

    void setLabelHorizontalPlacement( Qgis::ScaleBarDistanceLabelHorizontalPlacement placement );

    Qgis::ScaleBarAlignment alignment() const { return mSettings.alignment(); }

    void setAlignment( Qgis::ScaleBarAlignment alignment );

    Qgis::DistanceUnit units() const { return mSettings.units(); }

    void setUnits( Qgis::DistanceUnit units );

    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;

    void applyDefaultSettings();

    bool applyDefaultRendererSettings( QgsScaleBarRenderer *renderer );

    Qgis::DistanceUnit guessUnits() const;

    void applyDefaultSize( Qgis::DistanceUnit units = Qgis::DistanceUnit::Meters );

    void resizeToMinimumWidth();

    void setStyle( const QString &name );

    QString style() const;

    const QgsNumericFormat *numericFormat() const;

    void setNumericFormat( QgsNumericFormat *format SIP_TRANSFER );

    Qgis::ScaleCalculationMethod method() const;

    void setMethod( Qgis::ScaleCalculationMethod method );

    void update();
 
    void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::DataDefinedProperty::AllProperties ) override;
    void finalizeRestoreFromXml() override;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
    ExportLayerBehavior exportLayerBehavior() const override;
 
  protected:
 
    void draw( QgsLayoutItemRenderContext &context ) override;
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
 
  private slots:
    void updateScale();
    void disconnectCurrentMap();
 
  private:

    QgsLayoutItemMap *mMap = nullptr;
    QString mMapUuid;
 
    QgsScaleBarSettings mSettings;
    Qgis::ScaleCalculationMethod mMethod = Qgis::ScaleCalculationMethod::HorizontalAverage;

    std::unique_ptr< QgsScaleBarRenderer > mStyle;

    double mSegmentMillimeters = 0.0;

    void refreshSegmentMillimeters();

    double mapWidth() const;
 
    QgsScaleBarRenderer::ScaleBarContext createScaleContext() const;
 
    friend class QgsCompositionConverter;

    void refreshUnitsPerSegment( const QgsExpressionContext *context = nullptr );

    void refreshNumberOfSegmentsLeft( const QgsExpressionContext *context = nullptr );

    void refreshNumberOfSegmentsRight( const QgsExpressionContext *context = nullptr );

    void refreshMinimumBarWidth( const QgsExpressionContext *context = nullptr );

    void refreshMaximumBarWidth( const QgsExpressionContext *context = nullptr );
};
 
#endif //QGSLAYOUTITEMSCALEBAR_H