QGIS API Documentation  2.14.0-Essen
qgsscalewidget.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsscalewidget.h
3  --------------------------------------
4  Date : 08.01.2015
5  Copyright : (C) 2014 Denis Rouzaud
6  Email : [email protected]
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15 
16 #ifndef QGSSCALEWIDGET_H
17 #define QGSSCALEWIDGET_H
18 
19 #include <QWidget>
20 #include <QToolButton>
21 
22 
23 #include "qgsscalecombobox.h"
24 
25 class QgsMapCanvas;
26 
31 class GUI_EXPORT QgsScaleWidget : public QWidget
32 {
33  Q_OBJECT
34  Q_PROPERTY( bool showCurrentScaleButton READ showCurrentScaleButton WRITE setShowCurrentScaleButton )
35 
36  public:
37  explicit QgsScaleWidget( QWidget *parent = nullptr );
38 
39  virtual ~QgsScaleWidget();
40 
43  void setShowCurrentScaleButton( bool showCurrentScaleButton );
44  bool showCurrentScaleButton() { return mShowCurrentScaleButton;}
45 
47  void setMapCanvas( QgsMapCanvas* canvas );
48 
50  QString scaleString() { return mScaleComboBox->scaleString(); }
52  bool setScaleString( const QString& scaleTxt ) { return mScaleComboBox->setScaleString( scaleTxt ); }
54  double scale() { return mScaleComboBox->scale();}
56  void setScale( double scale ) { return mScaleComboBox->setScale( scale ); }
57 
59  // Performs rounding, so an exact representation is not to
60  // be expected.
61  static QString toString( double scale ) { return QgsScaleComboBox::toString( scale ); }
63  static double toDouble( const QString& scaleString, bool *ok = nullptr ) { return QgsScaleComboBox::toDouble( scaleString, ok ); }
64 
65  public slots:
66  void updateScales( const QStringList &scales = QStringList() ) { return mScaleComboBox->updateScales( scales ); }
67 
69  void setScaleFromCanvas();
70 
71  signals:
73  void scaleChanged();
74 
75  private:
76  QgsScaleComboBox* mScaleComboBox;
77  QToolButton* mCurrentScaleButton;
78  QgsMapCanvas* mCanvas;
79  bool mShowCurrentScaleButton;
80 };
81 
82 #endif // QGSSCALEWIDGET_H
static QString toString(double scale)
Helper function to convert a double to scale string.
double scale()
Function to read the selected scale as double.
A combobox which lets the user select map scale from predefined list and highlights nearest to curren...
QString scaleString()
Function to read the selected scale as text.
bool setScaleString(const QString &scaleTxt)
Function to set the selected scale from text.
bool showCurrentScaleButton()
void setScale(double scale)
Function to set the selected scale from double.
static double toDouble(const QString &scaleString, bool *ok=nullptr)
Helper function to convert a scale string to double.
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:105
static double toDouble(const QString &scaleString, bool *ok=nullptr)
Helper function to convert a scale string to double.
void updateScales(const QStringList &scales=QStringList())
static QString toString(double scale)
Helper function to convert a double to scale string.
A combobox which lets the user select map scale from predefined list and highlights nearest to curren...