1/************************************************************************
2 * This file has been generated automatically from                      *
3 *                                                                      *
4 * src/core/layout/qgsreportsectionfieldgroup.h                         *
5 *                                                                      *
6 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
7 ************************************************************************/
8
9
10
11
12
13class QgsReportSectionFieldGroup : QgsAbstractReportSection
14{
15%Docstring(signature="appended")
16A report section consisting of a features
17
18.. warning::
19
20   This is not considered stable API, and may change in future QGIS releases. It is
21   exposed to the Python bindings for unit testing purposes only.
22
23.. versionadded:: 3.0
24%End
25
26%TypeHeaderCode
27#include "qgsreportsectionfieldgroup.h"
28%End
29  public:
30
31    enum SectionVisibility
32    {
33      IncludeWhenFeaturesFound,
34      AlwaysInclude
35    };
36
37    QgsReportSectionFieldGroup( QgsAbstractReportSection *parentSection = 0 );
38%Docstring
39Constructor for QgsReportSectionFieldGroup, attached to the specified ``parent`` section.
40Note that ownership is not transferred to ``parent``.
41%End
42
43    virtual QString type() const;
44    virtual QString description() const;
45
46    virtual QIcon icon() const;
47
48
49    QgsLayout *body();
50%Docstring
51Returns the body layout for the section.
52
53.. seealso:: :py:func:`setBody`
54
55.. seealso:: :py:func:`bodyEnabled`
56
57.. seealso:: :py:func:`setBodyEnabled`
58%End
59
60    void setBody( QgsLayout *body /Transfer/ );
61%Docstring
62Sets the ``body`` layout for the section. Ownership of ``body``
63is transferred to the report section.
64
65.. seealso:: :py:func:`body`
66
67.. seealso:: :py:func:`bodyEnabled`
68
69.. seealso:: :py:func:`setBodyEnabled`
70%End
71
72    bool bodyEnabled() const;
73%Docstring
74Returns ``True`` if the body for the section is enabled.
75
76.. seealso:: :py:func:`setBodyEnabled`
77
78.. seealso:: :py:func:`body`
79
80.. seealso:: :py:func:`setBody`
81%End
82
83    void setBodyEnabled( bool enabled );
84%Docstring
85Sets whether the body for the section is ``enabled``.
86
87.. seealso:: :py:func:`bodyEnabled`
88
89.. seealso:: :py:func:`body`
90
91.. seealso:: :py:func:`setBody`
92%End
93
94
95    QgsVectorLayer *layer();
96%Docstring
97Returns the vector layer associated with this section.
98
99.. seealso:: :py:func:`setLayer`
100%End
101
102    void setLayer( QgsVectorLayer *layer );
103%Docstring
104Sets the vector ``layer`` associated with this section.
105
106.. seealso:: :py:func:`layer`
107%End
108
109    QString field() const;
110%Docstring
111Returns the field associated with this section.
112
113.. seealso:: :py:func:`setField`
114%End
115
116    void setField( const QString &field );
117%Docstring
118Sets the ``field`` associated with this section.
119
120.. seealso:: :py:func:`field`
121%End
122
123    bool sortAscending() const;
124%Docstring
125Returns ``True`` if the field values should be sorted ascending,
126or ``False`` for descending sort.
127
128.. seealso:: :py:func:`setSortAscending`
129%End
130
131    void setSortAscending( bool sortAscending );
132%Docstring
133Sets whether the field values should be sorted ascending. Set to ``True`` to sort
134ascending, or ``False`` for descending sort.
135
136.. seealso:: :py:func:`sortAscending`
137%End
138
139    SectionVisibility headerVisibility() const;
140%Docstring
141Returns the header visibility mode.
142
143.. seealso:: :py:func:`setHeaderVisibility`
144%End
145
146    void setHeaderVisibility( SectionVisibility visibility );
147%Docstring
148Sets the visibility mode for the header.
149
150.. seealso:: :py:func:`headerVisibility`
151%End
152
153    SectionVisibility footerVisibility() const;
154%Docstring
155Returns the footer visibility mode.
156
157.. seealso:: :py:func:`setFooterVisibility`
158%End
159
160    void setFooterVisibility( SectionVisibility visibility );
161%Docstring
162Sets the visibility mode for the footer.
163
164.. seealso:: :py:func:`footerVisibility`
165%End
166
167    virtual QgsReportSectionFieldGroup *clone() const /Factory/;
168
169    virtual bool beginRender();
170
171    virtual bool prepareHeader();
172
173    virtual bool prepareFooter();
174
175    virtual QgsLayout *nextBody( bool &ok );
176
177    virtual void reset();
178
179    virtual void setParentSection( QgsAbstractReportSection *parentSection );
180
181    virtual void reloadSettings();
182
183
184  protected:
185
186    virtual bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
187
188    virtual bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context );
189
190
191};
192
193
194
195/************************************************************************
196 * This file has been generated automatically from                      *
197 *                                                                      *
198 * src/core/layout/qgsreportsectionfieldgroup.h                         *
199 *                                                                      *
200 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
201 ************************************************************************/
202