qgslayoutmeasurement.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutmeasurement.h
                         --------------------
    begin                : June 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSLAYOUTMEASUREMENT_H
#define QGSLAYOUTMEASUREMENT_H

#include "qgis_core.h"

#include "qgsunittypes.h"

class CORE_EXPORT QgsLayoutMeasurement
{
  public:

    explicit QgsLayoutMeasurement( const double length, const QgsUnitTypes::LayoutUnit units = QgsUnitTypes::LayoutMillimeters );

    double length() const { return mLength; }

    void setLength( const double length ) { mLength = length; }

    QgsUnitTypes::LayoutUnit units() const { return mUnits; }

    void setUnits( const QgsUnitTypes::LayoutUnit units ) { mUnits = units; }

    QString encodeMeasurement() const;

    static QgsLayoutMeasurement decodeMeasurement( const QString &string );

    bool operator==( const QgsLayoutMeasurement &other ) const;
    bool operator!=( const QgsLayoutMeasurement &other ) const;

    QgsLayoutMeasurement operator+( const double v ) const;

    QgsLayoutMeasurement operator+=( const double v );

    QgsLayoutMeasurement operator-( const double v ) const;

    QgsLayoutMeasurement operator-=( const double v );

    QgsLayoutMeasurement operator*( const double v ) const;

    QgsLayoutMeasurement operator*=( const double v );

    QgsLayoutMeasurement operator/( const double v ) const;

    QgsLayoutMeasurement operator/=( const double v );

  private:

    double mLength = 0.0;
    QgsUnitTypes::LayoutUnit mUnits = QgsUnitTypes::LayoutMillimeters;

};

#endif // QGSLAYOUTMEASUREMENT_H