QgsLayoutMeasurementConverter class
This class provides a method of converting QgsLayoutMeasurements from one unit to another.
Contents
Conversion to or from pixel units utilizes a specified dots per inch (DPI) property for the converter. Converters default to using 300 DPI.
Constructors, destructors, conversion operators
- QgsLayoutMeasurementConverter() defaulted
- Constructor for QgsLayoutMeasurementConverter.
Public functions
-
auto convert(QgsLayoutMeasurement measurement,
QgsUnitTypes::
LayoutUnit targetUnits) const -> QgsLayoutMeasurement - Converts a measurement from one unit to another.
-
auto convert(const QgsLayoutSize& size,
QgsUnitTypes::
LayoutUnit targetUnits) const -> QgsLayoutSize - Converts a layout size from one unit to another.
-
auto convert(const QgsLayoutPoint& point,
QgsUnitTypes::
LayoutUnit targetUnits) const -> QgsLayoutPoint - Converts a layout point from one unit to another.
- auto dpi() const -> double
- Returns the Dots per inch (DPI) of the measurement converter.
- void setDpi(const double dpi)
- Sets the dots per inch (dpi) for the measurement converter.
Function documentation
QgsLayoutMeasurement QgsLayoutMeasurementConverter:: convert(QgsLayoutMeasurement measurement,
QgsUnitTypes:: LayoutUnit targetUnits) const
Converts a measurement from one unit to another.
| Parameters | |
|---|---|
| measurement | measurement to convert |
| targetUnits | units to convert measurement into |
| Returns | measurement converted to target units |
QgsLayoutSize QgsLayoutMeasurementConverter:: convert(const QgsLayoutSize& size,
QgsUnitTypes:: LayoutUnit targetUnits) const
Converts a layout size from one unit to another.
| Parameters | |
|---|---|
| size | layout size to convert |
| targetUnits | units to convert size into |
| Returns | size converted to target units |
QgsLayoutPoint QgsLayoutMeasurementConverter:: convert(const QgsLayoutPoint& point,
QgsUnitTypes:: LayoutUnit targetUnits) const
Converts a layout point from one unit to another.
| Parameters | |
|---|---|
| point | layout point to convert |
| targetUnits | units to convert point into |
| Returns | point converted to target units |
double QgsLayoutMeasurementConverter:: dpi() const
Returns the Dots per inch (DPI) of the measurement converter.
This is used when converting measurements to and from pixels.
void QgsLayoutMeasurementConverter:: setDpi(const double dpi)
Sets the dots per inch (dpi) for the measurement converter.
This is used when converting measurements to and from pixels.