qgscoordinatenumericformat.h

Go to the documentation of this file.

/***************************************************************************
                             qgscoordinatenumericformat.h
                             --------------------------
    begin                : April 2022
    copyright            : (C) 2022 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 QGSCOORDINATENUMERICFORMAT_H
#define QGSCOORDINATENUMERICFORMAT_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsbasicnumericformat.h"

class CORE_EXPORT QgsGeographicCoordinateNumericFormat : public QgsBasicNumericFormat
{
    Q_GADGET
 
  public:
    enum class AngleFormat
    {
      DegreesMinutesSeconds, 
      DegreesMinutes,        
      DecimalDegrees,        
    };
    Q_ENUM( AngleFormat )
 
    
    QgsGeographicCoordinateNumericFormat();
 
    QString id() const override;
    QString visibleName() const override;
    int sortKey() override;
    double suggestSampleValue() const override;
    QString formatDouble( double value, const QgsNumericFormatContext &context ) const override;
    QgsGeographicCoordinateNumericFormat *clone() const override SIP_FACTORY;
    QgsNumericFormat *create( const QVariantMap &configuration, const QgsReadWriteContext &context ) const override SIP_FACTORY;
    QVariantMap configuration( const QgsReadWriteContext &context ) const override;

    AngleFormat angleFormat() const;

    void setAngleFormat( AngleFormat format );

    bool showLeadingZeros() const;

    void setShowLeadingZeros( bool show );

    bool showDegreeLeadingZeros() const;

    void setShowDegreeLeadingZeros( bool show );

    bool showDirectionalSuffix() const;

    void setShowDirectionalSuffix( bool show );
 
    void setConfiguration( const QVariantMap &configuration, const QgsReadWriteContext &context ) override;
 
  private:
    AngleFormat mAngleFormat = AngleFormat::DecimalDegrees;
    bool mShowLeadingZeros = false;
    bool mShowLeadingDegreeZeros = false;
    bool mUseSuffix = true;
 
    QString formatLongitude( double value, std::basic_stringstream<wchar_t> &ss, const QgsNumericFormatContext &context ) const;
    QString formatLatitude( double value, std::basic_stringstream<wchar_t> &ss, const QgsNumericFormatContext &context ) const;
 
    QString formatLatitudeAsDegreesMinutesSeconds( double val, std::basic_stringstream<wchar_t> &ss, const QgsNumericFormatContext &context ) const;
    QString formatLongitudeAsDegreesMinutesSeconds( double val, std::basic_stringstream<wchar_t> &ss, const QgsNumericFormatContext &context ) const;
 
    QString formatLatitudeAsDegreesMinutes( double val, std::basic_stringstream<wchar_t> &ss, const QgsNumericFormatContext &context ) const;
    QString formatLongitudeAsDegreesMinutes( double val, std::basic_stringstream<wchar_t> &ss, const QgsNumericFormatContext &context ) const;
 
    QString formatLatitudeAsDegrees( double val, std::basic_stringstream<wchar_t> &ss, const QgsNumericFormatContext &context ) const;
    QString formatLongitudeAsDegrees( double val, std::basic_stringstream<wchar_t> &ss, const QgsNumericFormatContext &context ) const;
 
    void trimTrailingZeros( QString &input, const QgsNumericFormatContext &context ) const;
};
 
#endif // QGSCOORDINATENUMERICFORMAT_H