qgsannotationmanager.h

Go to the documentation of this file.

/***************************************************************************
    qgsannotationmanager.h
    ----------------------
    Date                 : January 2017
    Copyright            : (C) 2017 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 QGSANNOTATIONMANAGER_H
#define QGSANNOTATIONMANAGER_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QDomElement>
#include <QObject>
 
class QgsReadWriteContext;
class QgsProject;
class QgsAnnotation;
class QgsStyleEntityVisitorInterface;
class QgsAnnotationLayer;
class QgsAnnotationItem;
class QgsCoordinateTransformContext;

class CORE_EXPORT QgsAnnotationManager : public QObject
{
    Q_OBJECT
 
  public:

    explicit QgsAnnotationManager( QgsProject *project SIP_TRANSFERTHIS = nullptr );
 
    ~QgsAnnotationManager() override;

    bool addAnnotation( QgsAnnotation *annotation SIP_TRANSFER );

    bool removeAnnotation( QgsAnnotation *annotation );

    void clear();

    QList< QgsAnnotation * > annotations() const;

    QList< QgsAnnotation * > cloneAnnotations() const SIP_FACTORY;

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

    bool readXmlAndUpgradeToAnnotationLayerItems( const QDomElement &element, const QgsReadWriteContext &context,
        QgsAnnotationLayer *layer, const QgsCoordinateTransformContext &transformContext ) SIP_SKIP;

    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;

    bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
 
  signals:

    void annotationAdded( QgsAnnotation *annotation );

    void annotationRemoved();

    void annotationAboutToBeRemoved( QgsAnnotation *annotation );
 
  private:
 
    bool readXmlPrivate( const QDomElement &element, const QgsReadWriteContext &context, QgsAnnotationLayer *layer, const QgsCoordinateTransformContext &transformContext );
    static std::unique_ptr< QgsAnnotationItem > convertToAnnotationItem( QgsAnnotation *annotation, QgsAnnotationLayer *layer,
        const QgsCoordinateTransformContext &transformContext );
 
    QgsProject *mProject = nullptr;
 
    QList< QgsAnnotation * > mAnnotations;
 
    QgsAnnotation *createAnnotationFromXml( const QDomElement &element, const QgsReadWriteContext &context );
 
};
 
#endif // QGSANNOTATIONMANAGER_H