qgsrendererrange.h

Go to the documentation of this file.

/***************************************************************************
    qgsrendererrange.h
    ---------------------
    begin                : September 2019
    copyright            : (C) 2019 by Denis Rouzaud
    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 QGSRENDERERRANGE_H
#define QGSRENDERERRANGE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgssymbollayerutils.h"
 
#include <QRegularExpression>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QDomDocument;
class QDomElement;
 
class QgsSymbol;
class QgsClassificationRange;
 

class CORE_EXPORT QgsRendererRange
{
  public:
    QgsRendererRange() = default;
    ~QgsRendererRange();

    QgsRendererRange( const QgsClassificationRange &range, QgsSymbol *symbol SIP_TRANSFER, bool render = true, const QString &uuid = QString() );

    QgsRendererRange( double lowerValue, double upperValue, QgsSymbol *symbol SIP_TRANSFER, const QString &label, bool render = true, const QString &uuid = QString() );
    QgsRendererRange( const QgsRendererRange &range );
 
    // default dtor is OK
    QgsRendererRange &operator=( QgsRendererRange range );
 
    bool operator<( const QgsRendererRange &other ) const;

    QString uuid() const;

    double lowerValue() const;

    double upperValue() const;

    QgsSymbol *symbol() const;

    QString label() const;

    void setSymbol( QgsSymbol *s SIP_TRANSFER );

    void setLabel( const QString &label );

    void setLowerValue( double lowerValue );

    void setUpperValue( double upperValue );

    bool renderState() const;

    void setRenderState( bool render );

    QString dump() const;

    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, QVariantMap props, bool firstRange = false ) const SIP_DEPRECATED;

    bool toSld( QDomDocument &doc, QDomElement &element, const QString &classAttribute, QgsSldExportContext &context, bool firstRange = false ) const;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = sipCpp->label().isEmpty()
                        ? u"<QgsRendererRange: %1 - %2>"_s.arg( sipCpp->lowerValue() ).arg( sipCpp->upperValue() )
                        : u"<QgsRendererRange: %1 - %2 (%3)>"_s.arg( sipCpp->lowerValue() ).arg( sipCpp->upperValue() ).arg( sipCpp->label() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
 
    SIP_PYOBJECT __getitem__( int );
    % MethodCode
    if ( a0 == 0 )
    {
      sipRes = Py_BuildValue( "d", sipCpp->lowerValue() );
    }
    else if ( a0 == 1 )
    {
      sipRes = Py_BuildValue( "d", sipCpp->upperValue() );
    }
    else
    {
      QString msg = QString( "Bad index: %1" ).arg( a0 );
      PyErr_SetString( PyExc_IndexError, msg.toLatin1().constData() );
    }
    % End
// clang-format on
#endif
 
    // clang-format off
    protected:
    // clang-format on
    friend class QgsGraduatedSymbolRendererWidget;
 
    double mLowerValue = 0, mUpperValue = 0;
    std::unique_ptr<QgsSymbol> mSymbol;
    QString mLabel;
    bool mRender = true;
    QString mUuid;
};
 
typedef QList<QgsRendererRange> QgsRangeList;
 

class CORE_DEPRECATED_EXPORT QgsRendererRangeLabelFormat SIP_DEPRECATED
{
  public:
    QgsRendererRangeLabelFormat();
    QgsRendererRangeLabelFormat( const QString &format, int precision = 4, bool trimTrailingZeroes = false );
 
    bool operator==( const QgsRendererRangeLabelFormat &other ) const;
    bool operator!=( const QgsRendererRangeLabelFormat &other ) const;
 
    QString format() const { return mFormat; }
    void setFormat( const QString &format ) { mFormat = format; }
 
    int precision() const { return mPrecision; }
    void setPrecision( int precision );
 
    bool trimTrailingZeroes() const { return mTrimTrailingZeroes; }
    void setTrimTrailingZeroes( bool trimTrailingZeroes ) { mTrimTrailingZeroes = trimTrailingZeroes; }

    QString labelForRange( double lower, double upper ) const SIP_PYNAME( labelForLowerUpper );
    QString labelForRange( const QgsRendererRange &range ) const;
    QString formatNumber( double value ) const;
 
    void setFromDomElement( QDomElement &element );
    void saveToDomElement( QDomElement &element );
 
    static const int MAX_PRECISION;
    static const int MIN_PRECISION;
 
  protected:
    QString mFormat;
    int mPrecision = 4;
    bool mTrimTrailingZeroes = false;
    // values used to manage number formatting - precision and trailing zeroes
    double mNumberScale = 1.0;
    QString mNumberSuffix;
    QRegularExpression mReTrailingZeroes;
    QRegularExpression mReNegativeZero;
};
 
 
#endif // QGSRENDERERRANGE_H