QGIS API Documentation 3.39.0-Master (93ce9bf5c90)
|
A custom combo box for selecting units for layout settings. More...
#include <qgslayoutunitscombobox.h>
Signals | |
void | changed (int unit) |
Emitted when the unit is changed. | |
void | unitChanged (Qgis::LayoutUnit unit) |
Emitted when the unit is changed. | |
Public Member Functions | |
QgsLayoutUnitsComboBox (QWidget *parent=nullptr) | |
Constructor for QgsLayoutUnitsComboBox. | |
QgsLayoutMeasurementConverter * | converter () const |
Returns the converter used when automatically converting units for linked widgets. | |
void | linkToWidget (QDoubleSpinBox *widget) |
Registers a spin box widget as linked with the combo box. | |
void | setConverter (QgsLayoutMeasurementConverter *converter) |
Sets a converter to use when automatically converting units for linked widgets. | |
void | setUnit (Qgis::LayoutUnit unit) |
Sets the unit currently selected in the combo box. | |
Qgis::LayoutUnit | unit () const |
Returns the unit currently selected in the combo box. | |
Properties | |
Qgis::LayoutUnit | unit |
A custom combo box for selecting units for layout settings.
Definition at line 32 of file qgslayoutunitscombobox.h.
QgsLayoutUnitsComboBox::QgsLayoutUnitsComboBox | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsLayoutUnitsComboBox.
Definition at line 21 of file qgslayoutunitscombobox.cpp.
|
signal |
Emitted when the unit is changed.
QgsLayoutMeasurementConverter * QgsLayoutUnitsComboBox::converter | ( | ) | const |
Returns the converter used when automatically converting units for linked widgets.
Definition at line 75 of file qgslayoutunitscombobox.cpp.
void QgsLayoutUnitsComboBox::linkToWidget | ( | QDoubleSpinBox * | widget | ) |
Registers a spin box widget as linked with the combo box.
Registered spin boxes will automatically be upodated whenever the unit is changed. I.e. a spin box with a value of 100 will be set to 1 when the unit is changed from centimeters to meters.
A measurement converter() must be set in order for the automatic unit conversion to occur.
Definition at line 53 of file qgslayoutunitscombobox.cpp.
void QgsLayoutUnitsComboBox::setConverter | ( | QgsLayoutMeasurementConverter * | converter | ) |
Sets a converter to use when automatically converting units for linked widgets.
The ownership of converter is not transferred, and converter must exist for the life of the combo box.
Definition at line 80 of file qgslayoutunitscombobox.cpp.
void QgsLayoutUnitsComboBox::setUnit | ( | Qgis::LayoutUnit | unit | ) |
Sets the unit currently selected in the combo box.
Definition at line 48 of file qgslayoutunitscombobox.cpp.
Qgis::LayoutUnit QgsLayoutUnitsComboBox::unit | ( | ) | const |
Returns the unit currently selected in the combo box.
Definition at line 43 of file qgslayoutunitscombobox.cpp.
|
signal |
Emitted when the unit is changed.
|
readwrite |
Definition at line 35 of file qgslayoutunitscombobox.h.