qgsabstractreportsection.h

Go to the documentation of this file.

/***************************************************************************
                             qgsabstractreportsection.h
                             ---------------------------
    begin                : December 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 QGSABSTRACTREPORTSECTION_H
#define QGSABSTRACTREPORTSECTION_H

#include "qgis_core.h"
#include "qgsabstractlayoutiterator.h"
#include "qgslayoutreportcontext.h"
#include "qgsvectorlayerref.h"



// This is not considered stable API - it is exposed to python bindings only for unit testing!

class CORE_EXPORT QgsReportSectionContext
{
  public:

    QgsFeature feature;

    QgsVectorLayer *currentLayer = nullptr;

    QVariantMap fieldFilters;
};

class CORE_EXPORT QgsAbstractReportSection : public QgsAbstractLayoutIterator
{

#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast< QgsReportSectionFieldGroup * >( sipCpp ) )
      sipType = sipType_QgsReportSectionFieldGroup;
    else if ( dynamic_cast< QgsReportSectionLayout * >( sipCpp ) )
      sipType = sipType_QgsReportSectionLayout;
    else
      sipType = NULL;
    SIP_END
#endif

  public:

    QgsAbstractReportSection( QgsAbstractReportSection *parentSection = nullptr );

    ~QgsAbstractReportSection() override;

    QgsAbstractReportSection( const QgsAbstractReportSection &other ) = delete;

    QgsAbstractReportSection &operator=( const QgsAbstractReportSection &other ) = delete;

    virtual QString type() const = 0;

    virtual QString description() const = 0;

    virtual QIcon icon() const = 0;

    virtual QgsAbstractReportSection *clone() const = 0 SIP_FACTORY;

    QgsAbstractReportSection *parentSection() { return mParent; }

    QgsProject *project();

    // TODO - how to handle this?
    int count() const override { return -1; }

    QString filePath( const QString &baseFilePath, const QString &extension ) override;
    QgsLayout *layout() override;
    bool beginRender() override;
    bool next() override;
    bool endRender() override;

    virtual void reset();

    virtual bool prepareHeader();

    virtual bool prepareFooter();

    virtual QgsLayout *nextBody( bool &ok SIP_OUT ) { ok = false; return nullptr; }

    bool headerEnabled() const { return mHeaderEnabled; }

    void setHeaderEnabled( bool enabled ) { mHeaderEnabled = enabled; }

    QgsLayout *header() { return mHeader.get(); }

    void setHeader( QgsLayout *header SIP_TRANSFER );

    bool footerEnabled() const { return mFooterEnabled; }

    void setFooterEnabled( bool enabled ) { mFooterEnabled = enabled; }

    QgsLayout *footer() { return mFooter.get(); }

    void setFooter( QgsLayout *footer SIP_TRANSFER );

    int childCount() const { return mChildren.count(); }

    int row() const;

    QList< QgsAbstractReportSection * > childSections() const { return mChildren; }

    QgsAbstractReportSection *childSection( int index );

    void appendChild( QgsAbstractReportSection *section SIP_TRANSFER );

    void insertChild( int index, QgsAbstractReportSection *section SIP_TRANSFER );

    void removeChild( QgsAbstractReportSection *section );

    void removeChildAt( int index );

    void setContext( const QgsReportSectionContext &context );

    const QgsReportSectionContext &context() const { return mContext; }

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

    bool readXml( const QDomElement &sectionElement, const QDomDocument &document, const QgsReadWriteContext &context );

    virtual void reloadSettings();

    bool accept( QgsStyleEntityVisitorInterface *visitor ) const;

  protected:

    enum SubSection
    {
      Header, 
      Body, 
      Children, 
      Footer, 
      End, 
    };

    void copyCommonProperties( QgsAbstractReportSection *destination ) const;

    virtual void setParentSection( QgsAbstractReportSection *parent ) { mParent = parent; }

    virtual bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;

    virtual bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context );

  private:

    QgsAbstractReportSection *mParent = nullptr;

    int mSectionNumber = 0;
    SubSection mNextSection = Header;
    int mNextChild = 0;
    QgsLayout *mCurrentLayout = nullptr;

    bool mHeaderEnabled = false;
    bool mFooterEnabled = false;
    std::unique_ptr< QgsLayout > mHeader;
    std::unique_ptr< QgsLayout > mFooter;

    QList< QgsAbstractReportSection * > mChildren;

    QgsReportSectionContext mContext;

#ifdef SIP_RUN
    QgsAbstractReportSection( const QgsAbstractReportSection &other );
#endif
};


#endif //QGSABSTRACTREPORTSECTION_H