|
| 1 | +/************************************************************************ |
| 2 | + * This file has been generated automatically from * |
| 3 | + * * |
| 4 | + * src/gui/raster/qgsrasterminmaxwidget.h * |
| 5 | + * * |
| 6 | + * Do not edit manually ! Edit header and run scripts/sipify.pl again * |
| 7 | + ************************************************************************/ |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | + |
1 | 14 | class QgsRasterMinMaxWidget: QWidget
|
2 | 15 | {
|
| 16 | + |
3 | 17 | %TypeHeaderCode
|
4 |
| -#include <qgsrasterminmaxwidget.h> |
| 18 | +#include "qgsrasterminmaxwidget.h" |
5 | 19 | %End
|
6 | 20 | public:
|
7 | 21 | QgsRasterMinMaxWidget( QgsRasterLayer *layer, QWidget *parent /TransferThis/ = 0 );
|
8 |
| - ~QgsRasterMinMaxWidget(); |
9 | 22 |
|
10 |
| - /** Sets the extent to use for minimum and maximum value calculation. |
11 |
| - * @param extent extent in raster layer's CRS |
12 |
| - * @note if a map canvas is set using setMapCanvas(), its extent will take |
13 |
| - * precedence over any extent set using this method. |
14 |
| - */ |
15 | 23 | void setExtent( const QgsRectangle &extent );
|
| 24 | +%Docstring |
| 25 | + Sets the extent to use for minimum and maximum value calculation. |
| 26 | + \param extent extent in raster layer's CRS |
| 27 | +.. note:: |
| 28 | + |
| 29 | + if a map canvas is set using setMapCanvas(), its extent will take |
| 30 | + precedence over any extent set using this method. |
| 31 | +%End |
16 | 32 |
|
17 |
| - /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current |
18 |
| - * map extent from the canvas. If a canvas is set it will take precedence over any extent |
19 |
| - * set from calling setExtent(). |
20 |
| - * @param canvas map canvas |
21 |
| - * @see mapCanvas() |
22 |
| - * @note added in QGIS 2.16 |
23 |
| - */ |
24 | 33 | void setMapCanvas( QgsMapCanvas *canvas );
|
| 34 | +%Docstring |
| 35 | + Sets the map canvas associated with the widget. This allows the widget to retrieve the current |
| 36 | + map extent from the canvas. If a canvas is set it will take precedence over any extent |
| 37 | + set from calling setExtent(). |
| 38 | + \param canvas map canvas |
| 39 | +.. seealso:: mapCanvas() |
| 40 | +.. versionadded:: 2.16 |
| 41 | +%End |
25 | 42 |
|
26 |
| - /** Returns the map canvas associated with the widget. |
27 |
| - * @see setMapCanvas() |
28 |
| - * @see canvasExtent() |
29 |
| - * @note added in QGIS 2.16 |
30 |
| - */ |
31 | 43 | QgsMapCanvas *mapCanvas();
|
| 44 | +%Docstring |
| 45 | + Returns the map canvas associated with the widget. |
| 46 | +.. seealso:: setMapCanvas() |
| 47 | +.. seealso:: canvasExtent() |
| 48 | +.. versionadded:: 2.16 |
| 49 | + :rtype: QgsMapCanvas |
| 50 | +%End |
32 | 51 |
|
33 | 52 | void setBands( const QList<int> &bands );
|
34 |
| - /** Return the extent selected by the user. |
35 |
| - Either an empty extent for 'full' or the current visible extent. */ |
| 53 | + |
36 | 54 | QgsRectangle extent();
|
37 |
| - /** Return the selected sample size. */ |
| 55 | +%Docstring |
| 56 | + Return the extent selected by the user. |
| 57 | + Either an empty extent for 'full' or the current visible extent. |
| 58 | + :rtype: QgsRectangle |
| 59 | +%End |
| 60 | + |
38 | 61 | int sampleSize();
|
| 62 | +%Docstring |
| 63 | +Return the selected sample size. |
| 64 | + :rtype: int |
| 65 | +%End |
39 | 66 |
|
40 |
| - //! \brief Set the "source" of min/max values. |
41 |
| - void setFromMinMaxOrigin( const QgsRasterMinMaxOrigin& ); |
| 67 | + void setFromMinMaxOrigin( const QgsRasterMinMaxOrigin & ); |
| 68 | +%Docstring |
| 69 | + Set the "source" of min/max values. |
| 70 | +%End |
42 | 71 |
|
43 |
| - //! \brief Return a QgsRasterMinMaxOrigin object with the widget values. |
44 | 72 | QgsRasterMinMaxOrigin minMaxOrigin();
|
| 73 | +%Docstring |
| 74 | + Return a QgsRasterMinMaxOrigin object with the widget values. |
| 75 | + :rtype: QgsRasterMinMaxOrigin |
| 76 | +%End |
45 | 77 |
|
46 |
| - //! Hide updated extent radio button |
47 | 78 | void hideUpdatedExtent();
|
| 79 | +%Docstring |
| 80 | +Hide updated extent choice |
| 81 | +%End |
48 | 82 |
|
49 |
| - //! Load programmatically with current values |
50 | 83 | void doComputations();
|
| 84 | +%Docstring |
| 85 | +Load programmatically with current values |
| 86 | +%End |
51 | 87 |
|
52 |
| - //! Uncheck cumulative cut, min/max, std-dev radio buttons |
53 | 88 | void userHasSetManualMinMaxValues();
|
| 89 | +%Docstring |
| 90 | +Uncheck cumulative cut, min/max, std-dev radio buttons |
| 91 | +%End |
54 | 92 |
|
55 |
| - //! Return if the widget is collaped. |
56 | 93 | bool isCollapsed() const;
|
| 94 | +%Docstring |
| 95 | +Return if the widget is collaped. |
| 96 | + :rtype: bool |
| 97 | +%End |
57 | 98 |
|
58 |
| - //! Set collapsed state of widget |
59 |
| - void setCollapsed(bool b); |
| 99 | + void setCollapsed( bool b ); |
| 100 | +%Docstring |
| 101 | +Set collapsed state of widget |
| 102 | +%End |
60 | 103 |
|
61 | 104 | signals:
|
62 |
| - /** |
63 |
| - * Emitted when something on the widget has changed. |
64 |
| - * All widgets will fire this event to notify of an internal change. |
65 |
| - */ |
| 105 | + |
66 | 106 | void widgetChanged();
|
| 107 | +%Docstring |
| 108 | + Emitted when something on the widget has changed. |
| 109 | + All widgets will fire this event to notify of an internal change. |
| 110 | +%End |
67 | 111 |
|
68 |
| - //! signal emitted when new min/max values are computed from statistics. |
69 | 112 | void load( int bandNo, double min, double max );
|
| 113 | +%Docstring |
| 114 | +signal emitted when new min/max values are computed from statistics. |
| 115 | +%End |
| 116 | + |
70 | 117 | };
|
| 118 | + |
| 119 | +/************************************************************************ |
| 120 | + * This file has been generated automatically from * |
| 121 | + * * |
| 122 | + * src/gui/raster/qgsrasterminmaxwidget.h * |
| 123 | + * * |
| 124 | + * Do not edit manually ! Edit header and run scripts/sipify.pl again * |
| 125 | + ************************************************************************/ |
0 commit comments