qgsnumericformat.h

Go to the documentation of this file.

/***************************************************************************
                             qgsnumericformat.h
                             -------------------
    begin                : January 2020
    copyright            : (C) 2020 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 QGSNUMERICFORMAT_H
#define QGSNUMERICFORMAT_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsexpressioncontext.h"
 
#include <QDomDocument>
#include <QString>
#include <QVariantMap>
 
class QgsReadWriteContext;

class CORE_EXPORT QgsNumericFormatContext
{
    Q_GADGET
 
  public:
    QgsNumericFormatContext();

    QChar thousandsSeparator() const { return mThousandsSep; }

    void setThousandsSeparator( const QChar &separator ) { mThousandsSep = separator; }

    QChar decimalSeparator() const { return mDecimalSep; }

    void setDecimalSeparator( const QChar &separator ) { mDecimalSep = separator; }

    QChar percent() const { return mPercent; }

    void setPercent( const QChar &character ) { mPercent = character; }

    QChar zeroDigit() const { return mZeroDigit; }

    void setZeroDigit( const QChar &character ) { mZeroDigit = character; }

    QChar negativeSign() const { return mNegativeSign; }

    void setNegativeSign( const QChar &character ) { mNegativeSign = character; }

    QChar positiveSign() const { return mPositiveSign; }

    void setPositiveSign( const QChar &character ) { mPositiveSign = character; }

    QChar exponential() const { return mExponential; }

    void setExponential( const QChar &character ) { mExponential = character; }

    enum class Interpretation
    {
      Generic,   
      Latitude,  
      Longitude, 
    };
    Q_ENUM( Interpretation )
 
    
    Interpretation interpretation() const { return mInterpretation; }

    void setInterpretation( Interpretation interpretation ) { mInterpretation = interpretation; }

    QgsExpressionContext expressionContext() const;

    void setExpressionContext( const QgsExpressionContext &context );
 
  private:
    QChar mThousandsSep;
    QChar mDecimalSep;
    QChar mPercent;
    QChar mZeroDigit;
    QChar mNegativeSign;
    QChar mPositiveSign;
    QChar mExponential;
 
    Interpretation mInterpretation = Interpretation::Generic;
 
    QgsExpressionContext mExpressionContext;
};
 
#ifdef SIP_RUN
// clang-format off
% ModuleHeaderCode
#include <qgsbasicnumericformat.h>
#include <qgsbearingnumericformat.h>
#include <qgscurrencynumericformat.h>
#include <qgsfallbacknumericformat.h>
#include <qgspercentagenumericformat.h>
#include <qgsscientificnumericformat.h>
#include <qgscoordinatenumericformat.h>
#include <qgsexpressionbasednumericformat.h>
% End
// clang-format on
#endif

  class CORE_EXPORT QgsNumericFormat
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast< QgsBearingNumericFormat * >( sipCpp ) )
      sipType = sipType_QgsBearingNumericFormat;
    else if ( dynamic_cast< QgsGeographicCoordinateNumericFormat * >( sipCpp ) )
      sipType = sipType_QgsGeographicCoordinateNumericFormat;
    else if ( dynamic_cast< QgsFallbackNumericFormat * >( sipCpp ) )
      sipType = sipType_QgsFallbackNumericFormat;
    else if ( dynamic_cast< QgsPercentageNumericFormat * >( sipCpp ) )
      sipType = sipType_QgsPercentageNumericFormat;
    else if ( dynamic_cast< QgsScientificNumericFormat * >( sipCpp ) )
      sipType = sipType_QgsScientificNumericFormat;
    else if ( dynamic_cast< QgsCurrencyNumericFormat * >( sipCpp ) )
      sipType = sipType_QgsCurrencyNumericFormat;
    else if ( dynamic_cast< QgsBasicNumericFormat * >( sipCpp ) )
      sipType = sipType_QgsBasicNumericFormat;
    else if ( dynamic_cast< QgsFractionNumericFormat * >( sipCpp ) )
      sipType = sipType_QgsFractionNumericFormat;
    else if ( dynamic_cast< QgsExpressionBasedNumericFormat * >( sipCpp ) )
      sipType = sipType_QgsExpressionBasedNumericFormat;
    else
      sipType = NULL;
  SIP_END
#endif
 
  public:
 
    QgsNumericFormat() = default;
 
    virtual ~QgsNumericFormat() = default;

    virtual QString id() const = 0;

    virtual QString visibleName() const = 0;

    virtual int sortKey();

    virtual double suggestSampleValue() const;

    virtual QString formatDouble( double value, const QgsNumericFormatContext &context ) const = 0;

    virtual QgsNumericFormat *clone() const = 0 SIP_FACTORY;

    virtual QgsNumericFormat *create( const QVariantMap &configuration, const QgsReadWriteContext &context ) const = 0 SIP_FACTORY;

    virtual QVariantMap configuration( const QgsReadWriteContext &context ) const = 0;

    void writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
 
    bool operator==( const QgsNumericFormat &other ) const;
    bool operator!=( const QgsNumericFormat &other ) const;
 
  protected:
    static constexpr int DEFAULT_SORT_KEY = 100;
};
 
#endif // QGSNUMERICFORMAT_H