sipify

qgis · May 31, 2017 · 6eb3570511652069934ed97881c73b9381afb41c · 6eb3570
1 parent 52a8be6
commit 6eb3570511652069934ed97881c73b9381afb41c
Unified Split

Showing with 210 additions and 67 deletions.

+0 −3 python/auto_sip.blacklist

+46 −11 python/gui/raster/qgsmultibandcolorrendererwidget.sip

+91 −36 python/gui/raster/qgsrasterminmaxwidget.sip

+73 −17 python/gui/raster/qgsrasterrendererwidget.sip
diff --git a/python/auto_sip.blacklist b/python/auto_sip.blacklist
@@ -193,11 +193,8 @@ gui/layertree/qgslayertreeembeddedwidgetregistry.sip
 gui/layertree/qgslayertreemapcanvasbridge.sip
 gui/layertree/qgslayertreeview.sip
 gui/layertree/qgslayertreeviewdefaultactions.sip
-gui/raster/qgsmultibandcolorrendererwidget.sip
 gui/raster/qgspalettedrendererwidget.sip
 gui/raster/qgsrasterhistogramwidget.sip
-gui/raster/qgsrasterminmaxwidget.sip
-gui/raster/qgsrasterrendererwidget.sip
 gui/raster/qgssinglebandgrayrendererwidget.sip
 gui/raster/qgssinglebandpseudocolorrendererwidget.sip
 gui/raster/qgsrendererrasterpropertieswidget.sip

diff --git a/python/gui/raster/qgsmultibandcolorrendererwidget.sip b/python/gui/raster/qgsmultibandcolorrendererwidget.sip
@@ -1,26 +1,61 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/raster/qgsmultibandcolorrendererwidget.h                     *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
 class QgsMultiBandColorRendererWidget: QgsRasterRendererWidget
 {
+
 %TypeHeaderCode
-#include <qgsmultibandcolorrendererwidget.h>
+#include "qgsmultibandcolorrendererwidget.h"
 %End
-
   public:
     QgsMultiBandColorRendererWidget( QgsRasterLayer *layer, const QgsRectangle &extent = QgsRectangle() );
     static QgsRasterRendererWidget *create( QgsRasterLayer *layer, const QgsRectangle &extent );
-    ~QgsMultiBandColorRendererWidget();
+%Docstring
+ :rtype: QgsRasterRendererWidget
+%End
+
+    virtual QgsRasterRenderer *renderer();
+
+    virtual void setMapCanvas( QgsMapCanvas *canvas );
 
-    QgsRasterRenderer *renderer();
-    void setMapCanvas( QgsMapCanvas *canvas );
 
     void setFromRenderer( const QgsRasterRenderer *r );
 
-    QString min( int index = 0 );
-    QString max( int index = 0 );
-    void setMin( const QString &value, int index = 0 );
-    void setMax( const QString &value, int index = 0 );
-    int selectedBand( int index = 0 );
-    void doComputations();
+    virtual QString min( int index = 0 );
+
+    virtual QString max( int index = 0 );
+
+    virtual void setMin( const QString &value, int index = 0 );
+
+    virtual void setMax( const QString &value, int index = 0 );
+
+    virtual int selectedBand( int index = 0 );
+
+    virtual void doComputations();
+
+    virtual QgsRasterMinMaxWidget *minMaxWidget();
 
   public slots:
     void loadMinMax( int bandNo, double min, double max );
+%Docstring
+called when new min/max values are loaded
+%End
+
 };
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/raster/qgsmultibandcolorrendererwidget.h                     *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/python/gui/raster/qgsrasterminmaxwidget.sip b/python/gui/raster/qgsrasterminmaxwidget.sip
@@ -1,70 +1,125 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/raster/qgsrasterminmaxwidget.h                               *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+
 class QgsRasterMinMaxWidget: QWidget
 {
+
 %TypeHeaderCode
-#include <qgsrasterminmaxwidget.h>
+#include "qgsrasterminmaxwidget.h"
 %End
   public:
     QgsRasterMinMaxWidget( QgsRasterLayer *layer, QWidget *parent /TransferThis/ = 0 );
-    ~QgsRasterMinMaxWidget();
 
-    /** Sets the extent to use for minimum and maximum value calculation.
-     * @param extent extent in raster layer's CRS
-     * @note if a map canvas is set using setMapCanvas(), its extent will take
-     * precedence over any extent set using this method.
-     */
     void setExtent( const QgsRectangle &extent );
+%Docstring
+ Sets the extent to use for minimum and maximum value calculation.
+ \param extent extent in raster layer's CRS
+.. note::
+
+   if a map canvas is set using setMapCanvas(), its extent will take
+ precedence over any extent set using this method.
+%End
 
-    /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current
-     * map extent from the canvas. If a canvas is set it will take precedence over any extent
-     * set from calling setExtent().
-     * @param canvas map canvas
-     * @see mapCanvas()
-     * @note added in QGIS 2.16
-     */
     void setMapCanvas( QgsMapCanvas *canvas );
+%Docstring
+ Sets the map canvas associated with the widget. This allows the widget to retrieve the current
+ map extent from the canvas. If a canvas is set it will take precedence over any extent
+ set from calling setExtent().
+ \param canvas map canvas
+.. seealso:: mapCanvas()
+.. versionadded:: 2.16
+%End
 
-    /** Returns the map canvas associated with the widget.
-     * @see setMapCanvas()
-     * @see canvasExtent()
-     * @note added in QGIS 2.16
-     */
     QgsMapCanvas *mapCanvas();
+%Docstring
+ Returns the map canvas associated with the widget.
+.. seealso:: setMapCanvas()
+.. seealso:: canvasExtent()
+.. versionadded:: 2.16
+ :rtype: QgsMapCanvas
+%End
 
     void setBands( const QList<int> &bands );
-    /** Return the extent selected by the user.
-        Either an empty extent for 'full' or the current visible extent. */
+
     QgsRectangle extent();
-    /** Return the selected sample size. */
+%Docstring
+ Return the extent selected by the user.
+ Either an empty extent for 'full' or the current visible extent.
+ :rtype: QgsRectangle
+%End
+
     int sampleSize();
+%Docstring
+Return the selected sample size.
+ :rtype: int
+%End
 
-    //! \brief Set the "source" of min/max values.
-    void setFromMinMaxOrigin( const QgsRasterMinMaxOrigin& );
+    void setFromMinMaxOrigin( const QgsRasterMinMaxOrigin & );
+%Docstring
+ Set the "source" of min/max values.
+%End
 
-    //! \brief Return a QgsRasterMinMaxOrigin object with the widget values.
     QgsRasterMinMaxOrigin minMaxOrigin();
+%Docstring
+ Return a QgsRasterMinMaxOrigin object with the widget values.
+ :rtype: QgsRasterMinMaxOrigin
+%End
 
-    //! Hide updated extent radio button
     void hideUpdatedExtent();
+%Docstring
+Hide updated extent choice
+%End
 
-    //! Load programmatically with current values
     void doComputations();
+%Docstring
+Load programmatically with current values
+%End
 
-    //! Uncheck cumulative cut, min/max, std-dev radio buttons
     void userHasSetManualMinMaxValues();
+%Docstring
+Uncheck cumulative cut, min/max, std-dev radio buttons
+%End
 
-    //! Return if the widget is collaped.
     bool isCollapsed() const;
+%Docstring
+Return if the widget is collaped.
+ :rtype: bool
+%End
 
-    //! Set collapsed state of widget
-    void setCollapsed(bool b);
+    void setCollapsed( bool b );
+%Docstring
+Set collapsed state of widget
+%End
 
   signals:
-    /**
-     * Emitted when something on the widget has changed.
-     * All widgets will fire this event to notify of an internal change.
-     */
+
     void widgetChanged();
+%Docstring
+ Emitted when something on the widget has changed.
+ All widgets will fire this event to notify of an internal change.
+%End
 
-    //! signal emitted when new min/max values are computed from statistics.
     void load( int bandNo, double min, double max );
+%Docstring
+signal emitted when new min/max values are computed from statistics.
+%End
+
 };
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/raster/qgsrasterminmaxwidget.h                               *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/python/gui/raster/qgsrasterrendererwidget.sip b/python/gui/raster/qgsrasterrendererwidget.sip
@@ -1,47 +1,103 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/raster/qgsrasterrendererwidget.h                             *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+
 class QgsRasterRendererWidget: QWidget
 {
+
 %TypeHeaderCode
-#include <qgsrasterrendererwidget.h>
+#include "qgsrasterrendererwidget.h"
 %End
   public:
+
     QgsRasterRendererWidget( QgsRasterLayer *layer, const QgsRectangle &extent );
-    virtual ~QgsRasterRendererWidget();
 
     virtual QgsRasterRenderer *renderer() = 0 /Factory/;
+%Docstring
+ :rtype: QgsRasterRenderer
+%End
 
     void setRasterLayer( QgsRasterLayer *layer );
     const QgsRasterLayer *rasterLayer() const;
+%Docstring
+ :rtype: QgsRasterLayer
+%End
 
-    /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current
-     * map extent and other properties from the canvas.
-     * @param canvas map canvas
-     * @see mapCanvas()
-     * @note added in QGIS 2.16
-     */
     virtual void setMapCanvas( QgsMapCanvas *canvas );
+%Docstring
+ Sets the map canvas associated with the widget. This allows the widget to retrieve the current
+ map extent and other properties from the canvas.
+ \param canvas map canvas
+.. seealso:: mapCanvas()
+.. versionadded:: 2.16
+%End
 
-    /** Returns the map canvas associated with the widget.
-     * @see setMapCanvas()
-     * @see canvasExtent()
-     * @note added in QGIS 2.16
-     */
     QgsMapCanvas *mapCanvas();
+%Docstring
+ Returns the map canvas associated with the widget.
+.. seealso:: setMapCanvas()
+.. seealso:: canvasExtent()
+.. versionadded:: 2.16
+ :rtype: QgsMapCanvas
+%End
 
     virtual QString min( int index = 0 );
+%Docstring
+ :rtype: str
+%End
     virtual QString max( int index = 0 );
+%Docstring
+ :rtype: str
+%End
     virtual void setMin( const QString &value, int index = 0 );
     virtual void setMax( const QString &value, int index = 0 );
     virtual QString stdDev();
+%Docstring
+ :rtype: str
+%End
     virtual void setStdDev( const QString &value );
     virtual int selectedBand( int index = 0 );
+%Docstring
+ :rtype: int
+%End
+
     virtual void doComputations();
+%Docstring
+Load programmatically with current values
+%End
+
     virtual QgsRasterMinMaxWidget *minMaxWidget();
+%Docstring
+Return min/max widget when it exists.
+ :rtype: QgsRasterMinMaxWidget
+%End
 
   signals:
-    /**
-     * Emitted when something on the widget has changed.
-     * All widgets will fire this event to notify of an internal change.
-     */
+
     void widgetChanged();
+%Docstring
+ Emitted when something on the widget has changed.
+ All widgets will fire this event to notify of an internal change.
+%End
+
+  protected:
+
 
 };
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/raster/qgsrasterrendererwidget.h                             *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/