qgsannotationrectitem.h

Go to the documentation of this file.

/***************************************************************************
    qgsannotationrectitem.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 QGSANNOTATIONRECTITEM_H
#define QGSANNOTATIONRECTITEM_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsannotationitem.h"

class CORE_EXPORT QgsAnnotationRectItem : public QgsAnnotationItem
{
  public:
    QgsAnnotationRectItem( const QgsRectangle &bounds );
    ~QgsAnnotationRectItem() override;
 
    Qgis::AnnotationItemFlags flags() const override;
    void render( QgsRenderContext &context, QgsFeedback *feedback ) override;
    QList< QgsAnnotationItemNode > nodesV2( const QgsAnnotationItemEditContext &context ) const override;
    Qgis::AnnotationItemEditOperationResult applyEditV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context ) override;
    QgsAnnotationItemEditOperationTransientResults *transientEditResultsV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context ) override SIP_FACTORY;
    QgsRectangle boundingBox() const override;
    QgsRectangle boundingBox( QgsRenderContext &context ) const override;

    QgsRectangle bounds() const { return mBounds; }

    void setBounds( const QgsRectangle &bounds );

    Qgis::AnnotationPlacementMode placementMode() const;

    void setPlacementMode( Qgis::AnnotationPlacementMode mode );

    QSizeF fixedSize() const;

    void setFixedSize( const QSizeF &size );

    Qgis::RenderUnit fixedSizeUnit() const;

    void setFixedSizeUnit( Qgis::RenderUnit unit );

    bool backgroundEnabled() const { return mDrawBackground; }

    void setBackgroundEnabled( bool enabled ) { mDrawBackground = enabled; }

    const QgsFillSymbol *backgroundSymbol() const;

    void setBackgroundSymbol( QgsFillSymbol *symbol SIP_TRANSFER );

    bool frameEnabled() const { return mDrawFrame; }

    void setFrameEnabled( bool enabled ) { mDrawFrame = enabled; }

    const QgsFillSymbol *frameSymbol() const;

    void setFrameSymbol( QgsFillSymbol *symbol SIP_TRANSFER );
 
  protected:
    void copyCommonProperties( const QgsAnnotationItem *other ) override;
    bool writeCommonProperties( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readCommonProperties( const QDomElement &element, const QgsReadWriteContext &context ) override;

    virtual void renderInBounds( QgsRenderContext &context, const QRectF &painterRect, QgsFeedback *feedback ) = 0;
 
  private:
    Qgis::AnnotationPlacementMode mPlacementMode = Qgis::AnnotationPlacementMode::SpatialBounds;
    QgsRectangle mBounds;
 
    QSizeF mFixedSize;
    Qgis::RenderUnit mFixedSizeUnit = Qgis::RenderUnit::Millimeters;
    bool mDrawBackground = false;
    std::unique_ptr< QgsFillSymbol > mBackgroundSymbol;
    bool mDrawFrame = false;
    std::unique_ptr< QgsFillSymbol > mFrameSymbol;
 
#ifdef SIP_RUN
    QgsAnnotationRectItem( const QgsAnnotationRectItem &other );
#endif
};
#endif // QGSANNOTATIONRECTITEM_H