qgslayoutitempicture.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutitempicture.h
                         -------------------
begin                : October 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 QGSLAYOUTITEMPICTURE_H
#define QGSLAYOUTITEMPICTURE_H

#include "qgis_core.h"
#include "qgslayoutitem.h"
#include <QFile>
#include <QImage>
#include <QSvgRenderer>

class QgsLayoutItemMap;
class QgsExpression;

class CORE_EXPORT QgsLayoutItemPicture: public QgsLayoutItem
{
    Q_OBJECT
  public:

    enum ResizeMode
    {
      Zoom, 
      Stretch, 
      Clip, 
      ZoomResizeFrame, 
      FrameToImageSize 
    };

    enum Format
    {
      FormatSVG, 
      FormatRaster, 
      FormatUnknown, 
    };

    enum NorthMode
    {
      GridNorth = 0, 
      TrueNorth, 
    };

    QgsLayoutItemPicture( QgsLayout *layout );

    int type() const override;
    QIcon icon() const override;

    static QgsLayoutItemPicture *create( QgsLayout *layout ) SIP_FACTORY;


    void setPicturePath( const QString &path );

    QString picturePath() const;

    double pictureRotation() const { return mPictureRotation; }

    void setLinkedMap( QgsLayoutItemMap *map );

    QgsLayoutItemMap *linkedMap() const;

    NorthMode northMode() const { return mNorthMode; }

    void setNorthMode( NorthMode mode );

    double northOffset() const { return mNorthOffset; }

    void setNorthOffset( double offset );

    ResizeMode resizeMode() const { return mResizeMode; }

    void setPictureAnchor( QgsLayoutItem::ReferencePoint anchor );

    QgsLayoutItem::ReferencePoint pictureAnchor() const { return mPictureAnchor; }

    QColor svgFillColor() const { return mSvgFillColor; }

    void setSvgFillColor( const QColor &color );

    QColor svgStrokeColor() const { return mSvgStrokeColor; }

    void setSvgStrokeColor( const QColor &color );

    double svgStrokeWidth() const { return mSvgStrokeWidth; }

    void setSvgStrokeWidth( double width );

    Format mode() const { return mMode; }

    void finalizeRestoreFromXml() override;

    bool isMissingImage() const;

    QString evaluatedPath() const;

  public slots:

    void setPictureRotation( double rotation );

    void setResizeMode( QgsLayoutItemPicture::ResizeMode mode );

    void refreshPicture( const QgsExpressionContext *context = nullptr );

    void recalculateSize();

    void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::AllProperties ) override;

  signals:
    void pictureRotationChanged( double newRotation );

  protected:

    void draw( QgsLayoutItemRenderContext &context ) override;
    QSizeF applyItemSizeConstraint( QSizeF targetSize ) override;
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;

  private:

    QgsLayoutItemPicture() = delete;

    QRectF boundedSVGRect( double deviceWidth, double deviceHeight );
    QRectF boundedImageRect( double deviceWidth, double deviceHeight );

    QSizeF pictureSize();

    QImage mImage;
    QSvgRenderer mSVG;
    QString mSourcePath;
    Format mMode = FormatUnknown;

    QSize mDefaultSvgSize;

    double mPictureRotation = 0;

    QString mRotationMapUuid;
    QPointer< QgsLayoutItemMap > mRotationMap;

    NorthMode mNorthMode = GridNorth;
    double mNorthOffset = 0.0;

    double mPictureWidth = 0.0;
    double mPictureHeight = 0.0;

    ResizeMode mResizeMode = QgsLayoutItemPicture::Zoom;
    QgsLayoutItem::ReferencePoint mPictureAnchor = UpperLeft;

    QColor mSvgFillColor = QColor( 255, 255, 255 );
    QColor mSvgStrokeColor = QColor( 0, 0, 0 );
    double mSvgStrokeWidth = 0.2;

    bool mHasExpressionError = false;
    bool mLoaded = false;
    bool mLoadingSvg = false;
    bool mIsMissingImage = false;
    QString mEvaluatedPath;

    void loadPicture( const QString &path );

    QRect clippedImageRect( double &boundRectWidthMM, double &boundRectHeightMM, QSize imageRectPixels );

    void loadRemotePicture( const QString &url );

    void loadLocalPicture( const QString &path );

    void disconnectMap( QgsLayoutItemMap *map );

  private slots:

    void updateMapRotation();

    void shapeChanged();

    friend class QgsCompositionConverter;
    friend class TestQgsCompositionConverter;

};

#endif // QGSLAYOUTITEMPICTURE_H