qgscomposermapitem.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposermapitem.h
                             -------------------
    begin                : September 2014
    copyright            : (C) 2014 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 QGSCOMPOSERMAPITEM_H
#define QGSCOMPOSERMAPITEM_H

#include "qgscomposerobject.h"

class QgsComposerMap;

class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject
{
    Q_OBJECT

  public:

    QgsComposerMapItem( const QString& name, QgsComposerMap* map );

    virtual ~QgsComposerMapItem();

    virtual void draw( QPainter* painter ) = 0;

    virtual bool writeXML( QDomElement& elem, QDomDocument & doc ) const;

    virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

    virtual void setComposerMap( QgsComposerMap* map );

    virtual const QgsComposerMap* composerMap() const { return mComposerMap; }

    QString id() const { return mUuid; }

    virtual void setName( const QString& name ) { mName = name; }

    virtual QString name() const { return mName; }

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

    virtual bool enabled() const { return mEnabled; }

    virtual bool usesAdvancedEffects() const { return false; }

  protected:

    QString mName;

    QgsComposerMap* mComposerMap;

    QString mUuid;

    bool mEnabled;

};



class CORE_EXPORT QgsComposerMapItemStack
{
  public:

    QgsComposerMapItemStack( QgsComposerMap* map );

    virtual ~QgsComposerMapItemStack();

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

    virtual bool writeXML( QDomElement& elem, QDomDocument & doc ) const;

    virtual bool readXML( const QDomElement& elem, const QDomDocument& doc ) = 0;

    void drawItems( QPainter* painter );

    bool containsAdvancedEffects() const;

  protected:

    void addItem( QgsComposerMapItem* item );

    void removeItem( const QString& itemId );

    void moveItemUp( const QString& itemId );

    void moveItemDown( const QString& itemId );

    const QgsComposerMapItem* constItem( const QString& itemId ) const;

    QgsComposerMapItem* item( const QString& itemId ) const;

    QgsComposerMapItem* item( const int index ) const;

    QgsComposerMapItem &operator[]( int idx );

    QList< QgsComposerMapItem* > asList() const;

  protected:

    QList< QgsComposerMapItem* > mItems;

    QgsComposerMap* mComposerMap;

    void removeItems();
};

#endif //QGSCOMPOSERMAPITEM_H