File: qgsannotationpointtextitem.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 (168 lines) | stat: -rw-r--r-- 4,806 bytes parent folder | download | duplicates (12)
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
163
164
165
166
167
168
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/annotations/qgsannotationpointtextitem.h                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsAnnotationPointTextItem : QgsAnnotationItem
{
%Docstring(signature="appended")
An annotation item which renders a text string at a point location.

.. versionadded:: 3.16
%End

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

    QgsAnnotationPointTextItem( const QString &text, QgsPointXY point );
%Docstring
Constructor for QgsAnnotationPointTextItem, containing the specified
``text`` at the specified ``point``.
%End
    ~QgsAnnotationPointTextItem();

    virtual Qgis::AnnotationItemFlags flags() const;

    virtual QString type() const;

    virtual void render( QgsRenderContext &context, QgsFeedback *feedback );

    virtual bool writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;


    static QgsAnnotationPointTextItem *create() /Factory/;
%Docstring
Creates a new text at point annotation item.
%End

    virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );

    virtual QgsAnnotationPointTextItem *clone() const /Factory/;

    virtual QgsRectangle boundingBox() const;

    virtual QgsRectangle boundingBox( QgsRenderContext &context ) const;

    virtual QList< QgsAnnotationItemNode > nodesV2( const QgsAnnotationItemEditContext &context ) const;

    virtual Qgis::AnnotationItemEditOperationResult applyEditV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context );

    virtual QgsAnnotationItemEditOperationTransientResults *transientEditResultsV2( QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context ) /Factory/;


    QgsPointXY point() const;
%Docstring
Returns the point location of the text.

The coordinate reference system for the point will be the parent layer's
:py:func:`QgsAnnotationLayer.crs()`.

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

    void setPoint( QgsPointXY point );
%Docstring
Sets the ``point`` location of the text.

The coordinate reference system for the point will be the parent layer's
:py:func:`QgsAnnotationLayer.crs()`.

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

    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

    double angle() const;
%Docstring
Returns the text's rotation angle, in degrees clockwise.

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

    void setAngle( double angle );
%Docstring
Sets the text's rotation ``angle``, in degrees clockwise.

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

    Qt::Alignment alignment() const;
%Docstring
Returns the text's alignment relative to the reference
:py:func:`~QgsAnnotationPointTextItem.point`.

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

    void setAlignment( Qt::Alignment alignment );
%Docstring
Sets the text's ``alignment`` relative to the reference
:py:func:`~QgsAnnotationPointTextItem.point`.

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

    Qgis::SymbolRotationMode rotationMode() const;
%Docstring
Returns the rotation mode for the text item.

.. seealso:: :py:func:`setRotationMode`

.. versionadded:: 3.32
%End

    void setRotationMode( Qgis::SymbolRotationMode mode );
%Docstring
Sets the rotation ``mode`` for the text item.

.. seealso:: :py:func:`rotationMode`

.. versionadded:: 3.32
%End

  private:
    QgsAnnotationPointTextItem( const QgsAnnotationPointTextItem &other );
};

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