qgslayoutitemmapoverview.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutitemmapoverview.h
                         --------------------
    begin                : October 2017
    copyright            : (C) 2017 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 QgsLayoutItemMapOVERVIEW_H
#define QgsLayoutItemMapOVERVIEW_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayoutitemmapitem.h"
 
#include <QObject>
#include <QPainter>
#include <QString>
 
class QDomDocument;
class QDomElement;
class QgsLayoutItemMapOverview;
class QgsFillSymbol;

class CORE_EXPORT QgsLayoutItemMapOverviewStack : public QgsLayoutItemMapItemStack
{
  public:
    QgsLayoutItemMapOverviewStack( QgsLayoutItemMap *map );

    void addOverview( QgsLayoutItemMapOverview *overview SIP_TRANSFER );

    void removeOverview( const QString &overviewId );

    void moveOverviewUp( const QString &overviewId );

    void moveOverviewDown( const QString &overviewId );

    QgsLayoutItemMapOverview *overview( const QString &overviewId ) const;

    QgsLayoutItemMapOverview *overview( int index ) const;

    QgsLayoutItemMapOverview &operator[]( int index ); // cppcheck-suppress duplInheritedMember

    QList< QgsLayoutItemMapOverview * > asList() const; // cppcheck-suppress duplInheritedMember
    bool readXml( const QDomElement &elem, const QDomDocument &doc, const QgsReadWriteContext &context ) override;

    QList< QgsMapLayer * > modifyMapLayerList( const QList< QgsMapLayer * > &layers );
};

class CORE_EXPORT QgsLayoutItemMapOverview : public QgsLayoutItemMapItem
{
    Q_OBJECT
 
  public:
    QgsLayoutItemMapOverview( const QString &name, QgsLayoutItemMap *map );
    ~QgsLayoutItemMapOverview() override;
 
    void draw( QPainter *painter ) override;
    bool writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    bool readXml( const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context ) override;
    void finalizeRestoreFromXml() override;
    bool usesAdvancedEffects() const override;

    void setLinkedMap( QgsLayoutItemMap *map );

    QgsLayoutItemMap *linkedMap();

    void setFrameSymbol( QgsFillSymbol *symbol SIP_TRANSFER );

    QgsFillSymbol *frameSymbol();

    const QgsFillSymbol *frameSymbol() const SIP_SKIP;

    QPainter::CompositionMode blendMode() const { return mBlendMode; }

    void setBlendMode( QPainter::CompositionMode mode );

    bool inverted() const { return mInverted; }

    void setInverted( bool inverted );

    bool centered() const { return mCentered; }

    void setCentered( bool centered );

    void connectSignals();

    QgsVectorLayer *asMapLayer();
 
    QgsMapLayer *mapLayer() override;
 
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
 
  public slots:

    void overviewExtentChanged();
 
  private:
    QgsLayoutItemMapOverview() = delete;
 
    QString mFrameMapUuid;
    QPointer< QgsLayoutItemMap > mFrameMap;

    std::unique_ptr< QgsFillSymbol > mFrameSymbol;

    QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;

    bool mInverted = false;

    bool mCentered = false;
 
    std::unique_ptr< QgsVectorLayer > mExtentLayer;

    void createDefaultFrameSymbol();
};
 
#endif // QgsLayoutItemMapOVERVIEW_H