qgsscalebarrenderer.h

Go to the documentation of this file.

/***************************************************************************
                            qgsscalebarrenderer.h
                            ---------------------
    begin                : June 2008
    copyright            : (C) 2008 by Marco Hugentobler
    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 QGSSCALEBARRENDERER_H
#define QGSSCALEBARRENDERER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QList>
#include <QRectF>
 
class QgsRenderContext;
class QgsScaleBarSettings;

class CORE_EXPORT QgsScaleBarRenderer
{
  public:

    enum class Flag : int SIP_ENUM_BASETYPE( IntFlag )
    {
      FlagUsesLineSymbol = 1 << 0, 
      FlagUsesFillSymbol = 1 << 1, 
      FlagUsesAlternateFillSymbol = 1 << 2, 
      FlagRespectsUnits = 1 << 3, 
      FlagRespectsMapUnitsPerScaleBarUnit = 1 << 4, 
      FlagUsesUnitLabel = 1 << 5, 
      FlagUsesSegments = 1 << 6, 
      FlagUsesLabelBarSpace = 1 << 7, 
      FlagUsesLabelVerticalPlacement = 1 << 8, 
      FlagUsesLabelHorizontalPlacement = 1 << 8, 
      FlagUsesAlignment = 1 << 9, 
      FlagUsesSubdivisions = 1 << 10, 
      FlagUsesDivisionSymbol = 1 << 11, 
      FlagUsesSubdivisionSymbol = 1 << 12, 
      FlagUsesSubdivisionsHeight = 1 << 13, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    
    struct CORE_EXPORT ScaleBarContext
    {

      double segmentWidth { 0.0 };

      QSizeF size;

      double scale { 1.0 };

      QgsScaleBarRenderer::Flags flags;

      bool isValid() const;
 
    };
 
    QgsScaleBarRenderer() = default;
    virtual ~QgsScaleBarRenderer() = default;

    Q_DECL_DEPRECATED QString name() const SIP_DEPRECATED { return id(); }

    virtual QString id() const = 0;

    virtual QString visibleName() const = 0;

    virtual Flags flags() const;

    virtual int sortKey() const;

    virtual QgsScaleBarRenderer *clone() const = 0 SIP_FACTORY;

    virtual void draw( QgsRenderContext &context,
                       const QgsScaleBarSettings &settings,
                       const QgsScaleBarRenderer::ScaleBarContext &scaleContext ) const = 0;

    Q_DECL_DEPRECATED virtual QSizeF calculateBoxSize( const QgsScaleBarSettings &settings,
        const QgsScaleBarRenderer::ScaleBarContext &scaleContext ) const SIP_DEPRECATED;

    virtual QSizeF calculateBoxSize( QgsRenderContext &context,
                                     const QgsScaleBarSettings &settings,
                                     const QgsScaleBarRenderer::ScaleBarContext &scaleContext ) const;

    virtual bool applyDefaultSettings( QgsScaleBarSettings &settings ) const;
 
  protected:

    void drawDefaultLabels( QgsRenderContext &context,
                            const QgsScaleBarSettings &settings,
                            const QgsScaleBarRenderer::ScaleBarContext &scaleContext ) const;

    QString firstLabelString( const QgsScaleBarSettings &settings ) const;

    Q_DECL_DEPRECATED double firstLabelXOffset( const QgsScaleBarSettings &settings ) const SIP_DEPRECATED;

    double firstLabelXOffset( const QgsScaleBarSettings &settings, const QgsRenderContext &context, const ScaleBarContext &scaleContext ) const;

    Q_DECL_DEPRECATED QList<double> segmentPositions( const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings ) const SIP_DEPRECATED;

    QList<double> segmentPositions( QgsRenderContext &context, const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings ) const;

    QList<double> segmentWidths( const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings ) const;
 
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsScaleBarRenderer::Flags )
 
#endif //QGSSCALEBARRENDERER_H