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 "scalebar/qgsscalebarsettings.h"
#include "scalebar/qgsscalebarrenderer.h"
#include <QFont>
#include <QPen>
#include <QColor>

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 );

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

    void setUnitsPerSegment( double units );

    QgsScaleBarSettings::SegmentSizeMode segmentSizeMode() const { return mSettings.segmentSizeMode(); }

    void setSegmentSizeMode( QgsScaleBarSettings::SegmentSizeMode 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 );

    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;

    QColor fillColor() const { return mSettings.fillColor(); }

    void setFillColor( const QColor &color ) { mSettings.setFillColor( color ); }

    QColor fillColor2() const { return mSettings.fillColor2(); }

    void setFillColor2( const QColor &color ) { mSettings.setFillColor2( color ); }

    QColor lineColor() const { return mSettings.lineColor(); }

    void setLineColor( const QColor &color ) { mSettings.setLineColor( color ); }

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

    void setLineWidth( double width ) { mSettings.setLineWidth( width ); }

    QPen pen() const { return mSettings.pen(); }

    QBrush brush() const {return mSettings.brush();}

    QBrush brush2() const {return mSettings.brush2(); }

    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 );

    QgsScaleBarSettings::LabelVerticalPlacement labelVerticalPlacement() const { return mSettings.labelVerticalPlacement(); }

    void setLabelVerticalPlacement( QgsScaleBarSettings::LabelVerticalPlacement placement );

    QgsScaleBarSettings::LabelHorizontalPlacement labelHorizontalPlacement() const { return mSettings.labelHorizontalPlacement(); }

    void setLabelHorizontalPlacement( QgsScaleBarSettings::LabelHorizontalPlacement placement );

    QgsScaleBarSettings::Alignment alignment() const { return mSettings.alignment(); }

    void setAlignment( QgsScaleBarSettings::Alignment alignment );

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

    void setUnits( QgsUnitTypes::DistanceUnit units );

    Qt::PenJoinStyle lineJoinStyle() const { return mSettings.lineJoinStyle(); }

    void setLineJoinStyle( Qt::PenJoinStyle style );

    Qt::PenCapStyle lineCapStyle() const { return mSettings.lineCapStyle(); }

    void setLineCapStyle( Qt::PenCapStyle style );

    void applyDefaultSettings();

    QgsUnitTypes::DistanceUnit guessUnits() const;

    void applyDefaultSize( QgsUnitTypes::DistanceUnit units = QgsUnitTypes::DistanceMeters );

    void resizeToMinimumWidth();

    void setStyle( const QString &name );

    QString style() const;

    void update();

    void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::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;

    std::unique_ptr< QgsScaleBarRenderer > mStyle;

    double mSegmentMillimeters = 0.0;

    void refreshSegmentMillimeters();

    double mapWidth() const;

    QgsScaleBarRenderer::ScaleBarContext createScaleContext() const;

    friend class QgsCompositionConverter;

};

#endif //QGSLAYOUTITEMSCALEBAR_H