qgsreportsectionlayout.h

Go to the documentation of this file.

/***************************************************************************
                             qgsreportsectionlayout.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 QGSREPORTSECTIONLAYOUT_H
#define QGSREPORTSECTIONLAYOUT_H
 
#include "qgis_core.h"
#include "qgsabstractreportsection.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

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

class CORE_EXPORT QgsReportSectionLayout : public QgsAbstractReportSection
{
  public:

    QgsReportSectionLayout( QgsAbstractReportSection *parentSection = nullptr );
 
    QString type() const override { return u"SectionLayout"_s; }
    QString description() const override { return QObject::tr( "Section" ); }
    QIcon icon() const override;

    QgsLayout *body() { return mBody.get(); }

    void setBody( QgsLayout *body SIP_TRANSFER ) { mBody.reset( body ); }

    bool bodyEnabled() const { return mBodyEnabled; }

    void setBodyEnabled( bool enabled ) { mBodyEnabled = enabled; }
 
    QgsReportSectionLayout *clone() const override SIP_FACTORY;
    bool beginRender() override;
    QgsLayout *nextBody( bool &ok ) override;
    void reloadSettings() override;
 
  protected:
 
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
 
  private:
 
    bool mExportedBody = false;
    std::unique_ptr< QgsLayout > mBody;
    bool mBodyEnabled = true;
};

 
#endif //QGSREPORTSECTIONLAYOUT_H