qgscomposermultiframe.h

Go to the documentation of this file.

/***************************************************************************
                              qgscomposermultiframe.h
    ------------------------------------------------------------
    begin                : July 2012
    copyright            : (C) 2012 by Marco Hugentobler
    email                : marco dot hugentobler at sourcepole dot ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSCOMPOSERMULTIFRAME_H
#define QGSCOMPOSERMULTIFRAME_H

#include "qgscomposerobject.h"
#include <QObject>
#include <QSizeF>
#include <QPointF>

class QgsComposerFrame;
class QgsComposerItem;
class QgsComposition;
class QDomDocument;
class QDomElement;
class QRectF;
class QPainter;

class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
{
    Q_OBJECT

  public:

    enum ResizeMode
    {
      UseExistingFrames = 0, 
      ExtendToNextPage, 
      RepeatOnEveryPage, 
      RepeatUntilFinished 
    };

    QgsComposerMultiFrame( QgsComposition* c, bool createUndoCommands );

    virtual ~QgsComposerMultiFrame();

    virtual QSizeF totalSize() const = 0;

    virtual QSizeF fixedFrameSize( const int frameIndex = -1 ) const { Q_UNUSED( frameIndex ); return QSizeF( 0, 0 ); }

    virtual QSizeF minFrameSize( const int frameIndex = -1 ) const { Q_UNUSED( frameIndex ); return QSizeF( 0, 0 ); }

    Q_DECL_DEPRECATED virtual void render( QPainter* p, const QRectF& renderExtent );

    virtual void render( QPainter* painter, const QRectF& renderExtent, const int frameIndex );

    virtual void addFrame( QgsComposerFrame* frame, bool recalcFrameSizes = true ) = 0;

    virtual double findNearbyPageBreak( double yPos ) { return yPos; }

    void removeFrame( int i, const bool removeEmptyPages = false );

    void deleteFrames();

    void setResizeMode( ResizeMode mode );

    ResizeMode resizeMode() const { return mResizeMode; }

    virtual bool writeXML( QDomElement& elem, QDomDocument & doc, bool ignoreFrames = false ) const = 0;

    bool _writeXML( QDomElement& elem, QDomDocument& doc, bool ignoreFrames = false ) const;

    virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc, bool ignoreFrames = false ) = 0;

    bool _readXML( const QDomElement& itemElem, const QDomDocument& doc, bool ignoreFrames = false );

    QgsComposition* composition() { return mComposition; }

    bool createUndoCommands() const { return mCreateUndoCommands; }

    void setCreateUndoCommands( bool enabled ) { mCreateUndoCommands = enabled; }

    int frameCount() const { return mFrameItems.size(); }

    QgsComposerFrame* frame( int i ) const;

    int frameIndex( QgsComposerFrame *frame ) const;

    QgsComposerFrame* createNewFrame( QgsComposerFrame* currentFrame, QPointF pos, QSizeF size );

    virtual QString displayName() const;

  public slots:

    void update();

    virtual void recalculateFrameSizes();

    void recalculateFrameRects();

  signals:

    void changed();

    void contentsChanged();

  protected:

    QList<QgsComposerFrame*> mFrameItems;

    ResizeMode mResizeMode;

    bool mCreateUndoCommands;

  protected slots:

    void handleFrameRemoval( QgsComposerItem* item );

    void handlePageChange();

  private:
    QgsComposerMultiFrame(); //forbidden

    bool mIsRecalculatingSize;
};

#endif // QGSCOMPOSERMULTIFRAME_H