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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutframe.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsLayoutFrame: QgsLayoutItem
{
%Docstring(signature="appended")
Base class for frame items, which form a layout multiframe item.
%End
%TypeHeaderCode
#include "qgslayoutframe.h"
%End
public:
QgsLayoutFrame( QgsLayout *layout, QgsLayoutMultiFrame *multiFrame );
%Docstring
Constructor for QgsLayoutFrame, with the specified parent ``layout`` and
belonging to a ``multiFrame``.
%End
~QgsLayoutFrame();
static QgsLayoutFrame *create( QgsLayout *layout ) /Factory/;
%Docstring
Creates a new QgsLayoutFrame belonging to the specified ``layout``.
%End
virtual int type() const;
virtual QIcon icon() const;
virtual QString displayName() const;
virtual void cleanup();
void setContentSection( const QRectF §ion );
%Docstring
Sets the visible part of the multiframe's content which is visible
within this frame (relative to the total multiframe extent in layout
units).
.. seealso:: :py:func:`extent`
%End
QgsLayoutMultiFrame *multiFrame() const;
%Docstring
Returns the parent multiframe for the frame.
%End
virtual QgsLayoutSize minimumSize() const;
virtual QgsLayoutSize fixedSize() const;
QRectF extent() const;
%Docstring
Returns the visible portion of the multi frame's content which is shown
in this frame, in layout units.
.. seealso:: :py:func:`setContentSection`
%End
bool hidePageIfEmpty() const;
%Docstring
Returns whether the page should be hidden (ie, not included in layout
exports) if this frame is empty
:return: ``True`` if page should be hidden if frame is empty
.. seealso:: :py:func:`setHidePageIfEmpty`
%End
void setHidePageIfEmpty( bool hidePageIfEmpty );
%Docstring
Sets whether the page should be hidden (ie, not included in layout
exports) if this frame is empty
:param hidePageIfEmpty: set to ``True`` if page should be hidden if
frame is empty
.. seealso:: :py:func:`hidePageIfEmpty`
%End
bool hideBackgroundIfEmpty() const;
%Docstring
Returns whether the background and frame stroke should be hidden if this
frame is empty
:return: ``True`` if background and stroke should be hidden if frame is
empty
.. seealso:: :py:func:`setHideBackgroundIfEmpty`
%End
void setHideBackgroundIfEmpty( bool hideBackgroundIfEmpty );
%Docstring
Sets whether the background and frame stroke should be hidden if this
frame is empty
:param hideBackgroundIfEmpty: set to ``True`` if background and stroke
should be hidden if frame is empty
.. seealso:: :py:func:`hideBackgroundIfEmpty`
%End
bool isEmpty() const;
%Docstring
Returns whether the frame is empty.
.. seealso:: :py:func:`hidePageIfEmpty`
%End
virtual QgsExpressionContext createExpressionContext() const;
virtual ExportLayerBehavior exportLayerBehavior() const;
protected:
virtual void draw( QgsLayoutItemRenderContext &context );
virtual void drawFrame( QgsRenderContext &context );
virtual void drawBackground( QgsRenderContext &context );
virtual bool writePropertiesToElement( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context ) const;
virtual bool readPropertiesFromElement( const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutframe.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
