qgsannotationpictureitem.h

Go to the documentation of this file.

/***************************************************************************
    qgsannotationpictureitem.h
    ----------------
    begin                : July 2024
    copyright            : (C) 2024 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 QGSANNOTATIONPICTUREITEM_H
#define QGSANNOTATIONPICTUREITEM_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsannotationrectitem.h"

class CORE_EXPORT QgsAnnotationPictureItem : public QgsAnnotationRectItem
{
  public:

    QgsAnnotationPictureItem( Qgis::PictureFormat format, const QString &path, const QgsRectangle &bounds );
    ~QgsAnnotationPictureItem() override;
 
    QString type() const override;
    bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    QgsAnnotationPictureItem *clone() const override SIP_FACTORY;

    static QgsAnnotationPictureItem *create() SIP_FACTORY;

    QString path() const { return mPath; }

    Qgis::PictureFormat format() const { return mFormat; }

    void setPath( Qgis::PictureFormat format, const QString &path );

    bool lockAspectRatio() const;

    void setLockAspectRatio( bool locked );
 
  protected:
 
    void renderInBounds( QgsRenderContext &context, const QRectF &painterBounds, QgsFeedback *feedback ) override;
 
  private:
 
    QString mPath;
    Qgis::PictureFormat mFormat = Qgis::PictureFormat::Unknown;
    bool mLockAspectRatio = true;
 
#ifdef SIP_RUN
    QgsAnnotationPictureItem( const QgsAnnotationPictureItem &other );
#endif
 
};
#endif // QGSANNOTATIONPICTUREITEM_H