qgsannotationlayer.h

Go to the documentation of this file.

/***************************************************************************
    qgsannotationlayer.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 QGSANNOTATIONLAYER_H
#define QGSANNOTATIONLAYER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmaplayer.h"
#include "qgsmaplayerref.h"
#include "qgsmaplayerrenderer.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsAnnotationItem;
class QgsAbstractAnnotationItemEditOperation;
class QgsAnnotationItemEditContext;
class QgsPaintEffect;
 

class QgsAnnotationLayerSpatialIndex;

class CORE_EXPORT QgsAnnotationLayer : public QgsMapLayer
{
    Q_OBJECT
 
  public:
    struct LayerOptions
    {
        explicit LayerOptions( const QgsCoordinateTransformContext &transformContext )
          : transformContext( transformContext )
        {}

        QgsCoordinateTransformContext transformContext;
    };
 

    QgsAnnotationLayer( const QString &name, const QgsAnnotationLayer::LayerOptions &options );
    ~QgsAnnotationLayer() override;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsAnnotationLayer: '%1'>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

      void reset();

    QString addItem( QgsAnnotationItem *item SIP_TRANSFER );

    void replaceItem( const QString &id, QgsAnnotationItem *item SIP_TRANSFER );

    bool removeItem( const QString &id );

    void clear();

    bool isEmpty() const;

    QMap<QString, QgsAnnotationItem *> items() const { return mItems; }

    QgsAnnotationItem *item( const QString &id ) const;

    QStringList itemsInBounds( const QgsRectangle &bounds, QgsRenderContext &context, QgsFeedback *feedback = nullptr ) const;

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

    Qgis::AnnotationItemEditOperationResult applyEditV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context );
 
    Qgis::MapLayerProperties properties() const override;
    QgsAnnotationLayer *clone() const override SIP_FACTORY;
    QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) override SIP_FACTORY;
    QgsRectangle extent() const override;
    void setTransformContext( const QgsCoordinateTransformContext &context ) override;
    bool readXml( const QDomNode &layerNode, QgsReadWriteContext &context ) override;
    bool writeXml( QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &, StyleCategories categories = AllStyleCategories ) const override;
    bool readSymbology( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) override;
    bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories ) const override;
    bool readStyle( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories ) override;
    bool isEditable() const override;
    bool supportsEditing() const override;
    QgsDataProvider *dataProvider() override;
    const QgsDataProvider *dataProvider() const override SIP_SKIP;
    QString htmlMetadata() const override;
    void resolveReferences( QgsProject *project ) override;

    QgsPaintEffect *paintEffect() const;

    void setPaintEffect( QgsPaintEffect *effect SIP_TRANSFER );

    QgsMapLayer *linkedVisibilityLayer();

    void setLinkedVisibilityLayer( QgsMapLayer *layer );
 
  private:
    QStringList queryIndex( const QgsRectangle &bounds, QgsFeedback *feedback = nullptr ) const;
    bool writeItems( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) const;
    bool readItems( const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories );
 
    QMap<QString, QgsAnnotationItem *> mItems;
    QgsCoordinateTransformContext mTransformContext;
 
    std::unique_ptr< QgsAnnotationLayerSpatialIndex > mSpatialIndex;
    QSet< QString > mNonIndexedItems;
 
    std::unique_ptr<QgsDataProvider> mDataProvider;
 
    std::unique_ptr< QgsPaintEffect > mPaintEffect;
 
    QgsMapLayerRef mLinkedLayer;
 
    friend class QgsAnnotationLayerRenderer;
    friend class QgsAnnotationLayerChunkLoader;
};
 
#ifndef SIP_RUN

class QgsAnnotationLayerDataProvider : public QgsDataProvider
{
    Q_OBJECT
 
  public:
    QgsAnnotationLayerDataProvider( const QgsDataProvider::ProviderOptions &providerOptions, Qgis::DataProviderReadFlags flags );
    QgsCoordinateReferenceSystem crs() const override;
    QString name() const override;
    QString description() const override;
    QgsRectangle extent() const override;
    bool isValid() const override;
};
#endif
 
#endif // QGSANNOTATIONLAYER_H