qgscomposermapoverview.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposermapoverview.h
                         --------------------
    begin                : July 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 QGSCOMPOSERMAPOVERVIEW_H
#define QGSCOMPOSERMAPOVERVIEW_H

#include "qgscomposermapitem.h"
#include <QString>
#include <QObject>
#include <QPainter>

class QDomDocument;
class QDomElement;
class QgsFillSymbolV2;
class QgsComposerMapOverview;

class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
{
  public:

    QgsComposerMapOverviewStack( QgsComposerMap* map );

    virtual ~QgsComposerMapOverviewStack();

    void addOverview( QgsComposerMapOverview* overview );

    void removeOverview( const QString& overviewId );

    void moveOverviewUp( const QString& overviewId );

    void moveOverviewDown( const QString& overviewId );

    const QgsComposerMapOverview* constOverview( const QString& overviewId ) const;

    QgsComposerMapOverview* overview( const QString& overviewId ) const;

    QgsComposerMapOverview* overview( const int index ) const;

    QgsComposerMapOverview &operator[]( int idx );

    QList< QgsComposerMapOverview* > asList() const;

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

};

class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
{
    Q_OBJECT

  public:

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

    virtual ~QgsComposerMapOverview();

    void draw( QPainter* painter );

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

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

    bool usesAdvancedEffects() const;

    void setFrameMap( const int mapId );

    int frameMapId() const { return mFrameMapId; }

    void setFrameSymbol( QgsFillSymbolV2* symbol );

    QgsFillSymbolV2* frameSymbol() { return mFrameSymbol; }

    const QgsFillSymbolV2* frameSymbol() const { return mFrameSymbol; }

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

    void setBlendMode( const QPainter::CompositionMode blendMode );

    bool inverted() const { return mInverted; }

    void setInverted( const bool inverted );

    bool centered() const { return mCentered; }

    void setCentered( const bool centered );

    void connectSignals();

  public slots:

    void overviewExtentChanged();

  private:

    QgsComposerMapOverview(); //forbidden

    int mFrameMapId;

    QgsFillSymbolV2* mFrameSymbol;

    QPainter::CompositionMode mBlendMode;

    bool mInverted;

    bool mCentered;

    void createDefaultFrameSymbol();

};

#endif // QGSCOMPOSERMAPOVERVIEW_H