QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Slots | Signals | Public Member Functions | Properties | List of all members
QgsScaleRangeWidget Class Reference

A widget allowing entry of a range of map scales, e.g. More...

#include <qgsscalerangewidget.h>

Inheritance diagram for QgsScaleRangeWidget:
Inheritance graph
[legend]

Public Slots

void setMaximumScale (double scale)
 Set the maximum scale (i.e. More...
 
void setMinimumScale (double scale)
 Set the minimum scale (i.e. More...
 
void setScaleRange (double min, double max)
 Sets the scale range, from min scale (i.e. More...
 

Signals

void rangeChanged (double min, double max)
 Emitted when the scale range set in the widget is changed. More...
 

Public Member Functions

 QgsScaleRangeWidget (QWidget *parent=nullptr)
 Constructor for QgsScaleRangeWidget. More...
 
double maximumScale () const
 Returns the selected maximum scale (i.e. More...
 
double minimumScale () const
 Returns the selected minimum scale (i.e. More...
 
void reloadProjectScales ()
 Call to reload the preset scales from the current project and apply them to the 2 scales combo boxes. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets the map canvas which will be used for the current scale buttons. More...
 

Properties

double maximumScale
 
double minimumScale
 

Detailed Description

A widget allowing entry of a range of map scales, e.g.

minimum scale and maximum scale.

Definition at line 32 of file qgsscalerangewidget.h.

Constructor & Destructor Documentation

◆ QgsScaleRangeWidget()

QgsScaleRangeWidget::QgsScaleRangeWidget ( QWidget *  parent = nullptr)
explicit

Constructor for QgsScaleRangeWidget.

Definition at line 23 of file qgsscalerangewidget.cpp.

Member Function Documentation

◆ maximumScale()

double QgsScaleRangeWidget::maximumScale ( ) const

Returns the selected maximum scale (i.e.

most "zoomed in" scale), or 0 if maximum scale is not set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also
minimumScale()
setMaximumScale()

Definition at line 109 of file qgsscalerangewidget.cpp.

◆ minimumScale()

double QgsScaleRangeWidget::minimumScale ( ) const

Returns the selected minimum scale (i.e.

most "zoomed out" scale), or 0 if minimum scale is not set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also
maximumScale()
setMinimumScale()

Definition at line 99 of file qgsscalerangewidget.cpp.

◆ rangeChanged

void QgsScaleRangeWidget::rangeChanged ( double  min,
double  max 
)
signal

Emitted when the scale range set in the widget is changed.

The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map, or 0 to indicate not set.

Since
QGIS 2.16

◆ reloadProjectScales()

void QgsScaleRangeWidget::reloadProjectScales ( )

Call to reload the preset scales from the current project and apply them to the 2 scales combo boxes.

Definition at line 73 of file qgsscalerangewidget.cpp.

◆ setMapCanvas()

void QgsScaleRangeWidget::setMapCanvas ( QgsMapCanvas canvas)

Sets the map canvas which will be used for the current scale buttons.

If not set, the buttons are hidden.

Definition at line 88 of file qgsscalerangewidget.cpp.

◆ setMaximumScale

void QgsScaleRangeWidget::setMaximumScale ( double  scale)
slot

Set the maximum scale (i.e.

most "zoomed in" scale), or 0 to indicate the minimum is not set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also
maximumScale()
setMinimumScale()
setScaleRange()
Warning
Calling setMinimumScale() places a restriction on the acceptable maximum scale for the widget, and will alter any previously set maximum scale to pass this constraint. Always call setMinimumScale() before setMaximumScale() when restoring a scale range in the widget, or use the convenience method setScaleRange() instead.

Definition at line 104 of file qgsscalerangewidget.cpp.

◆ setMinimumScale

void QgsScaleRangeWidget::setMinimumScale ( double  scale)
slot

Set the minimum scale (i.e.

most "zoomed out" scale), or 0 to indicate the minimum is not set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also
minimumScale()
setMaximumScale()
setScaleRange()
Warning
Calling setMinimumScale() places a restriction on the acceptable maximum scale for the widget, and will alter any previously set maximum scale to pass this constraint. Always call setMinimumScale() before setMaximumScale() when restoring a scale range in the widget, or use the convenience method setScaleRange() instead.

Definition at line 94 of file qgsscalerangewidget.cpp.

◆ setScaleRange

void QgsScaleRangeWidget::setScaleRange ( double  min,
double  max 
)
slot

Sets the scale range, from min scale (i.e.

most "zoomed out" scale) to max scale (most "zoomed in" scale). The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map, or 0 to indicate not set.

See also
setMinimumScale()
setMaximumScale()

Definition at line 114 of file qgsscalerangewidget.cpp.

Property Documentation

◆ maximumScale

double QgsScaleRangeWidget::maximumScale
readwrite

Definition at line 32 of file qgsscalerangewidget.h.

◆ minimumScale

double QgsScaleRangeWidget::minimumScale
readwrite

Definition at line 32 of file qgsscalerangewidget.h.


The documentation for this class was generated from the following files: