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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutnortharrowhandler.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsLayoutNorthArrowHandler: QObject
{
%Docstring(signature="appended")
An object which handles north-arrow type behavior for layout items.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgslayoutnortharrowhandler.h"
%End
public:
enum NorthMode /BaseType=IntEnum/
{
GridNorth,
TrueNorth,
};
QgsLayoutNorthArrowHandler( QObject *parent /TransferThis/ );
%Docstring
Constructor for QgsLayoutNorthArrowHandler, with the specified parent
``object``.
%End
double arrowRotation() const;
%Docstring
Returns the rotation to be used for the arrow, in degrees clockwise.
%End
void setLinkedMap( QgsLayoutItemMap *map );
%Docstring
Sets the linked ``map`` item.
.. seealso:: :py:func:`linkedMap`
%End
QgsLayoutItemMap *linkedMap() const;
%Docstring
Returns the linked rotation map, if set. An ``None`` means arrow
calculation is disabled.
.. seealso:: :py:func:`setLinkedMap`
%End
NorthMode northMode() const;
%Docstring
Returns the mode used to calculate the arrow rotation.
.. seealso:: :py:func:`setNorthMode`
.. seealso:: :py:func:`northOffset`
%End
void setNorthMode( NorthMode mode );
%Docstring
Sets the ``mode`` used to calculate the arrow rotation.
.. seealso:: :py:func:`northMode`
.. seealso:: :py:func:`setNorthOffset`
%End
double northOffset() const;
%Docstring
Returns the offset added to the arrows's rotation from a map's North.
.. seealso:: :py:func:`setNorthOffset`
.. seealso:: :py:func:`northMode`
%End
void setNorthOffset( double offset );
%Docstring
Sets the ``offset`` added to the arrows's rotation from a map's North.
.. seealso:: :py:func:`northOffset`
.. seealso:: :py:func:`setNorthMode`
%End
signals:
void arrowRotationChanged( double newRotation );
%Docstring
Emitted on arrow rotation change
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutnortharrowhandler.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
