/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgsreportsectionfieldgroup.h                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/





class QgsReportSectionFieldGroup : QgsAbstractReportSection
{
%Docstring(signature="appended")
A report section consisting of a features

.. warning::

   This is not considered stable API, and may change in future QGIS releases. It is
   exposed to the Python bindings for unit testing purposes only.

.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgsreportsectionfieldgroup.h"
%End
  public:

    enum SectionVisibility
    {
      IncludeWhenFeaturesFound,
      AlwaysInclude
    };

    QgsReportSectionFieldGroup( QgsAbstractReportSection *parentSection = 0 );
%Docstring
Constructor for QgsReportSectionFieldGroup, attached to the specified ``parent`` section.
Note that ownership is not transferred to ``parent``.
%End

    virtual QString type() const;
    virtual QString description() const;

    virtual QIcon icon() const;


    QgsLayout *body();
%Docstring
Returns the body layout for the section.

.. seealso:: :py:func:`setBody`

.. seealso:: :py:func:`bodyEnabled`

.. seealso:: :py:func:`setBodyEnabled`
%End

    void setBody( QgsLayout *body /Transfer/ );
%Docstring
Sets the ``body`` layout for the section. Ownership of ``body``
is transferred to the report section.

.. seealso:: :py:func:`body`

.. seealso:: :py:func:`bodyEnabled`

.. seealso:: :py:func:`setBodyEnabled`
%End

    bool bodyEnabled() const;
%Docstring
Returns ``True`` if the body for the section is enabled.

.. seealso:: :py:func:`setBodyEnabled`

.. seealso:: :py:func:`body`

.. seealso:: :py:func:`setBody`
%End

    void setBodyEnabled( bool enabled );
%Docstring
Sets whether the body for the section is ``enabled``.

.. seealso:: :py:func:`bodyEnabled`

.. seealso:: :py:func:`body`

.. seealso:: :py:func:`setBody`
%End


    QgsVectorLayer *layer();
%Docstring
Returns the vector layer associated with this section.

.. seealso:: :py:func:`setLayer`
%End

    void setLayer( QgsVectorLayer *layer );
%Docstring
Sets the vector ``layer`` associated with this section.

.. seealso:: :py:func:`layer`
%End

    QString field() const;
%Docstring
Returns the field associated with this section.

.. seealso:: :py:func:`setField`
%End

    void setField( const QString &field );
%Docstring
Sets the ``field`` associated with this section.

.. seealso:: :py:func:`field`
%End

    bool sortAscending() const;
%Docstring
Returns ``True`` if the field values should be sorted ascending,
or ``False`` for descending sort.

.. seealso:: :py:func:`setSortAscending`
%End

    void setSortAscending( bool sortAscending );
%Docstring
Sets whether the field values should be sorted ascending. Set to ``True`` to sort
ascending, or ``False`` for descending sort.

.. seealso:: :py:func:`sortAscending`
%End

    SectionVisibility headerVisibility() const;
%Docstring
Returns the header visibility mode.

.. seealso:: :py:func:`setHeaderVisibility`
%End

    void setHeaderVisibility( SectionVisibility visibility );
%Docstring
Sets the visibility mode for the header.

.. seealso:: :py:func:`headerVisibility`
%End

    SectionVisibility footerVisibility() const;
%Docstring
Returns the footer visibility mode.

.. seealso:: :py:func:`setFooterVisibility`
%End

    void setFooterVisibility( SectionVisibility visibility );
%Docstring
Sets the visibility mode for the footer.

.. seealso:: :py:func:`footerVisibility`
%End

    virtual QgsReportSectionFieldGroup *clone() const /Factory/;

    virtual bool beginRender();

    virtual bool prepareHeader();

    virtual bool prepareFooter();

    virtual QgsLayout *nextBody( bool &ok );

    virtual void reset();

    virtual void setParentSection( QgsAbstractReportSection *parentSection );

    virtual void reloadSettings();


  protected:

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

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


};



/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgsreportsectionfieldgroup.h                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/