AngleSpinBox.hpp

/*
 * Stellarium
 * Copyright (C) 2008 Matthew Gates
 * Copyright (C) 2015 Georg Zotti (min/max limits)
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _ANGLESPINBOX_HPP_
#define _ANGLESPINBOX_HPP_

#include <QAbstractSpinBox>
#include <QString>
#include <cmath>

class AngleSpinBox : public QAbstractSpinBox
{
    Q_OBJECT

public:
    enum DisplayFormat
    {
        DMSLetters,             
        DMSSymbols,             
        DMSLettersUnsigned,     
        DMSSymbolsUnsigned,     
        HMSLetters,             
        HMSSymbols,             
        DecimalDeg              
    };

    enum PrefixType
    {
        Normal,     
        NormalPlus, 
        Longitude,  
        Latitude,   
        Unknown
    };
    
    AngleSpinBox(QWidget* parent=0, DisplayFormat format=DMSSymbols, PrefixType prefix=Normal);
    ~AngleSpinBox();

    // QAbstractSpinBox virtual members
    virtual void stepBy(int steps);
    virtual QValidator::State validate(QString& input, int& pos) const;

    double valueRadians();
    double valueDegrees();

    void setDecimals(int places) { decimalPlaces = places; }

    int decimals() { return decimalPlaces; }

    void setDisplayFormat(DisplayFormat format) { angleSpinBoxFormat=format; formatText(); }

    DisplayFormat displayFormat() { return angleSpinBoxFormat; }

    void setPrefixType(PrefixType prefix) { currentPrefixType=prefix; formatText(); }

    PrefixType prefixType() { return currentPrefixType; }

    void setMinimum(const double min, const bool isDegrees=false) {minRad = min * (isDegrees? M_PI/180.0 : 1.); }
    double getMinimum(const bool isDegrees) { return minRad * (isDegrees ? 180.0/M_PI : 1.0); }

    void setMaximum(const double max, const bool isDegrees=false) {maxRad = max * (isDegrees? M_PI/180.0 : 1.); }
    double getMaximum(const bool isDegrees) { return maxRad * (isDegrees ? 180.0/M_PI : 1.0); }

    
public slots:
    virtual void clear();
    
    void setRadians(double radians);
    
    void setDegrees(double degrees);

signals:
    void valueChanged();

protected:
    virtual StepEnabled stepEnabled() const;

private slots:
    void updateValue(void);

private:
    double stringToDouble(QString input, QValidator::State* state, PrefixType prefix=Unknown) const;
    
    enum AngleSpinboxSection
    {
        SectionPrefix,          
        SectionDegreesHours,    
        SectionMinutes,         
        SectionSeconds,         
        SectionNone             
    };
    
    AngleSpinboxSection getCurrentSection() const;
    
    void formatText(void);
        
    static const QString positivePrefix(PrefixType prefix);
    static const QString negativePrefix(PrefixType prefix);

    DisplayFormat angleSpinBoxFormat;
    PrefixType currentPrefixType;
    int decimalPlaces;
    double radAngle;
    // min/max angles (radians), users should not be able to enter more/less.
    // Use together with the wrapping() property!
    double minRad;
    double maxRad;
};

#endif // _ANGLESPINBOX_HPP_