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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationrectangletextitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsAnnotationRectangleTextItem : QgsAnnotationRectItem
{
%Docstring(signature="appended")
An annotation item which renders paragraphs of text within a rectangle.
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsannotationrectangletextitem.h"
%End
public:
QgsAnnotationRectangleTextItem( const QString &text, const QgsRectangle &bounds );
%Docstring
Constructor for QgsAnnotationRectangleTextItem, containing the specified
``text`` within the specified ``bounds`` rectangle.
%End
~QgsAnnotationRectangleTextItem();
virtual QString type() const;
virtual Qgis::AnnotationItemFlags flags() const;
virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
static QgsAnnotationRectangleTextItem *create() /Factory/;
%Docstring
Creates a new rectangle text annotation item.
%End
virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
virtual QgsAnnotationRectangleTextItem *clone() const /Factory/;
QString text() const;
%Docstring
Returns the text rendered by the item.
.. seealso:: :py:func:`setText`
%End
void setText( const QString &text );
%Docstring
Sets the ``text`` rendered by the item.
.. seealso:: :py:func:`text`
%End
QgsTextFormat format() const;
%Docstring
Returns the text format used to render the text.
.. seealso:: :py:func:`setFormat`
%End
void setFormat( const QgsTextFormat &format );
%Docstring
Sets the text ``format`` used to render the text.
.. seealso:: :py:func:`format`
%End
Qt::Alignment alignment() const;
%Docstring
Returns the text's alignment relative to the
:py:func:`~QgsAnnotationRectangleTextItem.bounds` rectangle.
.. seealso:: :py:func:`setAlignment`
%End
void setAlignment( Qt::Alignment alignment );
%Docstring
Sets the text's ``alignment`` relative to the
:py:func:`~QgsAnnotationRectangleTextItem.bounds` rectangle.
.. seealso:: :py:func:`alignment`
%End
const QgsMargins &margins() const;
%Docstring
Returns the margins between the outside of the item's frame and the
interior text.
Units are retrieved via
:py:func:`~QgsAnnotationRectangleTextItem.marginsUnit`
.. seealso:: :py:func:`setMargins`
.. seealso:: :py:func:`marginsUnit`
%End
void setMargins( const QgsMargins &margins );
%Docstring
Sets the ``margins`` between the outside of the item's frame and the
interior text.
Units are set via
:py:func:`~QgsAnnotationRectangleTextItem.setMarginsUnit`
.. seealso:: :py:func:`margins`
.. seealso:: :py:func:`setMarginsUnit`
%End
void setMarginsUnit( Qgis::RenderUnit unit );
%Docstring
Sets the ``unit`` for the margins between the item's frame and the
interior text.
.. seealso:: :py:func:`margins`
.. seealso:: :py:func:`marginsUnit`
%End
Qgis::RenderUnit marginsUnit() const;
%Docstring
Returns the units for the margins between the item's frame and the
interior text.
.. seealso:: :py:func:`setMarginsUnit`
.. seealso:: :py:func:`margins`
%End
protected:
virtual void renderInBounds( QgsRenderContext &context, const QRectF &painterBounds, QgsFeedback *feedback );
private:
QgsAnnotationRectangleTextItem( const QgsAnnotationRectangleTextItem &other );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/annotations/qgsannotationrectangletextitem.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
