/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgslayoutmeasurement.h                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/





class QgsLayoutMeasurement
{
%Docstring
 This class provides a method of storing measurements for use in QGIS layouts
 using a variety of different measurement units.
.. seealso:: QgsLayoutMeasurementConverter
.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgslayoutmeasurement.h"
%End
  public:

    explicit QgsLayoutMeasurement( const double length, const QgsUnitTypes::LayoutUnit units = QgsUnitTypes::LayoutMillimeters );
%Docstring
 Constructor for QgsLayoutMeasurement.
 \param length measurement length
 \param units measurement units
%End

    double length() const;
%Docstring
 Returns the length of the measurement.
.. seealso:: setLength()
 :rtype: float
%End

    void setLength( const double length );
%Docstring
 Sets the ``length`` of the measurement.
.. seealso:: length()
%End

    QgsUnitTypes::LayoutUnit units() const;
%Docstring
 Returns the units for the measurement.
.. seealso:: setUnits()
 :rtype: QgsUnitTypes.LayoutUnit
%End

    void setUnits( const QgsUnitTypes::LayoutUnit units );
%Docstring
 Sets the ``units`` for the measurement. Does not alter the stored length,
 ie. no length conversion is done.
.. seealso:: units()
%End

    QString encodeMeasurement() const;
%Docstring
 Encodes the layout measurement to a string
.. seealso:: decodeMeasurement()
 :rtype: str
%End

    static QgsLayoutMeasurement decodeMeasurement( const QString &string );
%Docstring
 Decodes a measurement from a ``string``.
.. seealso:: encodeMeasurement()
 :rtype: QgsLayoutMeasurement
%End

    bool operator==( const QgsLayoutMeasurement &other ) const;
    bool operator!=( const QgsLayoutMeasurement &other ) const;
%Docstring
 :rtype: bool
%End

    QgsLayoutMeasurement operator+( const double v ) const;
%Docstring
 Adds a scalar value to the measurement.
 :rtype: QgsLayoutMeasurement
%End

    QgsLayoutMeasurement operator+=( const double v );
%Docstring
 Adds a scalar value to the measurement.
 :rtype: QgsLayoutMeasurement
%End

    QgsLayoutMeasurement operator-( const double v ) const;
%Docstring
 Subtracts a scalar value from the measurement.
 :rtype: QgsLayoutMeasurement
%End

    QgsLayoutMeasurement operator-=( const double v );
%Docstring
 Subtracts a scalar value from the measurement.
 :rtype: QgsLayoutMeasurement
%End

    QgsLayoutMeasurement operator*( const double v ) const;
%Docstring
 Multiplies the measurement by a scalar value.
 :rtype: QgsLayoutMeasurement
%End

    QgsLayoutMeasurement operator*=( const double v );
%Docstring
 Multiplies the measurement by a scalar value.
 :rtype: QgsLayoutMeasurement
%End

    QgsLayoutMeasurement operator/( const double v ) const;
%Docstring
 Divides the measurement by a scalar value.
 :rtype: QgsLayoutMeasurement
%End

    QgsLayoutMeasurement operator/=( const double v );
%Docstring
 Divides the measurement by a scalar value.
 :rtype: QgsLayoutMeasurement
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgslayoutmeasurement.h                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/