qgscoordinateformatter.h

Go to the documentation of this file.

/***************************************************************************
                          qgscoordinateformatter.h
                          ------------------------
    begin                : Decemeber 2015
    copyright            : (C) 2015 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 QGSCOORDINATEFORMATTER_H
#define QGSCOORDINATEFORMATTER_H
 
#include "qgis_sip.h"
#include "qgspointxy.h"
 
#include <QString>

 
class CORE_EXPORT QgsCoordinateFormatter
{
  public:
    enum Format
    {
      FormatPair,                  
      FormatDegreesMinutesSeconds, 
      FormatDegreesMinutes,        
      FormatDecimalDegrees,        
    };

    enum FormatFlag SIP_ENUM_BASETYPE( IntFlag )
    {
      FlagDegreesUseStringSuffix = 1 << 1,   
      FlagDegreesPadMinutesSeconds = 1 << 2, 
    };
    Q_DECLARE_FLAGS( FormatFlags, FormatFlag )
 
    
    static QString formatX( double x, Format format, int precision = 12, FormatFlags flags = FlagDegreesUseStringSuffix );

    static QString formatY( double y, Format format, int precision = 12, FormatFlags flags = FlagDegreesUseStringSuffix );

    static QString format( const QgsPointXY &point, Format format, int precision = 12, FormatFlags flags = FlagDegreesUseStringSuffix, Qgis::CoordinateOrder order = Qgis::CoordinateOrder::XY );

    static QString asPair( double x, double y, int precision = 12, Qgis::CoordinateOrder order = Qgis::CoordinateOrder::XY );

    static QChar separator();
 
  private:
    static QString formatAsPair( double val, int precision );
 
    static QString formatXAsDegreesMinutesSeconds( double val, int precision, FormatFlags flags );
    static QString formatYAsDegreesMinutesSeconds( double val, int precision, FormatFlags flags );
 
    static QString formatXAsDegreesMinutes( double val, int precision, FormatFlags flags );
    static QString formatYAsDegreesMinutes( double val, int precision, FormatFlags flags );
 
    static QString formatXAsDegrees( double val, int precision, FormatFlags flags );
    static QString formatYAsDegrees( double val, int precision, FormatFlags flags );
 
    friend class QgsCoordinateUtils;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsCoordinateFormatter::FormatFlags )
 
#endif // QGSCOORDINATEFORMATTER_H