|
| 1 | +/************************************************************************ |
| 2 | + * This file has been generated automatically from * |
| 3 | + * * |
| 4 | + * src/gui/qgsscalecombobox.h * |
| 5 | + * * |
| 6 | + * Do not edit manually ! Edit header and run scripts/sipify.pl again * |
| 7 | + ************************************************************************/ |
| 8 | + |
| 9 | + |
| 10 | + |
1 | 11 |
|
2 | | -/** A combobox which lets the user select map scale from predefined list |
3 | | - * and highlights nearest to current scale value |
4 | | - */ |
5 | 12 | class QgsScaleComboBox : QComboBox |
6 | 13 | { |
7 | | -%TypeHeaderCode |
8 | | -#include <qgsscalecombobox.h> |
| 14 | +%Docstring |
| 15 | + A combobox which lets the user select map scale from predefined list |
| 16 | + and highlights nearest to current scale value |
| 17 | +* |
9 | 18 | %End |
10 | 19 |
|
| 20 | +%TypeHeaderCode |
| 21 | +#include "qgsscalecombobox.h" |
| 22 | +%End |
11 | 23 | public: |
12 | | - QgsScaleComboBox( QWidget* parent /TransferThis/ = 0 ); |
13 | | - ~QgsScaleComboBox(); |
| 24 | + QgsScaleComboBox( QWidget *parent /TransferThis/ = 0 ); |
14 | 25 |
|
15 | | - //! Function to read the selected scale as text |
16 | 26 | QString scaleString(); |
17 | | - //! Function to set the selected scale from text |
18 | | - bool setScaleString( const QString& scaleTxt ); |
19 | | - //! Function to read the selected scale as double |
| 27 | +%Docstring |
| 28 | +Function to read the selected scale as text |
| 29 | + :rtype: str |
| 30 | +%End |
| 31 | + bool setScaleString( const QString &scaleTxt ); |
| 32 | +%Docstring |
| 33 | +Function to set the selected scale from text |
| 34 | + :rtype: bool |
| 35 | +%End |
20 | 36 | double scale() const; |
21 | | - //! Function to set the selected scale from double |
| 37 | +%Docstring |
| 38 | +Function to read the selected scale as double |
| 39 | + :rtype: float |
| 40 | +%End |
22 | 41 | void setScale( double scale ); |
23 | | - //! Function to read the min scale |
| 42 | +%Docstring |
| 43 | +Function to set the selected scale from double |
| 44 | +%End |
24 | 45 | double minScale() const; |
| 46 | +%Docstring |
| 47 | +Function to read the min scale |
| 48 | + :rtype: float |
| 49 | +%End |
25 | 50 |
|
26 | | - //! Helper function to convert a double to scale string |
27 | | - // Performs rounding, so an exact representation is not to |
28 | | - // be expected. |
29 | 51 | static QString toString( double scale ); |
30 | | - //! Helper function to convert a scale string to double |
31 | | - static double toDouble( const QString& scaleString, bool *ok = 0 ); |
| 52 | +%Docstring |
| 53 | + :rtype: str |
| 54 | +%End |
| 55 | + static double toDouble( const QString &scaleString, bool *ok = 0 ); |
| 56 | +%Docstring |
| 57 | +Helper function to convert a scale string to double |
| 58 | + :rtype: float |
| 59 | +%End |
32 | 60 |
|
33 | 61 | signals: |
34 | | - //! Signal is emitted when *user* has finished editing/selecting a new scale. |
35 | 62 | void scaleChanged( double scale ); |
| 63 | +%Docstring |
| 64 | +Signal is emitted when *user* has finished editing/selecting a new scale. |
| 65 | +%End |
36 | 66 |
|
37 | 67 | public slots: |
38 | 68 | void updateScales( const QStringList &scales = QStringList() ); |
39 | | - //! Function to set the min scale |
| 69 | + |
40 | 70 | void setMinScale( double scale ); |
| 71 | +%Docstring |
| 72 | + Set the minimum allowed scale. |
| 73 | + Anything scale lower than the minimum scale will automatically |
| 74 | + be converted to the minimum scale. |
| 75 | + Except for 0 which is always allowed. |
| 76 | +%End |
41 | 77 |
|
42 | 78 | protected: |
43 | | - void showPopup(); |
| 79 | + virtual void showPopup(); |
| 80 | + |
| 81 | + |
44 | 82 | }; |
45 | 83 |
|
| 84 | +/************************************************************************ |
| 85 | + * This file has been generated automatically from * |
| 86 | + * * |
| 87 | + * src/gui/qgsscalecombobox.h * |
| 88 | + * * |
| 89 | + * Do not edit manually ! Edit header and run scripts/sipify.pl again * |
| 90 | + ************************************************************************/ |
0 commit comments