File: qgsreport.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 (77 lines) | stat: -rw-r--r-- 2,601 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgsreport.h                                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsReport : QObject, QgsAbstractReportSection, QgsMasterLayoutInterface
{
%Docstring(signature="appended")
Represents a report for use with the :py:class:`QgsLayout` engine.

Reports consist of multiple sections, represented by
:py:class:`QgsAbstractReportSection` subclasses.

.. 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 "qgsreport.h"
%End
  public:

    QgsReport( QgsProject *project );
%Docstring
Constructor for QgsReport, associated with the specified ``project``.

Note that ownership is not transferred to ``project``.
%End

    virtual QgsMasterLayoutInterface::Type layoutType() const;

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

    virtual QgsProject *layoutProject() const;
    virtual QgsReport *clone() const /Factory/;

    virtual QString name() const;
    virtual void setName( const QString &name );

    virtual QDomElement writeLayoutXml( QDomDocument &document, const QgsReadWriteContext &context ) const;

    virtual bool readLayoutXml( const QDomElement &layoutElement, const QDomDocument &document, const QgsReadWriteContext &context );

    virtual void updateSettings();

    virtual bool layoutAccept( QgsStyleEntityVisitorInterface *visitor ) const;


  signals:

    void nameChanged( const QString &name );
%Docstring
Emitted when the report's name is changed.

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

};


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