qgsscalecombobox.h

Go to the documentation of this file.

/***************************************************************************
                              qgsscalecombobox.h
                              ------------------------
  begin                : January 7, 2012
  copyright            : (C) 2012 by Alexander Bruy
  email                : alexander dot bruy 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 QGSSCALECOMBOBOX_H
#define QGSSCALECOMBOBOX_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QComboBox>

class GUI_EXPORT QgsScaleComboBox : public QComboBox
{
    Q_OBJECT
    Q_PROPERTY( double scale READ scale WRITE setScale NOTIFY scaleChanged )
    Q_PROPERTY( double minScale READ minScale WRITE setMinScale )
    Q_PROPERTY( RatioMode ratioMode READ ratioMode WRITE setRatioMode NOTIFY ratioModeChanged )
 
  public:
    enum class RatioMode : int
    {
      ForceUnitNumerator, 
      Flexible,           
    };
    Q_ENUM( RatioMode )
 
    
    QgsScaleComboBox( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    QString scaleString() const;

    bool setScaleString( const QString &string );

    double scale() const;

    bool isNull() const;

    double minScale() const { return mMinScale; }

    static QString toString( double scale, QgsScaleComboBox::RatioMode mode = QgsScaleComboBox::RatioMode::ForceUnitNumerator );

    static double toDouble( const QString &string, bool *ok = nullptr );

    void setAllowNull( bool allowNull );

    bool allowNull() const;

    void setPredefinedScales( const QVector<double> &scales );

    QgsScaleComboBox::RatioMode ratioMode() const;
 
  signals:

    void scaleChanged( double scale );

    void ratioModeChanged( QgsScaleComboBox::RatioMode mode );
 
  public slots:

    void updateScales( const QStringList &scales = QStringList() );

    void setScale( double scale );

    void setMinScale( double scale );

    void setNull();

    void setRatioMode( QgsScaleComboBox::RatioMode mode );
 
  protected:
    void showPopup() override;
 
  private slots:
    void fixupScale();
 
  private:
    double mScale = 1.0;
    double mMinScale = 0.0;
    bool mAllowNull = false;
    QgsScaleComboBox::RatioMode mMode = QgsScaleComboBox::RatioMode::ForceUnitNumerator;
};
 
#endif // QGSSCALECOMBOBOX_H