QGIS API Documentation  2.99.0-Master (314842d)
Public Slots | Signals | Public Member Functions | List of all members
QgsScaleRangeWidget Class Reference

#include <qgsscalerangewidget.h>

Inheritance diagram for QgsScaleRangeWidget:
Inheritance graph
[legend]

Public Slots

void setMaximumScale (double scale)
 Set the maximum scale. More...
 
void setMinimumScale (double scale)
 Set the minimum scale. More...
 
void setScaleRange (double min, double max)
 

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)
 
double maximumScale ()
 return the maximum scale More...
 
double maximumScaleDenom ()
 Returns the maximum scale denominator ( = 1 / minimum scale ) In case of minimum scale = 0 it will also return 0. More...
 
double minimumScale ()
 return the minimum scale More...
 
double minimumScaleDenom ()
 Returns the minimum scale denominator ( = 1 / maximum scale ) In case of maximum scale = 0 it will also return 0. More...
 
void reloadProjectScales ()
 call to reload the project scales and apply them to the 2 scales combo boxes More...
 
void setMapCanvas (QgsMapCanvas *mapCanvas)
 set the map canvas which will be used for the current scale buttons More...
 

Detailed Description

Definition at line 29 of file qgsscalerangewidget.h.

Constructor & Destructor Documentation

◆ QgsScaleRangeWidget()

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

Definition at line 21 of file qgsscalerangewidget.cpp.

Member Function Documentation

◆ maximumScale()

double QgsScaleRangeWidget::maximumScale ( )

return the maximum scale

Definition at line 106 of file qgsscalerangewidget.cpp.

◆ maximumScaleDenom()

double QgsScaleRangeWidget::maximumScaleDenom ( )

Returns the maximum scale denominator ( = 1 / minimum scale ) In case of minimum scale = 0 it will also return 0.

Definition at line 120 of file qgsscalerangewidget.cpp.

◆ minimumScale()

double QgsScaleRangeWidget::minimumScale ( )

return the minimum scale

Definition at line 94 of file qgsscalerangewidget.cpp.

◆ minimumScaleDenom()

double QgsScaleRangeWidget::minimumScaleDenom ( )

Returns the minimum scale denominator ( = 1 / maximum scale ) In case of maximum scale = 0 it will also return 0.

Definition at line 111 of file qgsscalerangewidget.cpp.

◆ rangeChanged

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

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

Parameters
minminimum scale
maxmaximum scale
Note
added in QGIS 2.16

◆ reloadProjectScales()

void QgsScaleRangeWidget::reloadProjectScales ( )

call to reload the project scales and apply them to the 2 scales combo boxes

Definition at line 70 of file qgsscalerangewidget.cpp.

◆ setMapCanvas()

void QgsScaleRangeWidget::setMapCanvas ( QgsMapCanvas mapCanvas)

set the map canvas which will be used for the current scale buttons

setMapCanvas set the map canvas which will be used for the current scale buttons if not set, the buttons are hidden.

Definition at line 81 of file qgsscalerangewidget.cpp.

◆ setMaximumScale

void QgsScaleRangeWidget::setMaximumScale ( double  scale)
slot

Set the maximum scale.

Infinite will be handled equally to 0 internally.

Definition at line 99 of file qgsscalerangewidget.cpp.

◆ setMinimumScale

void QgsScaleRangeWidget::setMinimumScale ( double  scale)
slot

Set the minimum scale.

Infinite will be handled equally to 0 internally.

Definition at line 87 of file qgsscalerangewidget.cpp.

◆ setScaleRange

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

Definition at line 129 of file qgsscalerangewidget.cpp.


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