Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                              qgsreportsectionlayout.h
       3                 :            :                              ---------------------------
       4                 :            :     begin                : December 2017
       5                 :            :     copyright            : (C) 2017 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : /***************************************************************************
       9                 :            :  *                                                                         *
      10                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      11                 :            :  *   it under the terms of the GNU General Public License as published by  *
      12                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      13                 :            :  *   (at your option) any later version.                                   *
      14                 :            :  *                                                                         *
      15                 :            :  ***************************************************************************/
      16                 :            : #ifndef QGSREPORTSECTIONLAYOUT_H
      17                 :            : #define QGSREPORTSECTIONLAYOUT_H
      18                 :            : 
      19                 :            : #include "qgis_core.h"
      20                 :            : #include "qgsabstractreportsection.h"
      21                 :            : 
      22                 :            : ///@cond NOT_STABLE
      23                 :            : 
      24                 :            : // This is not considered stable API - it is exposed to python bindings only for unit testing!
      25                 :            : 
      26                 :            : /**
      27                 :            :  * \ingroup core
      28                 :            :  * \class QgsReportSectionLayout
      29                 :            :  * \brief A report section consisting of a single QgsLayout body.
      30                 :            :  * \warning This is not considered stable API, and may change in future QGIS releases. It is
      31                 :            :  * exposed to the Python bindings for unit testing purposes only.
      32                 :            :  * \since QGIS 3.0
      33                 :            :  */
      34                 :          0 : class CORE_EXPORT QgsReportSectionLayout : public QgsAbstractReportSection
      35                 :            : {
      36                 :            :   public:
      37                 :            : 
      38                 :            :     /**
      39                 :            :      * Constructor for QgsReportSectionLayout, attached to the specified \a parent section.
      40                 :            :      * Note that ownership is not transferred to \a parent.
      41                 :            :      */
      42                 :            :     QgsReportSectionLayout( QgsAbstractReportSection *parentSection = nullptr );
      43                 :            : 
      44                 :          0 :     QString type() const override { return QStringLiteral( "SectionLayout" ); }
      45                 :          0 :     QString description() const override { return QObject::tr( "Section" ); }
      46                 :            :     QIcon icon() const override;
      47                 :            : 
      48                 :            :     /**
      49                 :            :      * Returns the body layout for the section.
      50                 :            :      * \see setBody()
      51                 :            :      * \see bodyEnabled()
      52                 :            :      * \see setBodyEnabled()
      53                 :            :      */
      54                 :            :     QgsLayout *body() { return mBody.get(); }
      55                 :            : 
      56                 :            :     /**
      57                 :            :      * Sets the \a body layout for the section. Ownership of \a body
      58                 :            :      * is transferred to the report section.
      59                 :            :      * \see body()
      60                 :            :      * \see bodyEnabled()
      61                 :            :      * \see setBodyEnabled()
      62                 :            :      */
      63                 :            :     void setBody( QgsLayout *body SIP_TRANSFER ) { mBody.reset( body ); }
      64                 :            : 
      65                 :            :     /**
      66                 :            :      * Returns TRUE if the body for the section is enabled.
      67                 :            :      * \see setBodyEnabled()
      68                 :            :      * \see body()
      69                 :            :      * \see setBody()
      70                 :            :      */
      71                 :            :     bool bodyEnabled() const { return mBodyEnabled; }
      72                 :            : 
      73                 :            :     /**
      74                 :            :      * Sets whether the body for the section is \a enabled.
      75                 :            :      * \see bodyEnabled()
      76                 :            :      * \see body()
      77                 :            :      * \see setBody()
      78                 :            :      */
      79                 :            :     void setBodyEnabled( bool enabled ) { mBodyEnabled = enabled; }
      80                 :            : 
      81                 :            :     QgsReportSectionLayout *clone() const override SIP_FACTORY;
      82                 :            :     bool beginRender() override;
      83                 :            :     QgsLayout *nextBody( bool &ok ) override;
      84                 :            :     void reloadSettings() override;
      85                 :            : 
      86                 :            :   protected:
      87                 :            : 
      88                 :            :     bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
      89                 :            :     bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
      90                 :            : 
      91                 :            :   private:
      92                 :            : 
      93                 :            :     bool mExportedBody = false;
      94                 :            :     std::unique_ptr< QgsLayout > mBody;
      95                 :            :     bool mBodyEnabled = true;
      96                 :            : };
      97                 :            : 
      98                 :            : ///@endcond
      99                 :            : 
     100                 :            : #endif //QGSREPORTSECTIONLAYOUT_H