qgslayoutmultiframe.h

Go to the documentation of this file.

/***************************************************************************
                              qgslayoutmultiframe.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 QGSLAYOUTMULTIFRAME_H
#define QGSLAYOUTMULTIFRAME_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsapplication.h"
#include "qgslayoutobject.h"
#include "qgslayoutundocommand.h"
 
#include <QIcon>
#include <QObject>
#include <QPointF>
#include <QSizeF>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsLayoutFrame;
class QgsLayoutItem;
class QgsLayout;
class QDomDocument;
class QDomElement;
class QRectF;
class QPainter;
class QStyleOptionGraphicsItem;
class QgsRenderContext;
class QgsLayoutItemRenderContext;

 
class CORE_EXPORT QgsLayoutMultiFrame : public QgsLayoutObject, public QgsLayoutUndoObjectInterface
{
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemhtml.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemattributetable.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemmanualtable.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgslayoutitemtexttable.h" );
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    // the conversions have to be static, because they're using multiple inheritance
    // (seen in PyQt4 .sip files for some QGraphicsItem classes)
    if ( QgsLayoutMultiFrame *mf = qobject_cast< QgsLayoutMultiFrame *>( sipCpp ) )
    {
      switch ( mf->type() )
      {
        // really, these *should* use the constants from QgsLayoutItemRegistry, but sip doesn't like that!
        case QGraphicsItem::UserType + 112:
          sipType = sipType_QgsLayoutItemHtml;
          *sipCppRet = static_cast<QgsLayoutItemHtml *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 113:
          sipType = sipType_QgsLayoutItemAttributeTable;
          *sipCppRet = static_cast<QgsLayoutItemAttributeTable *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 114:
          sipType = sipType_QgsLayoutItemTextTable;
          *sipCppRet = static_cast<QgsLayoutItemTextTable *>( sipCpp );
          break;
        case QGraphicsItem::UserType + 116:
          sipType = sipType_QgsLayoutItemManualTable;
          *sipCppRet = static_cast<QgsLayoutItemManualTable *>( sipCpp );
          break;
        default:
          sipType = 0;
      }
    }
    else
    {
      sipType = 0;
    }
    SIP_END
#endif
 
    // clang-format off
  Q_OBJECT
 
  public:

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

    enum UndoCommand
    {
      // clang-format on
      UndoHtmlBreakDistance,     
      UndoHtmlSource,            
      UndoHtmlStylesheet,        
      UndoTableCellStyle,        
      UndoTableMaximumFeatures,  
      UndoTableMargin,           
      UndoTableHeaderFontColor,  
      UndoTableContentFontColor, 
      UndoTableGridStrokeWidth,  
      UndoTableGridColor,        
      UndoTableBackgroundColor,  
      UndoNone = -1,             
    };

    QgsLayoutMultiFrame( QgsLayout *layout SIP_TRANSFERTHIS );
 
    ~QgsLayoutMultiFrame() override;

    QString uuid() const { return mUuid; }

    virtual QSizeF totalSize() const = 0;

    virtual int type() const = 0;

    virtual QIcon icon() const { return QgsApplication::getThemeIcon( u"/mLayoutItem.svg"_s ); }

    virtual QSizeF fixedFrameSize( int frameIndex = -1 ) const;

    virtual QSizeF minFrameSize( int frameIndex = -1 ) const;

    virtual void render( QgsLayoutItemRenderContext &context, const QRectF &renderExtent, int frameIndex ) = 0;

    virtual void addFrame( QgsLayoutFrame *frame SIP_TRANSFER, bool recalcFrameSizes = true );

    virtual double findNearbyPageBreak( double yPos );

    void removeFrame( int index, bool removeEmptyPages = false );

    void deleteFrames();

    void setResizeMode( ResizeMode mode );

    ResizeMode resizeMode() const { return mResizeMode; }

    bool writeXml( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context, bool includeFrames = false ) const;

    bool readXml( const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context, bool includeFrames = false );

    QList<QgsLayoutFrame *> frames() const;

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

    QgsLayoutFrame *frame( int index ) const;

    int frameIndex( QgsLayoutFrame *frame ) const;

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

    virtual QString displayName() const;
 
    QgsAbstractLayoutUndoCommand *createCommand( const QString &text, int id, QUndoCommand *parent = nullptr ) override SIP_FACTORY;
 
    QgsExpressionContext createExpressionContext() const override;

    void beginCommand( const QString &commandText, UndoCommand command = UndoNone );

    void endCommand();

    void cancelCommand();

    virtual void finalizeRestoreFromXml();
 
  public slots:

    void refresh() override;

    void update();

    virtual void recalculateFrameSizes();

    void recalculateFrameRects();

    virtual void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::DataDefinedProperty::AllProperties );
 
  signals:

    void contentsChanged();
 
  protected:
    virtual bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;

    virtual bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context );
 
    QList<QgsLayoutFrame *> mFrameItems;
 
    ResizeMode mResizeMode = UseExistingFrames;
 
  private slots:

    void handlePageChange();

    void handleFrameRemoval( QgsLayoutFrame *frame );
 
 
  private:
    QgsLayoutMultiFrame() = delete;
 
    bool mIsRecalculatingSize = false;
 
    bool mBlockUpdates = false;
    bool mBlockUndoCommands = false;
 
    QList< QString > mFrameUuids;
    QList< QString > mFrameTemplateUuids;

    QString mUuid;
    QString mTemplateUuid;
    friend class QgsLayoutFrame;
    friend class QgsLayout;
};
 
 
#endif // QGSLAYOUTMULTIFRAME_H