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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsscaleutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsScaleUtils
{
%Docstring(signature="appended")
Contains utility functions for working with map scales.
%End
%TypeHeaderCode
#include "qgsscaleutils.h"
%End
public:
static bool saveScaleList( const QString &fileName, const QStringList &scales, QString &errorMessage );
%Docstring
Save scales to the given file
:param fileName: the name of the output file
:param scales: the list of scales to save
:param errorMessage: it will contain the error message if something went
wrong
:return: ``True`` on success and ``False`` if failed
%End
static bool loadScaleList( const QString &fileName, QStringList &scales, QString &errorMessage );
%Docstring
Load scales from the given file
:param fileName: the name of the file to process
:param scales: it will contain loaded scales
:param errorMessage: it will contain the error message if something went
wrong
:return: ``True`` on success and ``False`` if failed
%End
static bool equalToOrGreaterThanMinimumScale( const double scale, const double minScale );
%Docstring
Returns whether the ``scale`` is equal to or greater than the
``minScale``, taking non-round numbers into account.
:param scale: The current scale to be compared.
:param minScale: The minimum map scale (i.e. most "zoomed out" scale) at
which features, labels or diagrams will be visible. The
scale value indicates the scale denominator, e.g.
1000.0 for a 1:1000 map.
.. seealso:: :py:func:`lessThanMaximumScale`
.. versionadded:: 3.40
%End
static bool lessThanMaximumScale( const double scale, const double maxScale );
%Docstring
Returns whether the ``scale`` is less than the ``maxScale``, taking
non-round numbers into account.
:param scale: The current scale to be compared.
:param maxScale: The maximum map scale (i.e. most "zoomed in" scale) at
which features, labels or diagrams will be visible. The
scale value indicates the scale denominator, e.g.
1000.0 for a 1:1000 map.
.. seealso:: :py:func:`equalToOrGreaterThanMinimumScale`
.. versionadded:: 3.40
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsscaleutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
