qgsscalewidget.h

Go to the documentation of this file.

/***************************************************************************
   qgsscalewidget.h
    --------------------------------------
   Date                 : 08.01.2015
   Copyright            : (C) 2014 Denis Rouzaud
   Email                : denis.rouzaud@gmail.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 QGSSCALEWIDGET_H
#define QGSSCALEWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsscalecombobox.h"
 
#include <QToolButton>
#include <QWidget>
 
class QgsMapCanvas;

class GUI_EXPORT QgsScaleWidget : public QWidget
{
    Q_OBJECT
    Q_PROPERTY( bool showCurrentScaleButton READ showCurrentScaleButton WRITE setShowCurrentScaleButton )
    Q_PROPERTY( bool scale READ scale WRITE setScale NOTIFY scaleChanged )
    Q_PROPERTY( bool minScale READ minScale WRITE setMinScale )
 
  public:
    explicit QgsScaleWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setShowCurrentScaleButton( bool showCurrentScaleButton );

    bool showCurrentScaleButton() const { return mShowCurrentScaleButton; }

    void setMapCanvas( QgsMapCanvas *canvas );

    QString scaleString() const { return mScaleComboBox->scaleString(); }

    bool setScaleString( const QString &string ) { return mScaleComboBox->setScaleString( string ); }

    double scale() const { return mScaleComboBox->scale(); }

    bool isNull() const;

    double minScale() const { return mScaleComboBox->minScale(); }

    static QString toString( double scale ) { return QgsScaleComboBox::toString( scale ); }

    static double toDouble( const QString &scaleString, bool *ok = nullptr ) { return QgsScaleComboBox::toDouble( scaleString, ok ); }

    void setAllowNull( bool allowNull );

    bool allowNull() const;

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

    void setScale( double scale );

    void updateScales( const QStringList &scales = QStringList() ) { mScaleComboBox->updateScales( scales ); }

    void setScaleFromCanvas();

    void setMinScale( double scale ) { mScaleComboBox->setMinScale( scale ); }

    void setNull();
 
  signals:

    void scaleChanged( double scale );
 
  private slots:
 
    void menuAboutToShow();
 
  private:
    QgsScaleComboBox *mScaleComboBox = nullptr;
    QToolButton *mCurrentScaleButton = nullptr;
    QgsMapCanvas *mCanvas = nullptr;
    QMenu *mMenu = nullptr;
    bool mShowCurrentScaleButton = false;
};
 
#endif // QGSSCALEWIDGET_H