qgslayoutitemmapitem.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutitemmapitem.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 QGSLAYOUTITEMMAPITEM_H
#define QGSLAYOUTITEMMAPITEM_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayoutobject.h"
#include "qgsmaplayerref.h"

class QgsLayoutItemMap;

class CORE_EXPORT QgsLayoutItemMapItem : public QgsLayoutObject
{
    Q_OBJECT

  public:

    enum StackingPosition
    {
      StackBelowMap, 
      StackBelowMapLayer, 
      StackAboveMapLayer, 
      StackBelowMapLabels, 
      StackAboveMapLabels, 
    };

    QgsLayoutItemMapItem( const QString &name, QgsLayoutItemMap *map );

    virtual void draw( QPainter *painter ) = 0;

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

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

    virtual void finalizeRestoreFromXml();

    void setMap( QgsLayoutItemMap *map );

    const QgsLayoutItemMap *map() const;

    QString id() const { return mUuid; }

    void setName( const QString &name );

    QString name() const;

    virtual void setEnabled( bool enabled );

    bool enabled() const;

    virtual bool usesAdvancedEffects() const;

    StackingPosition stackingPosition() const { return mStackingPosition; }

    void setStackingPosition( StackingPosition position ) { mStackingPosition = position; }

    QgsMapLayer *stackingLayer() const;

    void setStackingLayer( QgsMapLayer *layer );

    virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;

    QgsExpressionContext createExpressionContext() const override;

  protected:

    QString mName;

    QgsLayoutItemMap *mMap = nullptr;

    QString mUuid;

    bool mEnabled;

    StackingPosition mStackingPosition = StackBelowMapLabels;

    QgsMapLayerRef mStackingLayer;

};

class CORE_EXPORT QgsLayoutItemMapItemStack
{
  public:

    QgsLayoutItemMapItemStack( QgsLayoutItemMap *map );

    virtual ~QgsLayoutItemMapItemStack();

    int size() const { return mItems.size(); }

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

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

    virtual void finalizeRestoreFromXml();

    void drawItems( QPainter *painter, bool ignoreStacking = true );

    bool containsAdvancedEffects() const;

    bool hasEnabledItems() const;

    QgsLayoutItemMapItem *item( int index ) const;

  protected:

    void addItem( QgsLayoutItemMapItem *item SIP_TRANSFER );

    void removeItem( const QString &itemId );

    void moveItemUp( const QString &itemId );

    void moveItemDown( const QString &itemId );

    QgsLayoutItemMapItem *item( const QString &itemId ) const;

    QgsLayoutItemMapItem &operator[]( int index ) SIP_SKIP;

    QList< QgsLayoutItemMapItem * > asList() const;

  protected:

    QList< QgsLayoutItemMapItem * > mItems;

    QgsLayoutItemMap *mMap = nullptr;

    void removeItems();
};

#endif //QGSLAYOUTITEMMAPITEM_H