QGIS API Documentation
3.0.2-Girona (307d082)
|
A widget displaying a combobox allowing the user to choose between various display units, such as millimeters or map unit. More...
#include <qgsunitselectionwidget.h>
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... | |
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.
Definition at line 158 of file qgsunitselectionwidget.h.
QgsUnitSelectionWidget::QgsUnitSelectionWidget | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsUnitSelectionWidget.
parent | parent widget |
Definition at line 125 of file qgsunitselectionwidget.cpp.
|
signal |
|
inline |
Returns the map unit scale.
Definition at line 208 of file qgsunitselectionwidget.h.
|
inline |
Get the selected unit index.
Definition at line 185 of file qgsunitselectionwidget.h.
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.
canvas | map canvas |
Definition at line 218 of file qgsunitselectionwidget.cpp.
|
inline |
Sets the map unit scale.
Definition at line 211 of file qgsunitselectionwidget.h.
void QgsUnitSelectionWidget::setUnit | ( | int | unitIndex | ) |
Sets the selected unit index.
unitIndex | index of unit to set as current |
Definition at line 205 of file qgsunitselectionwidget.cpp.
void QgsUnitSelectionWidget::setUnit | ( | QgsUnitTypes::RenderUnit | unit | ) |
Sets the selected unit.
unit | predefined unit to set as current |
Definition at line 212 of file qgsunitselectionwidget.cpp.
void QgsUnitSelectionWidget::setUnits | ( | const QStringList & | units, |
int | mapUnitIdx | ||
) |
Sets the units which the user can choose from in the combobox.
units | list of strings for custom units to display in the widget |
mapUnitIdx | specifies which entry corresponds to the map units, or -1 if none |
Definition at line 143 of file qgsunitselectionwidget.cpp.
void QgsUnitSelectionWidget::setUnits | ( | const QgsUnitTypes::RenderUnitList & | units | ) |
Sets the units which the user can choose from in the combobox.
Clears any existing units.
units | list of valid units |
Definition at line 151 of file qgsunitselectionwidget.cpp.
QgsUnitTypes::RenderUnit QgsUnitSelectionWidget::unit | ( | ) | const |
Returns the current predefined selected unit (if applicable).
Definition at line 191 of file qgsunitselectionwidget.cpp.