QgsScaleRangeWidget class

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

Reference

minimum scale and maximum scale.

Constructors, destructors, conversion operators

QgsScaleRangeWidget(QWidget* parent = nullptr) explicit: Constructor for QgsScaleRangeWidget.

Public functions

auto maximumScale() const -> double: Returns the selected maximum scale (i.e.
auto minimumScale() const -> double: Returns the selected minimum scale (i.e.
void reloadProjectScales(): Call to reload the preset scales from the current project and apply them to the 2 scales combo boxes.
void setMapCanvas(QgsMapCanvas* canvas): Sets the map canvas which will be used for the current scale buttons.

Signals

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

Public slots

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

Function documentation

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.

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.

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.

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.

void QgsScaleRangeWidget::setMaximumScale(double scale) public 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.

void QgsScaleRangeWidget::setMinimumScale(double scale) public 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.

void QgsScaleRangeWidget::setScaleRange(double min, double max) public 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.