QGIS API Documentation  2.99.0-Master (7705179)
Public Member Functions | Properties | List of all members
QgsMapUnitScaleDialog Class Reference

A dialog which allows the user to choose the minimum and maximum scale of an object in map units and millimeters. More...

#include <qgsunitselectionwidget.h>

Inheritance diagram for QgsMapUnitScaleDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsMapUnitScaleDialog (QWidget *parent=nullptr)
 Constructor for QgsMapUnitScaleDialog. More...
 
QgsMapUnitScale getMapUnitScale () const
 Returns a QgsMapUnitScale representing the settings shown in the dialog. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets the map canvas associated with the dialog. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale)
 Updates the dialog to reflect the settings from the specified QgsMapUnitScale object. More...
 

Properties

QgsMapUnitScale mapUnitScale
 

Detailed Description

A dialog which allows the user to choose the minimum and maximum scale of an object in map units and millimeters.

This dialog is designed to allow users to edit the properties of a QgsMapUnitScale object.

See also
QgsMapUnitScaleWidget
QgsUnitSelectionWidget

Definition at line 100 of file qgsunitselectionwidget.h.

Constructor & Destructor Documentation

◆ QgsMapUnitScaleDialog()

QgsMapUnitScaleDialog::QgsMapUnitScaleDialog ( QWidget *  parent = nullptr)

Constructor for QgsMapUnitScaleDialog.

Parameters
parentparent widget

Definition at line 270 of file qgsunitselectionwidget.cpp.

Member Function Documentation

◆ getMapUnitScale()

QgsMapUnitScale QgsMapUnitScaleDialog::getMapUnitScale ( ) const

Returns a QgsMapUnitScale representing the settings shown in the dialog.

See also
setMapUnitScale()

Definition at line 284 of file qgsunitselectionwidget.cpp.

◆ setMapCanvas()

void QgsMapUnitScaleDialog::setMapCanvas ( QgsMapCanvas canvas)

Sets the map canvas associated with the dialog.

This allows the dialog to retrieve the current map scale from the canvas.

Parameters
canvasmap canvas
Since
QGIS 2.12

Definition at line 294 of file qgsunitselectionwidget.cpp.

◆ setMapUnitScale()

void QgsMapUnitScaleDialog::setMapUnitScale ( const QgsMapUnitScale scale)

Updates the dialog to reflect the settings from the specified QgsMapUnitScale object.

Parameters
scalemap unit scale to show in dialog
See also
mapUnitScale()

Definition at line 289 of file qgsunitselectionwidget.cpp.

Property Documentation

◆ mapUnitScale

QgsMapUnitScale QgsMapUnitScaleDialog::mapUnitScale
readwrite

Definition at line 103 of file qgsunitselectionwidget.h.


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