File: qgsreportsectionlayout.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (110 lines) | stat: -rw-r--r-- 3,138 bytes parent folder | download | duplicates (14)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgsreportsectionlayout.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsReportSectionLayout : QgsAbstractReportSection
{
%Docstring(signature="appended")
A report section consisting of a single :py:class:`QgsLayout` body.

.. 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.
%End

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

    QgsReportSectionLayout( QgsAbstractReportSection *parentSection = 0 );
%Docstring
Constructor for QgsReportSectionLayout, 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

    virtual QgsReportSectionLayout *clone() const /Factory/;

    virtual bool beginRender();

    virtual QgsLayout *nextBody( bool &ok );

    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/qgsreportsectionlayout.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/