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
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutitempage.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutItemPage : QgsLayoutItem
{
%Docstring(signature="appended")
Item representing the paper in a layout.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutitempage.h"
%End
public:
enum Orientation
{
Portrait,
Landscape
};
enum UndoCommand
{
UndoPageSymbol,
};
explicit QgsLayoutItemPage( QgsLayout *layout );
%Docstring
Constructor for QgsLayoutItemPage, with the specified parent ``layout``.
%End
~QgsLayoutItemPage();
static QgsLayoutItemPage *create( QgsLayout *layout ) /Factory/;
%Docstring
Returns a new page item for the specified ``layout``.
The caller takes responsibility for deleting the returned object.
%End
virtual int type() const;
virtual QString displayName() const;
void setPageSize( const QgsLayoutSize &size );
%Docstring
Sets the ``size`` of the page.
.. seealso:: :py:func:`pageSize`
%End
bool setPageSize( const QString &size, Orientation orientation = Portrait );
%Docstring
Sets the page size to a known page ``size``, e.g. "A4" and ``orientation``.
The known page sizes are managed by :py:class:`QgsPageSizeRegistry`. Valid page sizes
can be retrieved via :py:func:`QgsPageSizeRegistry.entries()`.
The function returns ``True`` if ``size`` was a valid page size and the page
size was changed. If ``False`` is returned then ``size`` could not be matched
to a known page size.
.. seealso:: :py:func:`pageSize`
%End
QPageLayout pageLayout() const;
%Docstring
Returns the page layout for the page, suitable to pass to QPrinter.setPageLayout
.. versionadded:: 3.20
%End
QgsLayoutSize pageSize() const;
%Docstring
Returns the size of the page.
.. seealso:: :py:func:`setPageSize`
%End
Orientation orientation() const;
%Docstring
Returns the page orientation.
.. note::
There is no direct setter for page orientation - use :py:func:`~QgsLayoutItemPage.setPageSize` instead.
%End
void setPageStyleSymbol( QgsFillSymbol *symbol /Transfer/ );
%Docstring
Sets the ``symbol`` to use for drawing the page background.
Ownership of ``symbol`` is transferred to the page.
.. seealso:: :py:func:`pageStyleSymbol`
.. versionadded:: 3.10
%End
const QgsFillSymbol *pageStyleSymbol() const;
%Docstring
Returns the symbol to use for drawing the page background.
.. seealso:: :py:func:`setPageStyleSymbol`
.. versionadded:: 3.10
%End
static QgsLayoutItemPage::Orientation decodePageOrientation( const QString &string, bool *ok /Out/ = 0 );
%Docstring
Decodes a ``string`` representing a page orientation. If specified, ``ok``
will be set to ``True`` if string could be successfully interpreted as a
page orientation.
%End
virtual QRectF boundingRect() const;
virtual void attemptResize( const QgsLayoutSize &size, bool includesFrame = false );
virtual QgsAbstractLayoutUndoCommand *createCommand( const QString &text, int id, QUndoCommand *parent = 0 ) /Factory/;
virtual ExportLayerBehavior exportLayerBehavior() const;
virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
public slots:
virtual void redraw();
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/qgslayoutitempage.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
