qgslayoututils.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoututils.h
                             -------------------
    begin                : July 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 QGSLAYOUTUTILS_H
#define QGSLAYOUTUTILS_H
 
#include "qgis_core.h"
#include "qgslayoutitempage.h"
 
#include <QColor>
#include <QFont>
 
class QgsRenderContext;
class QgsLayout;
class QgsLayoutItemMap;
class QPainter;
class QRectF;
class QStyleOptionGraphicsItem;

class CORE_EXPORT QgsLayoutUtils
{
  public:
    static void rotate( double angle, double &x, double &y );

    static double normalizedAngle( double angle, bool allowNegative = false );

    static double snappedAngle( double angle );

    static QgsRenderContext createRenderContextForMap( QgsLayoutItemMap *map, QPainter *painter, double dpi = -1 );

    static QgsRenderContext createRenderContextForLayout( QgsLayout *layout, QPainter *painter, double dpi = -1 );

    static void relativeResizeRect( QRectF &rectToResize, const QRectF &boundsBefore, const QRectF &boundsAfter );

    static double relativePosition( double position, double beforeMin, double beforeMax, double afterMin, double afterMax );

    static QFont scaledFontPixelSize( const QFont &font );

    static double fontAscentMM( const QFont &font );

    static double fontDescentMM( const QFont &font );

    static double fontHeightMM( const QFont &font );

    static double fontHeightCharacterMM( const QFont &font, QChar character );

    static double textWidthMM( const QFont &font, const QString &text );

    static double textHeightMM( const QFont &font, const QString &text, double multiLineHeight = 1.0 );

    static void drawText( QPainter *painter, QPointF position, const QString &text, const QFont &font, const QColor &color = QColor() );

    static void drawText(
      QPainter *painter,
      const QRectF &rectangle,
      const QString &text,
      const QFont &font,
      const QColor &color = QColor(),
      Qt::AlignmentFlag halignment = Qt::AlignLeft,
      Qt::AlignmentFlag valignment = Qt::AlignTop,
      int flags = Qt::TextWordWrap
    );

    static QRectF largestRotatedRectWithinBounds( const QRectF &originalRect, const QRectF &boundsRect, double rotation );

    static QgsLayoutItemPage::Orientation decodePaperOrientation( const QString &string, bool &ok );

    Q_DECL_DEPRECATED static double scaleFactorFromItemStyle( const QStyleOptionGraphicsItem *style ) SIP_DEPRECATED;

    static double scaleFactorFromItemStyle( const QStyleOptionGraphicsItem *style, QPainter *painter );

    static QgsMapLayer *mapLayerFromString( const QString &string, QgsProject *project );

    static double calculatePrettySize( double minimumSize, double maximumSize );

    static bool itemIsAClippingSource( const QgsLayoutItem *item );

    static QVector< double > predefinedScales( const QgsLayout *layout );
 
  private:
    static constexpr double FONT_WORKAROUND_SCALE = 10;

    static double pointsToMM( double pointSize );

    static double mmToPoints( double mmSize );
 
    friend class TestQgsLayoutUtils;
};
 
#endif //QGSLAYOUTUTILS_H