File: qgsscalerangewidget.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; 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: 161
file content (133 lines) | stat: -rw-r--r-- 4,620 bytes parent folder | download | duplicates (12)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsscalerangewidget.h                                        *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsScaleRangeWidget : QWidget
{
%Docstring(signature="appended")
A widget allowing entry of a range of map scales, e.g. minimum scale and
maximum scale.
%End

%TypeHeaderCode
#include "qgsscalerangewidget.h"
%End
  public:
    explicit QgsScaleRangeWidget( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsScaleRangeWidget.
%End

    void setMapCanvas( QgsMapCanvas *canvas );
%Docstring
Sets the map ``canvas`` which will be used for the current scale
buttons. If not set, the buttons are hidden.
%End

    double minimumScale() const;
%Docstring
Returns the selected minimum scale (i.e. most "zoomed out" scale), or 0
if minimum scale is not set. The scale value indicates the scale
denominator, e.g. 1000.0 for a 1:1000 map.

.. seealso:: :py:func:`maximumScale`

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

    double maximumScale() const;
%Docstring
Returns the selected maximum scale (i.e. most "zoomed in" scale), or 0
if maximum scale is not set. The scale value indicates the scale
denominator, e.g. 1000.0 for a 1:1000 map.

.. seealso:: :py:func:`minimumScale`

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

    void reloadProjectScales();
%Docstring
Call to reload the preset scales from the current project and apply them
to the 2 scales combo boxes.
%End

  public slots:

    void setMinimumScale( double scale );
%Docstring
Set the minimum ``scale`` (i.e. most "zoomed out" scale), or 0 to
indicate the minimum is not set. The scale value indicates the scale
denominator, e.g. 1000.0 for a 1:1000 map.

.. seealso:: :py:func:`minimumScale`

.. seealso:: :py:func:`setMaximumScale`

.. seealso:: :py:func:`setScaleRange`

.. warning::

   Calling :py:func:`~QgsScaleRangeWidget.setMinimumScale` places a restriction on the acceptable maximum scale for the
   widget, and will alter any previously set maximum scale to pass this constraint. Always
   call :py:func:`~QgsScaleRangeWidget.setMinimumScale` before :py:func:`~QgsScaleRangeWidget.setMaximumScale` when restoring a scale range in the widget, or
   use the convenience method :py:func:`~QgsScaleRangeWidget.setScaleRange` instead.
%End

    void setMaximumScale( double scale );
%Docstring
Set the maximum ``scale`` (i.e. most "zoomed in" scale), or 0 to
indicate the minimum is not set. The scale value indicates the scale
denominator, e.g. 1000.0 for a 1:1000 map.

.. seealso:: :py:func:`maximumScale`

.. seealso:: :py:func:`setMinimumScale`

.. seealso:: :py:func:`setScaleRange`

.. warning::

   Calling :py:func:`~QgsScaleRangeWidget.setMinimumScale` places a restriction on the acceptable maximum scale for the
   widget, and will alter any previously set maximum scale to pass this constraint. Always
   call :py:func:`~QgsScaleRangeWidget.setMinimumScale` before :py:func:`~QgsScaleRangeWidget.setMaximumScale` when restoring a scale range in the widget, or
   use the convenience method :py:func:`~QgsScaleRangeWidget.setScaleRange` instead.
%End

    void setScaleRange( double min, double max );
%Docstring
Sets the scale range, from ``min`` scale (i.e. most "zoomed out" scale)
to ``max`` scale (most "zoomed in" scale). The scale values indicates
the scale denominator, e.g. 1000.0 for a 1:1000 map, or 0 to indicate
not set.

.. seealso:: :py:func:`setMinimumScale`

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

  signals:

    void rangeChanged( double min, double max );
%Docstring
Emitted when the scale range set in the widget is changed. The scale
values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map, or
0 to indicate not set.
%End

};

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