qgscomposerpicture.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposerpicture.h
                             -------------------
    begin                : September 2005
    copyright            : (C) 2005 by Radim Blazek
    email                : radim.blazek@gmail.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 QGSCOMPOSERPICTURE_H
#define QGSCOMPOSERPICTURE_H

#include "qgscomposeritem.h"
#include <QFile>
#include <QImage>
#include <QSvgRenderer>

class QgsComposerMap;
class QgsExpression;

class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
{
    Q_OBJECT
  public:

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

    enum Mode
    {
      SVG,
      RASTER,
      Unknown
    };

    enum NorthMode
    {
      GridNorth = 0, 
      TrueNorth, 
    };

    QgsComposerPicture( QgsComposition *composition );
    ~QgsComposerPicture();

    virtual int type() const override { return ComposerPicture; }

    void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override;

    Q_DECL_DEPRECATED void setPictureFile( const QString& path );

    Q_DECL_DEPRECATED QString pictureFile() const;

    void setPicturePath( const QString& path );

    QString picturePath() const;

    void setSceneRect( const QRectF& rectangle ) override;

    bool writeXML( QDomElement& elem, QDomDocument & doc ) const override;

    bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) override;

    Q_DECL_DEPRECATED double rotation() const { return mPictureRotation; }

    double pictureRotation() const { return mPictureRotation; }

    void setRotationMap( int composerMapId );

    int rotationMap() const;

    bool useRotationMap() const { return mRotationMap; }

    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( QgsComposerItem::ItemPositionMode anchor );

    ItemPositionMode pictureAnchor() const { return mPictureAnchor; }

    QColor svgFillColor() const { return mSvgFillColor; }

    void setSvgFillColor( const QColor& color );

    QColor svgBorderColor() const { return mSvgBorderColor; }

    void setSvgBorderColor( const QColor& color );

    double svgBorderWidth() const { return mSvgBorderWidth; }

    void setSvgBorderWidth( double width );

    Q_DECL_DEPRECATED bool usePictureExpression() const;

    Q_DECL_DEPRECATED QString pictureExpression() const;

    Q_DECL_DEPRECATED bool imageSizeConsideringRotation( double& width, double& height ) const;

    Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect( double& x, double& y, double width, double height ) const;

    Q_DECL_DEPRECATED void sizeChangedByRotation( double& width, double& height );

    Mode mode() const { return mMode; }

  public slots:
    virtual void setRotation( double r ) override;

    virtual void setPictureRotation( double r );

    virtual void setResizeMode( ResizeMode mode );

    virtual void setUsePictureExpression( bool useExpression );

    virtual void setPictureExpression( const QString& expression );

    void refreshPicture( const QgsExpressionContext* context = nullptr );

    Q_DECL_DEPRECATED void updatePictureExpression() {}

    void recalculateSize();

    virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext *context = nullptr ) override;

  signals:
    void pictureRotationChanged( double newRotation );

  private:

    //default constructor is forbidden
    QgsComposerPicture();
    QRectF boundedSVGRect( double deviceWidth, double deviceHeight );
    QRectF boundedImageRect( double deviceWidth, double deviceHeight );

    QSizeF pictureSize();

    QImage mImage;
    QSvgRenderer mSVG;
    QString mSourcePath;
    Mode mMode;

    QSize mDefaultSvgSize;

    double mPictureRotation;
    const QgsComposerMap* mRotationMap;

    NorthMode mNorthMode;
    double mNorthOffset;

    double mPictureWidth;
    double mPictureHeight;

    ResizeMode mResizeMode;
    QgsComposerItem::ItemPositionMode mPictureAnchor;

    QColor mSvgFillColor;
    QColor mSvgBorderColor;
    double mSvgBorderWidth;

    bool mHasExpressionError;
    bool mLoaded;
    bool mLoadingSvg;

    void loadPicture( const QString &path );

    void init();

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

    void loadRemotePicture( const QString &url );

    void loadLocalPicture( const QString &path );

  private slots:

    void remotePictureLoaded();

    void updateMapRotation();
};

#endif