qgscomposerframe.h

Go to the documentation of this file.

/***************************************************************************
                              qgscomposerframe.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 QGSCOMPOSERFRAME_H
#define QGSCOMPOSERFRAME_H

#include "qgscomposeritem.h"

class QgsComposition;
class QgsComposerMultiFrame;

class CORE_EXPORT QgsComposerFrame: public QgsComposerItem
{
    Q_OBJECT

  public:

    QgsComposerFrame( QgsComposition* c, QgsComposerMultiFrame* mf, qreal x, qreal y, qreal width, qreal height );

    ~QgsComposerFrame();

    void setContentSection( const QRectF& section ) { mSection = section; }

    QgsComposerMultiFrame* multiFrame() const { return mMultiFrame; }

    //Overridden to allow multiframe to set display name
    virtual QString displayName() const override;

    //Overridden to handle fixed frame sizes set by multi frame
    void setSceneRect( const QRectF& rectangle ) override;

    void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override;
    void beginItemCommand( const QString& text ) override;
    void endItemCommand() override;
    bool writeXML( QDomElement& elem, QDomDocument & doc ) const override;
    bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) override;
    int type() const override { return ComposerFrame; }

    QRectF extent() const { return mSection; }

    bool hidePageIfEmpty() const { return mHidePageIfEmpty; }

    void setHidePageIfEmpty( const bool hidePageIfEmpty );

    bool hideBackgroundIfEmpty() const { return mHideBackgroundIfEmpty; }

    void setHideBackgroundIfEmpty( const bool hideBackgroundIfEmpty );

    bool isEmpty() const;

    virtual QgsExpressionContext* createExpressionContext() const override;

  private:
    QgsComposerFrame(); //forbidden
    QgsComposerMultiFrame* mMultiFrame;
    QRectF mSection;

    bool mHidePageIfEmpty;
    bool mHideBackgroundIfEmpty;

};

#endif // QGSCOMPOSERFRAME_H