QGIS API Documentation  2.99.0-Master (6a61179)
Signals | Public Member Functions | List of all members
QgsUnitSelectionWidget Class Reference

A widget displaying a combobox allowing the user to choose between various display units, such as millimeters or map unit. More...

#include <qgsunitselectionwidget.h>

Inheritance diagram for QgsUnitSelectionWidget:
Inheritance graph
[legend]

Signals

void changed ()
 

Public Member Functions

 QgsUnitSelectionWidget (QWidget *parent=nullptr)
 Constructor for QgsUnitSelectionWidget. More...
 
QgsMapUnitScale getMapUnitScale () const
 Returns the map unit scale. More...
 
int getUnit () const
 Get the selected unit index. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets the map canvas associated with the widget. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale. More...
 
void setUnit (int unitIndex)
 Sets the selected unit index. More...
 
void setUnit (QgsUnitTypes::RenderUnit unit)
 Sets the selected unit. More...
 
void setUnits (const QStringList &units, int mapUnitIdx)
 Sets the units which the user can choose from in the combobox. More...
 
void setUnits (const QgsUnitTypes::RenderUnitList &units)
 Sets the units which the user can choose from in the combobox. More...
 
QgsUnitTypes::RenderUnit unit () const
 Returns the current predefined selected unit (if applicable). More...
 

Detailed Description

A widget displaying a combobox allowing the user to choose between various display units, such as millimeters or map unit.

If the user chooses map units, a button appears allowing adjustment of minimum and maximum scaling.

See also
QgsMapUnitScaleWidget
QgsMapUnitScaleDialog

Definition at line 144 of file qgsunitselectionwidget.h.

Constructor & Destructor Documentation

§ QgsUnitSelectionWidget()

QgsUnitSelectionWidget::QgsUnitSelectionWidget ( QWidget *  parent = nullptr)

Constructor for QgsUnitSelectionWidget.

Parameters
parentparent widget

Definition at line 126 of file qgsunitselectionwidget.cpp.

Member Function Documentation

§ changed

void QgsUnitSelectionWidget::changed ( )
signal

§ getMapUnitScale()

QgsMapUnitScale QgsUnitSelectionWidget::getMapUnitScale ( ) const
inline

Returns the map unit scale.

Definition at line 188 of file qgsunitselectionwidget.h.

§ getUnit()

int QgsUnitSelectionWidget::getUnit ( ) const
inline

Get the selected unit index.

Definition at line 168 of file qgsunitselectionwidget.h.

§ setMapCanvas()

void QgsUnitSelectionWidget::setMapCanvas ( QgsMapCanvas canvas)

Sets the map canvas associated with the widget.

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

Parameters
canvasmap canvas
Note
added in QGIS 2.12

Definition at line 211 of file qgsunitselectionwidget.cpp.

§ setMapUnitScale()

void QgsUnitSelectionWidget::setMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale.

Definition at line 191 of file qgsunitselectionwidget.h.

§ setUnit() [1/2]

void QgsUnitSelectionWidget::setUnit ( int  unitIndex)

Sets the selected unit index.

Parameters
unitIndexindex of unit to set as current
Note
available in Python bindings as setUnitIndex

Definition at line 198 of file qgsunitselectionwidget.cpp.

§ setUnit() [2/2]

void QgsUnitSelectionWidget::setUnit ( QgsUnitTypes::RenderUnit  unit)

Sets the selected unit.

Parameters
unitpredefined unit to set as current

Definition at line 205 of file qgsunitselectionwidget.cpp.

§ setUnits() [1/2]

void QgsUnitSelectionWidget::setUnits ( const QStringList &  units,
int  mapUnitIdx 
)

Sets the units which the user can choose from in the combobox.

Parameters
unitslist of strings for custom units to display in the widget
mapUnitIdxspecifies which entry corresponds to the map units, or -1 if none

Definition at line 144 of file qgsunitselectionwidget.cpp.

§ setUnits() [2/2]

void QgsUnitSelectionWidget::setUnits ( const QgsUnitTypes::RenderUnitList units)

Sets the units which the user can choose from in the combobox.

Clears any existing units.

Parameters
unitslist of valid units
Note
added in QGIS 2.9

Definition at line 152 of file qgsunitselectionwidget.cpp.

§ unit()

QgsUnitTypes::RenderUnit QgsUnitSelectionWidget::unit ( ) const

Returns the current predefined selected unit (if applicable).

Returns
selected output unit, or QgsUnitTypes::RenderUnknownUnit if the widget was populated with custom unit types
Note
added in QGIS 2.9

Definition at line 184 of file qgsunitselectionwidget.cpp.


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