File: qgscalloutposition.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 (150 lines) | stat: -rw-r--r-- 4,011 bytes parent folder | download | duplicates (14)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/labeling/qgscalloutposition.h                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsCalloutPosition
{
%Docstring(signature="appended")
Represents the calculated placement of a map label callout line.

.. versionadded:: 3.20
%End

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

    QgsCalloutPosition( QgsFeatureId id, const QString &layer, const QString &providerId = QString() );
%Docstring
Constructor for QgsCalloutPosition.

:param id: associated feature ID
:param layer: ID of associated map layer
:param providerId: ID of associated label provider
%End

    QgsCalloutPosition();

    QgsFeatureId featureId;

    QString layerID;

    QString providerID;

    QPointF origin() const;
%Docstring
Returns the origin of the callout line, in map coordinates.

The origin of the callout line is the line point associated with the
label text.

.. seealso:: :py:func:`setOrigin`

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

    void setOrigin( const QPointF &origin );
%Docstring
Sets the ``origin`` of the callout line, in map coordinates.

The origin of the callout line is the line point associated with the
label text.

.. seealso:: :py:func:`origin`

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

    QPointF destination() const;
%Docstring
Returns the destination of the callout line, in map coordinates.

The destination of the callout line is the line point associated with
the feature's geometry.

.. seealso:: :py:func:`setDestination`

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

    void setDestination( const QPointF &destination );
%Docstring
Sets the ``destination`` of the callout line, in map coordinates.

The destination of the callout line is the line point associated with
the feature's geometry.

.. seealso:: :py:func:`destination`

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

    bool originIsPinned() const;
%Docstring
Returns ``True`` if the origin of the callout has pinned (manually
placed).

The origin of the callout line is the line point associated with the
label text.

.. seealso:: :py:func:`destinationIsPinned`

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

    void setOriginIsPinned( bool pinned );
%Docstring
Sets whether the origin of the callout has pinned (manually placed).

The origin of the callout line is the line point associated with the
label text.

.. seealso:: :py:func:`setDestinationIsPinned`

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

    bool destinationIsPinned() const;
%Docstring
Returns ``True`` if the destination of the callout has pinned (manually
placed).

The destination of the callout line is the line point associated with
the feature's geometry.

.. seealso:: :py:func:`originIsPinned`

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

    void setDestinationIsPinned( bool pinned );
%Docstring
Sets whether the destination of the callout has pinned (manually
placed).

The destination of the callout line is the line point associated with
the feature's geometry.

.. seealso:: :py:func:`setOriginIsPinned`

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

};

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