File: qgsannotationitemeditoperation.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 (350 lines) | stat: -rw-r--r-- 8,472 bytes parent folder | download | duplicates (6)
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/annotations/qgsannotationitemeditoperation.h                *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsAnnotationItemEditContext
{
%Docstring(signature="appended")
Encapsulates the context for an annotation item edit operation.

.. versionadded:: 3.40
%End

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

    QgsAnnotationItemEditContext();

    QgsRectangle currentItemBounds() const;
%Docstring
Returns the current rendered bounds of the item, in the annotation
layer's CRS.

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

    void setCurrentItemBounds( const QgsRectangle &bounds );
%Docstring
Sets the current rendered ``bounds`` of the item, in the annotation
layer's CRS.

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

    QgsRenderContext renderContext() const;
%Docstring
Returns the render context associated with the edit operation.

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

    void setRenderContext( const QgsRenderContext &context );
%Docstring
Sets the render ``context`` associated with the edit operation.

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

};

class QgsAbstractAnnotationItemEditOperation
{
%Docstring(signature="appended")
Abstract base class for annotation item edit operations

.. versionadded:: 3.22
%End

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

    enum class Type /BaseType=IntEnum/
    {
      MoveNode,
      DeleteNode,
      AddNode,
      TranslateItem,
    };

    QgsAbstractAnnotationItemEditOperation( const QString &itemId );
%Docstring
Constructor for QgsAbstractAnnotationItemEditOperation, for the
specified item id.
%End

    virtual ~QgsAbstractAnnotationItemEditOperation();

    virtual Type type() const = 0;
%Docstring
Returns the operation type.
%End

    QString itemId() const;
%Docstring
Returns the associated item ID.
%End

  protected:


};

class QgsAnnotationItemEditOperationMoveNode : QgsAbstractAnnotationItemEditOperation
{
%Docstring(signature="appended")
Annotation item edit operation consisting of moving a node

.. versionadded:: 3.22
%End

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

    QgsAnnotationItemEditOperationMoveNode( const QString &itemId, QgsVertexId nodeId, const QgsPoint &before, const QgsPoint &after,
                                            double translatePixelsX = 0, double translatePixelsY = 0 );
%Docstring
Constructor for QgsAnnotationItemEditOperationMoveNode, where the node
with the specified ``id`` moves from ``before`` to ``after`` (in layer
coordinates).

Since QGIS 3.40 the ``translatePixelsX`` and ``translatePixelsY``
arguments specify the translation in pixels.
%End

    virtual Type type() const;


    QgsVertexId nodeId() const;
%Docstring
Returns the associated node ID.
%End

    QgsPoint before() const;
%Docstring
Returns the node position before the move occurred (in layer
coordinates).

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

    QgsPoint after() const;
%Docstring
Returns the node position after the move occurred (in layer
coordinates).

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

    double translationXPixels() const;
%Docstring
Returns the x-axis translation, in pixels.

\since
:py:func:`~QgsAnnotationItemEditOperationMoveNode.translationYPixels`

.. versionadded:: 3.40
%End

    double translationYPixels() const;
%Docstring
Returns the y-axis translation, in pixels.

\since
:py:func:`~QgsAnnotationItemEditOperationMoveNode.translationXPixels`

.. versionadded:: 3.40
%End

};


class QgsAnnotationItemEditOperationDeleteNode : QgsAbstractAnnotationItemEditOperation
{
%Docstring(signature="appended")
Annotation item edit operation consisting of deleting a node

.. versionadded:: 3.22
%End

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

    QgsAnnotationItemEditOperationDeleteNode( const QString &itemId, QgsVertexId nodeId, const QgsPoint &before );
%Docstring
Constructor for QgsAnnotationItemEditOperationDeleteNode, where the node
with the specified ``id`` and previous position ``before`` is deleted.
%End

    virtual Type type() const;


    QgsVertexId nodeId() const;
%Docstring
Returns the deleted node ID.
%End

    QgsPoint before() const;
%Docstring
Returns the node position before the delete occurred (in layer
coordinates).
%End

};

class QgsAnnotationItemEditOperationAddNode : QgsAbstractAnnotationItemEditOperation
{
%Docstring(signature="appended")
Annotation item edit operation consisting of adding a node

.. versionadded:: 3.22
%End

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

    QgsAnnotationItemEditOperationAddNode( const QString &itemId, const QgsPoint &point );
%Docstring
Constructor for QgsAnnotationItemEditOperationAddNode at the specified
``point``.
%End

    virtual Type type() const;


    QgsPoint point() const;
%Docstring
Returns the node position (in layer coordinates).
%End

};


class QgsAnnotationItemEditOperationTranslateItem : QgsAbstractAnnotationItemEditOperation
{
%Docstring(signature="appended")
Annotation item edit operation consisting of translating (moving) an
item

.. versionadded:: 3.22
%End

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

    QgsAnnotationItemEditOperationTranslateItem( const QString &itemId, double translateX, double translateY,
        double translatePixelsX = 0, double translatePixelsY = 0 );
%Docstring
Constructor for QgsAnnotationItemEditOperationTranslateItem, where the
node with the specified ``id`` and translation (in map units)

Since QGIS 3.40 the ``translatePixelsX`` and ``translatePixelsY``
arguments specify the translation in pixels.
%End

    virtual Type type() const;


    QgsVertexId nodeId() const;
%Docstring
Returns the deleted node ID.
%End

    double translationX() const;
%Docstring
Returns the x-axis translation, in layer units.

\since
:py:func:`~QgsAnnotationItemEditOperationTranslateItem.translationY`
%End

    double translationY() const;
%Docstring
Returns the y-axis translation, in layer units.

\since
:py:func:`~QgsAnnotationItemEditOperationTranslateItem.translationX`
%End

    double translationXPixels() const;
%Docstring
Returns the x-axis translation, in pixels.

\since
:py:func:`~QgsAnnotationItemEditOperationTranslateItem.translationYPixels`

.. versionadded:: 3.40
%End

    double translationYPixels() const;
%Docstring
Returns the y-axis translation, in pixels.

\since
:py:func:`~QgsAnnotationItemEditOperationTranslateItem.translationXPixels`

.. versionadded:: 3.40
%End

};

class QgsAnnotationItemEditOperationTransientResults
{
%Docstring(signature="appended")
Encapsulates the transient results of an in-progress annotation edit
operation.

.. versionadded:: 3.22
%End

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

    QgsAnnotationItemEditOperationTransientResults( const QgsGeometry &representativeGeometry );
%Docstring
Constructor for QgsAnnotationItemEditOperationTransientResults.

The ``representativeGeometry`` parameter specifies a geometry (in layer
CRS) which represents the shape of the item if the operation were to be
applied. It is used for creating a graphical representation of the
operation during interactive edits.
%End

    QgsGeometry representativeGeometry() const;
%Docstring
Returns the geometry (in layer CRS) which represents the shape of the
item if the operation were to be applied.

This is used for creating a graphical representation of the operation
during interactive edits.
%End

};

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