qgsreportsectionfieldgroup.h

Go to the documentation of this file.

/***************************************************************************
                             qgsreportsectionfieldgroup.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 QGSREPORTSECTIONFIELDGROUP_H
#define QGSREPORTSECTIONFIELDGROUP_H
 
#include "qgis_core.h"
#include "qgsabstractreportsection.h"
#include "qgsfeatureiterator.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 QgsReportSectionFieldGroup : public QgsAbstractReportSection
{
  public:

    enum SectionVisibility
    {
      IncludeWhenFeaturesFound,      
      AlwaysInclude                  
    };

    QgsReportSectionFieldGroup( QgsAbstractReportSection *parentSection = nullptr );
 
    QString type() const override { return u"SectionFieldGroup"_s; }
    QString description() const override;
    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; }
 

    QgsVectorLayer *layer() { return mCoverageLayer.get(); }

    void setLayer( QgsVectorLayer *layer ) { mCoverageLayer = layer; }

    QString field() const { return mField; }

    void setField( const QString &field ) { mField = field; }

    bool sortAscending() const;

    void setSortAscending( bool sortAscending );

    SectionVisibility headerVisibility() const { return mHeaderVisibility; }

    void setHeaderVisibility( SectionVisibility visibility ) { mHeaderVisibility = visibility; }

    SectionVisibility footerVisibility() const { return mFooterVisibility; }

    void setFooterVisibility( SectionVisibility visibility ) { mFooterVisibility = visibility; }
 
    QgsReportSectionFieldGroup *clone() const override SIP_FACTORY;
    bool beginRender() override;
    bool prepareHeader() override;
    bool prepareFooter() override;
    QgsLayout *nextBody( bool &ok ) override;
    void reset() override;
    void setParentSection( QgsAbstractReportSection *parentSection ) 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:
 
    QgsVectorLayerRef mCoverageLayer;
    QString mField;
    bool mSortAscending = true;
    int mFieldIndex = -1;
    QgsFeatureIterator mFeatures;
    bool mSkipNextRequest = false;
    bool mNoFeatures = false;
    SectionVisibility mHeaderVisibility = IncludeWhenFeaturesFound;
    SectionVisibility mFooterVisibility = IncludeWhenFeaturesFound;
    QgsFeature mHeaderFeature;
    QgsFeature mLastFeature;
    QSet< QVariant > mEncounteredValues;
 
    bool mBodyEnabled = false;
    std::unique_ptr< QgsLayout > mBody;
 
    QgsFeatureRequest buildFeatureRequest() const;
 
    QgsFeature getNextFeature();
    void updateChildContexts( const QgsFeature &feature );
 
};
 

 
#endif //QGSREPORTSECTIONFIELDGROUP_H