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 QgsLayoutNorthArrowHandler;

class CORE_EXPORT QgsLayoutItemPicture : public QgsLayoutItem
{
    Q_OBJECT
  public:
    enum ResizeMode
    {
      Zoom,            
      Stretch,         
      Clip,            
      ZoomResizeFrame, 
      FrameToImageSize 
    };

    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, Qgis::PictureFormat format = Qgis::PictureFormat::Unknown );

    QString picturePath() const;

    double pictureRotation() const { return mPictureRotation; }

    void setLinkedMap( QgsLayoutItemMap *map );

    QgsLayoutItemMap *linkedMap() const;

    NorthMode northMode() const;

    void setNorthMode( NorthMode mode );

    double northOffset() const;

    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 );

    Qgis::PictureFormat mode() const { return mMode; }

    Qgis::PictureFormat originalMode() const { return mOriginalMode; }

    void setMode( Qgis::PictureFormat mode );
 
    void finalizeRestoreFromXml() override;

    bool isMissingImage() const;

    QString evaluatedPath() const;

    QMap<QString, QgsProperty> svgDynamicParameters() const;

    void setSvgDynamicParameters( const QMap<QString, QgsProperty> &parameters );
 
  public slots:

    void setPictureRotation( double rotation );

    void setResizeMode( QgsLayoutItemPicture::ResizeMode mode );

    bool clipToItem() const;

    void setClipToItem( bool clipToItem );

    QgsLayoutItem *clippingItem() const;

    void setClippingItem( QgsLayoutItem *item );

    void refreshPicture( const QgsExpressionContext *context = nullptr );

    void recalculateSize();
 
    void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::DataDefinedProperty::AllProperties ) override;
 
  signals:
    void pictureRotationChanged( double newRotation );
 
  protected:
    void draw( QgsLayoutItemRenderContext &context ) override;
    QPainterPath framePath() const 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;

    QSizeF pictureSize();
 
    QImage mImage;
    QSvgRenderer mSVG;
    QString mSourcePath;
    Qgis::PictureFormat mMode = Qgis::PictureFormat::Unknown;
    Qgis::PictureFormat mOriginalMode = Qgis::PictureFormat::Unknown;
 
    QSize mDefaultSvgSize;

    double mPictureRotation = 0;
 
    QString mRotationMapUuid;

    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;
 
    QgsLayoutNorthArrowHandler *mNorthArrowHandler = nullptr;
 
    bool mClipToItem = false;
    QPointer< QgsLayoutItem > mClippingItem;
    QString mClippingItemUuid;

    void loadPicture( const QVariant &data );

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

    void loadRemotePicture( const QString &url );

    void loadLocalPicture( const QString &path );
 
    void loadPictureUsingCache( const QString &path );
 
    QPainterPath customFramePath() const;
 
    QgsLayoutItemPicture( const QgsLayoutItemPicture & ) = delete;
    QgsLayoutItemPicture &operator=( const QgsLayoutItemPicture & ) = delete;
 
  private slots:
 
    void updateNorthArrowRotation( double rotation );
 
    void shapeChanged();
 
    friend class QgsCompositionConverter;
    friend class TestQgsCompositionConverter;
};
 
#endif // QGSLAYOUTITEMPICTURE_H