qgslayoutsize.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutsize.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 QGSLAYOUTSIZE_H
#define QGSLAYOUTSIZE_H
 
#include "qgsconfig.h"
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QSizeF>
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsLayoutSize
{
  public:
    QgsLayoutSize( double width, double height, Qgis::LayoutUnit units = Qgis::LayoutUnit::Millimeters );

    explicit QgsLayoutSize( QSizeF size, Qgis::LayoutUnit units = Qgis::LayoutUnit::Millimeters );

    explicit QgsLayoutSize( Qgis::LayoutUnit units = Qgis::LayoutUnit::Millimeters );

    void setSize( const double width, const double height )
    {
      mWidth = width;
      mHeight = height;
#ifdef QGISDEBUG
      Q_ASSERT_X( !std::isnan( width ) && !std::isnan( height ), "QgsLayoutSize", "Layout size with NaN dimensions created" );
#endif
    }

    double width() const { return mWidth; }

    void setWidth( const double width )
    {
      mWidth = width;
#ifdef QGISDEBUG
      Q_ASSERT_X( !std::isnan( width ), "QgsLayoutSize", "Layout size with NaN dimensions created" );
#endif
    }

    double height() const { return mHeight; }

    void setHeight( const double height )
    {
      mHeight = height;
#ifdef QGISDEBUG
      Q_ASSERT_X( !std::isnan( height ), "QgsLayoutSize", "Layout size with NaN dimensions created" );
#endif
    }

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

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

    bool isEmpty() const;

    QSizeF toQSizeF() const;

    QString encodeSize() const;

    static QgsLayoutSize decodeSize( const QString &string );
 
    bool operator==( const QgsLayoutSize &other ) const;
    bool operator!=( const QgsLayoutSize &other ) const;

    QgsLayoutSize operator*( double v ) const;

    QgsLayoutSize operator*=( double v );

    QgsLayoutSize operator/( double v ) const;

    QgsLayoutSize operator/=( double v );
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsLayoutSize: %1 x %2 %3 >"_s.arg( sipCpp->width() ).arg( sipCpp->height() ).arg( QgsUnitTypes::toAbbreviatedString( sipCpp->units() ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
 
    double mWidth
    = 0.0;
    double mHeight = 0.0;
    Qgis::LayoutUnit mUnits = Qgis::LayoutUnit::Millimeters;
};
 
#endif // QGSLAYOUTSIZE_H