-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgslayoutmeasurement.sip.in
107 lines (74 loc) · 3.06 KB
/
qgslayoutmeasurement.sip.in
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/qgslayoutmeasurement.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutMeasurement
{
%Docstring
This class provides a method of storing measurements for use in QGIS layouts
using a variety of different measurement units.
.. seealso:: :py:class:`QgsLayoutMeasurementConverter`
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutmeasurement.h"
%End
public:
explicit QgsLayoutMeasurement( const double length, const QgsUnitTypes::LayoutUnit units = QgsUnitTypes::LayoutMillimeters );
%Docstring
Constructor for QgsLayoutMeasurement.
:param length: measurement length
:param units: measurement units
%End
double length() const;
%Docstring
Returns the length of the measurement.
.. seealso:: :py:func:`setLength`
%End
void setLength( const double length );
%Docstring
Sets the ``length`` of the measurement.
.. seealso:: :py:func:`length`
%End
QgsUnitTypes::LayoutUnit units() const;
%Docstring
Returns the units for the measurement.
.. seealso:: :py:func:`setUnits`
%End
void setUnits( const QgsUnitTypes::LayoutUnit units );
%Docstring
Sets the ``units`` for the measurement. Does not alter the stored length,
ie. no length conversion is done.
.. seealso:: :py:func:`units`
%End
QString encodeMeasurement() const;
%Docstring
Encodes the layout measurement to a string
.. seealso:: :py:func:`decodeMeasurement`
%End
static QgsLayoutMeasurement decodeMeasurement( const QString &string );
%Docstring
Decodes a measurement from a ``string``.
.. seealso:: :py:func:`encodeMeasurement`
%End
bool operator==( const QgsLayoutMeasurement &other ) const;
bool operator!=( const QgsLayoutMeasurement &other ) const;
QgsLayoutMeasurement operator+( const double v ) const;
QgsLayoutMeasurement operator+=( const double v );
QgsLayoutMeasurement operator-( const double v ) const;
QgsLayoutMeasurement operator-=( const double v );
QgsLayoutMeasurement operator*( const double v ) const;
QgsLayoutMeasurement operator*=( const double v );
QgsLayoutMeasurement operator/( const double v ) const;
QgsLayoutMeasurement operator/=( const double v );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutmeasurement.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/