qgsannotationitem.h

Go to the documentation of this file.

/***************************************************************************
    qgsannotationitem.h
    ----------------
    copyright            : (C) 2019 by Sandro Mani
    email                : smani at sourcepole dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSANNOTATIONITEM_H
#define QGSANNOTATIONITEM_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscallout.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsgeometry.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsFeedback;
class QgsMarkerSymbol;
class QgsLineSymbol;
class QgsFillSymbol;
class QgsAnnotationItemNode;
class QgsAnnotationItemEditContext;
class QgsAbstractAnnotationItemEditOperation;
class QgsAnnotationItemEditOperationTransientResults;
class QgsRenderContext;
class QgsReadWriteContext;
class QPainter;

class CORE_EXPORT QgsAnnotationItem
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( sipCpp->type() == "marker"_L1 )
    {
      sipType = sipType_QgsAnnotationMarkerItem;
    }
    else if ( sipCpp->type() == "linestring"_L1 )
    {
      sipType = sipType_QgsAnnotationLineItem;
    }
    else if ( sipCpp->type() == "polygon"_L1 )
    {
      sipType = sipType_QgsAnnotationPolygonItem;
    }
    else if ( sipCpp->type() == "pointtext"_L1 )
    {
      sipType = sipType_QgsAnnotationPointTextItem;
    }
    else if ( sipCpp->type() == "linetext"_L1 )
    {
      sipType = sipType_QgsAnnotationLineTextItem;
    }
    else if ( sipCpp->type() == "recttext"_L1 )
    {
      sipType = sipType_QgsAnnotationRectangleTextItem;
    }
    else if ( sipCpp->type() == "picture"_L1 )
    {
      sipType = sipType_QgsAnnotationPictureItem;
    }
    else
    {
      sipType = 0;
    }
  SIP_END
#endif
 
  public:
    QgsAnnotationItem();
 
#ifndef SIP_RUN
    QgsAnnotationItem( const QgsAnnotationItem &other ) = delete;
    QgsAnnotationItem &operator=( const QgsAnnotationItem &other ) = delete;
#endif
 
    virtual ~QgsAnnotationItem();

    virtual Qgis::AnnotationItemFlags flags() const;

    virtual QgsAnnotationItem *clone() const = 0 SIP_FACTORY;

    virtual QString type() const = 0;

    virtual QgsRectangle boundingBox() const = 0;

    virtual QgsRectangle boundingBox( QgsRenderContext &context ) const
    {
      Q_UNUSED( context )
      return boundingBox();
    }

    virtual void render( QgsRenderContext &context, QgsFeedback *feedback ) = 0;

    virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const = 0;

    virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) = 0;

    Q_DECL_DEPRECATED virtual Qgis::AnnotationItemEditOperationResult applyEdit( QgsAbstractAnnotationItemEditOperation *operation ) SIP_DEPRECATED;

    virtual Qgis::AnnotationItemEditOperationResult applyEditV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context );

    Q_DECL_DEPRECATED virtual QgsAnnotationItemEditOperationTransientResults *transientEditResults( QgsAbstractAnnotationItemEditOperation *operation ) SIP_FACTORY;

    virtual QgsAnnotationItemEditOperationTransientResults *transientEditResultsV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context ) SIP_FACTORY;

    int zIndex() const { return mZIndex; }

    void setZIndex( int index ) { mZIndex = index; }

    bool enabled() const { return mEnabled; }

    void setEnabled( bool enabled ) { mEnabled = enabled; }

    Q_DECL_DEPRECATED virtual QList< QgsAnnotationItemNode > nodes() const SIP_DEPRECATED;

    virtual QList< QgsAnnotationItemNode > nodesV2( const QgsAnnotationItemEditContext &context ) const;

    bool useSymbologyReferenceScale() const { return mUseReferenceScale; }

    void setUseSymbologyReferenceScale( bool enabled ) { mUseReferenceScale = enabled; }

    double symbologyReferenceScale() const { return mReferenceScale; }

    void setSymbologyReferenceScale( double scale ) { mReferenceScale = scale; }

    QgsCallout *callout() const;

    void setCallout( QgsCallout *callout SIP_TRANSFER );

    QgsGeometry calloutAnchor() const;

    void setCalloutAnchor( const QgsGeometry &anchor );

    QSizeF offsetFromCallout() const;

    void setOffsetFromCallout( const QSizeF &offset );

    Qgis::RenderUnit offsetFromCalloutUnit() const;

    void setOffsetFromCalloutUnit( Qgis::RenderUnit unit );
 
  protected:
    virtual void copyCommonProperties( const QgsAnnotationItem *other );

    virtual bool writeCommonProperties( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;

    virtual bool readCommonProperties( const QDomElement &element, const QgsReadWriteContext &context );

    void renderCallout( QgsRenderContext &context, const QRectF &rect, double angle, QgsCallout::QgsCalloutContext &calloutContext, QgsFeedback *feedback );
 
  private:
    int mZIndex = 0;
    bool mEnabled = true;
    bool mUseReferenceScale = false;
    double mReferenceScale = 0;
 
    std::unique_ptr< QgsCallout > mCallout;
    QgsGeometry mCalloutAnchor;
    QSizeF mOffsetFromCallout;
    Qgis::RenderUnit mOffsetFromCalloutUnit = Qgis::RenderUnit::Millimeters;
 
#ifdef SIP_RUN
    QgsAnnotationItem( const QgsAnnotationItem &other );
#endif
};
 
#endif // QGSANNOTATIONITEM_H