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.h"
#include "qgis_core.h"
#include "qgsunittypes.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsLayoutMeasurement
{
  public:

    explicit QgsLayoutMeasurement( double length, Qgis::LayoutUnit units = Qgis::LayoutUnit::Millimeters );

    double length() const { return mLength; }

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

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

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

    QString encodeMeasurement() const;

    static QgsLayoutMeasurement decodeMeasurement( const QString &string );
 
    bool operator==( QgsLayoutMeasurement other ) const;
    bool operator!=( QgsLayoutMeasurement other ) const;

    QgsLayoutMeasurement operator+( double v ) const;

    QgsLayoutMeasurement operator+=( double v );

    QgsLayoutMeasurement operator-( double v ) const;

    QgsLayoutMeasurement operator-=( double v );

    QgsLayoutMeasurement operator*( double v ) const;

    QgsLayoutMeasurement operator*=( double v );

    QgsLayoutMeasurement operator/( double v ) const;

    QgsLayoutMeasurement operator/=( double v );
 
#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsLayoutMeasurement: %1 %2 >"_s.arg( sipCpp->length() ).arg( QgsUnitTypes::toAbbreviatedString( sipCpp->units() ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
#endif
 
  private:
 
    double mLength = 0.0;
    Qgis::LayoutUnit mUnits = Qgis::LayoutUnit::Millimeters;
 
};
 
#endif // QGSLAYOUTMEASUREMENT_H