Update Python bindings to match changes in core/gui libraries.

qgis · Dec 5, 2013 · 2bece09 · 2bece09
1 parent 412eaf4
commit 2bece09
Show file tree

Hide file tree

Showing 68 changed files with 589 additions and 205 deletions.
diff --git a/python/core/composer/qgscomposermap.sip b/python/core/composer/qgscomposermap.sip
@@ -141,7 +141,8 @@ class QgsComposerMap : QgsComposerItem
 
     QgsRectangle extent() const;
 
-    const QgsMapRenderer* mapRenderer() const;
+    //! @deprecated since 2.1 - use mapSettings() - may return 0 if not initialized with QgsMapRenderer
+    const QgsMapRenderer* mapRenderer() const /Deprecated/;
 
     /**Sets offset values to shift image (useful for live updates when moving item content)*/
     void setOffset( double xOffset, double yOffset );

diff --git a/python/core/composer/qgscomposition.sip b/python/core/composer/qgscomposition.sip
@@ -28,7 +28,9 @@ class QgsComposition : QGraphicsScene
       Crosses
     };
 
-    QgsComposition( QgsMapRenderer* mapRenderer );
+    //! @deprecated since 2.1 - use the constructor with QgsMapSettings
+    QgsComposition( QgsMapRenderer* mapRenderer ) /Deprecated/;
+    explicit QgsComposition( const QgsMapSettings& mapSettings );
     ~QgsComposition();
 
     /**Changes size of paper item*/
@@ -151,7 +153,12 @@ class QgsComposition : QGraphicsScene
     void setWorldFileMap( QgsComposerMap* map );
 
     /**Returns pointer to map renderer of qgis map canvas*/
-    QgsMapRenderer* mapRenderer();
+    //! @deprecated since 2.1 - use mapSettings() instead. May return null if not initialized with QgsMapRenderer
+    QgsMapRenderer* mapRenderer() /Deprecated/;
+
+    //! Return setting of QGIS map canvas
+    //! @note added in 2.1
+    const QgsMapSettings& mapSettings() const;
 
     QgsComposition::PlotStyle plotStyle() const;
     void setPlotStyle( QgsComposition::PlotStyle style );
@@ -310,6 +317,10 @@ class QgsComposition : QGraphicsScene
   public slots:
     /**Casts object to the proper subclass type and calls corresponding itemAdded signal*/
     void sendItemAddedSignal( QgsComposerItem* item );
+
+  protected:
+    void init();
+
   signals:
     void paperSizeChanged();
     void nPagesChanged();

diff --git a/python/core/core.sip b/python/core/core.sip
@@ -45,7 +45,9 @@
 %Include qgslogger.sip
 %Include qgsmaplayer.sip
 %Include qgsmaplayerregistry.sip
+%Include qgsmaplayerrenderer.sip
 %Include qgsmaprenderer.sip
+%Include qgsmapsettings.sip
 %Include qgsmaptopixel.sip
 %Include qgsmessagelog.sip
 %Include qgsmessageoutput.sip

diff --git a/python/core/diagram/qgsdiagram.sip b/python/core/diagram/qgsdiagram.sip
@@ -5,6 +5,9 @@ class QgsDiagram
 %End
   public:
     virtual ~QgsDiagram();
+    /** Returns an instance that is equivalent to this one
+     * @note added in 2.1 */
+    virtual QgsDiagram* clone() const = 0;
     /**Draws the diagram at the given position (in pixel coordinates)*/
     virtual void renderDiagram( const QgsAttributes& att, QgsRenderContext& c, const QgsDiagramSettings& s, const QPointF& position ) = 0;
     virtual QString diagramName() const = 0;

diff --git a/python/core/diagram/qgshistogramdiagram.sip b/python/core/diagram/qgshistogramdiagram.sip
@@ -7,6 +7,8 @@ class QgsHistogramDiagram: QgsDiagram
     QgsHistogramDiagram();
     ~QgsHistogramDiagram();
 
+    virtual QgsDiagram* clone() const;
+
     void renderDiagram( const QgsAttributes& att, QgsRenderContext& c, const QgsDiagramSettings& s, const QPointF& position );
     QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s );
     QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s, const QgsDiagramInterpolationSettings& is );

diff --git a/python/core/diagram/qgspiediagram.sip b/python/core/diagram/qgspiediagram.sip
@@ -7,6 +7,8 @@ class QgsPieDiagram: QgsDiagram
     QgsPieDiagram();
     ~QgsPieDiagram();
 
+    virtual QgsDiagram* clone() const;
+
     void renderDiagram( const QgsAttributes& att, QgsRenderContext& c, const QgsDiagramSettings& s, const QPointF& position );
     QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s );
     QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s, const QgsDiagramInterpolationSettings& is );

diff --git a/python/core/diagram/qgstextdiagram.sip b/python/core/diagram/qgstextdiagram.sip
@@ -20,6 +20,9 @@ class QgsTextDiagram: QgsDiagram
 
     QgsTextDiagram();
     ~QgsTextDiagram();
+
+    virtual QgsDiagram* clone() const;
+
     void renderDiagram( const QgsAttributes& att, QgsRenderContext& c, const QgsDiagramSettings& s, const QPointF& position );
     QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s );
     QSizeF diagramSize( const QgsAttributes& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s, const QgsDiagramInterpolationSettings& is );

diff --git a/python/core/qgsdiagramrendererv2.sip b/python/core/qgsdiagramrendererv2.sip
@@ -24,6 +24,8 @@ struct QgsDiagramLayerSettings
 
     QgsDiagramLayerSettings();
 
+    ~QgsDiagramLayerSettings();
+
     //pal placement properties
     Placement placement;
     LinePlacementFlags placementFlags;
@@ -118,6 +120,10 @@ class QgsDiagramRendererV2
     QgsDiagramRendererV2();
     virtual ~QgsDiagramRendererV2();
 
+    /** Returns new instance that is equivalent to this one
+     * @note added in 2.1 */
+    virtual QgsDiagramRendererV2* clone() const = 0;
+
     /**Returns size of the diagram for feature f in map units. Returns an invalid QSizeF in case of error*/
     virtual QSizeF sizeMapUnits( const QgsAttributes& attributes, const QgsRenderContext& c );
 
@@ -171,6 +177,8 @@ class QgsSingleCategoryDiagramRenderer : QgsDiagramRendererV2
     QgsSingleCategoryDiagramRenderer();
     ~QgsSingleCategoryDiagramRenderer();
 
+    QgsDiagramRendererV2* clone() const;
+
     QString rendererName() const;
 
     QList<int> diagramAttributes() const;
@@ -198,6 +206,8 @@ class QgsLinearlyInterpolatedDiagramRenderer : QgsDiagramRendererV2
     QgsLinearlyInterpolatedDiagramRenderer();
     ~QgsLinearlyInterpolatedDiagramRenderer();
 
+    QgsDiagramRendererV2* clone() const;
+
     /**Returns list with all diagram settings in the renderer*/
     QList<QgsDiagramSettings> diagramSettings() const;
 

diff --git a/python/core/qgsfeaturerequest.sip b/python/core/qgsfeaturerequest.sip
@@ -63,3 +63,23 @@ class QgsFeatureRequest
     QgsFeatureRequest& setSubsetOfAttributes( const QStringList& attrNames, const QgsFields& fields );
 
 };
+
+
+/** base class that can be used for any class that is capable of returning features
+ * @note added in 2.1
+ */
+class QgsAbstractFeatureSource
+{
+%TypeHeaderCode
+#include <qgsfeaturerequest.h>
+%End
+
+public:
+  virtual ~QgsAbstractFeatureSource();
+
+  virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest& request ) = 0;
+
+protected:
+  void iteratorOpened( QgsAbstractFeatureIterator* it );
+  void iteratorClosed( QgsAbstractFeatureIterator* it );
+};
diff --git a/python/core/qgsfield.sip b/python/core/qgsfield.sip
@@ -126,6 +126,7 @@ class QgsFields
     void clear();
     void append( const QgsField& field, FieldOrigin origin = OriginProvider, int originIndex = -1 );
     void remove( int fieldIdx );
+    void extend( const QgsFields& other );
 
     bool isEmpty() const;
     // __len__ annotation since sip 4.10.3
@@ -139,16 +140,24 @@ class QgsFields
     //const QgsField& operator[](int i) const;
     //QgsField& operator[](int i);
     const QgsField& at(int i) const;
-    QList<QgsField> toList() const;
 
     const QgsField& field( int fieldIdx ) const;
     const QgsField& field( const QString& name ) const;
     FieldOrigin fieldOrigin( int fieldIdx ) const;
     int fieldOriginIndex( int fieldIdx ) const;
 
     int indexFromName( const QString& name ) const;
-    void extend( const QgsFields& other );
 
+    //! Look up field's index from name - case insensitive
+    //! TODO: sort out case sensitive (indexFromName()) vs insensitive (fieldNameIndex()) calls
+    //! @note added in 2.1
+    int fieldNameIndex( const QString& fieldName ) const;
+
+    //! Utility function to get list of attribute indexes
+    //! @note added in 2.1
+    QgsAttributeList allAttributesList() const;
+
+    QList<QgsField> toList() const;
 
     QgsField& operator[](int i) /Factory/;
 %MethodCode
@@ -181,5 +190,6 @@ void __setitem__(int key, const QgsField& field);
     (*sipCpp)[idx] = *a1;
 %End
 
+
 };
 
diff --git a/python/core/qgsgeometrycache.sip b/python/core/qgsgeometrycache.sip
@@ -4,7 +4,7 @@ class QgsGeometryCache
 #include <qgsgeometrycache.h>
 %End
   public:
-    QgsGeometryCache( QgsVectorLayer* layer );
+    QgsGeometryCache();
     ~QgsGeometryCache();
 
     QgsGeometryMap& cachedGeometries();
@@ -25,6 +25,4 @@ class QgsGeometryCache
     void setCachedGeometriesRect( const QgsRectangle& extent );
     const QgsRectangle& cachedGeometriesRect();
 
-  protected:
-    QgsVectorLayerEditBuffer *editBuffer();
 };
diff --git a/python/core/qgslabelsearchtree.sip b/python/core/qgslabelsearchtree.sip
@@ -12,10 +12,10 @@ class QgsLabelSearchTree
     void clear();
 
     /**Returns label position(s) at a given point. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions*/
-    // void label( const QgsPoint& p, QList<QgsLabelPosition*>& posList );
+    // void label( const QgsPoint& p, QList<QgsLabelPosition*>& posList ) const;
 
     /**Returns label position(s) in given rectangle. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions*/
-    // void labelsInRect( const QgsRectangle& r, QList<QgsLabelPosition*>& posList );
+    // void labelsInRect( const QgsRectangle& r, QList<QgsLabelPosition*>& posList ) const;
 
     /**Inserts label position. Does not take ownership of labelPos
       @return true in case of success*/

diff --git a/python/core/qgsmaplayer.sip b/python/core/qgsmaplayer.sip
@@ -116,6 +116,11 @@ class QgsMapLayer : QObject
         @note added in version 1.6*/
     virtual void reload();
 
+    /** Return new instance of QgsMapLayerRenderer that will be used for rendering of given context
+     * @note added in 2.1
+     */
+    virtual QgsMapLayerRenderer* createMapRenderer( QgsRenderContext& rendererContext ) /Factory/;
+
     /** This is the method that does the actual work of
      * drawing the layer onto a paint device.
      * @param rendererContext describes the extents,
@@ -210,21 +215,11 @@ class QgsMapLayer : QObject
     void removeCustomProperty( const QString& key );
 
 
-    /**
+    //! @deprecated since 2.1 - returns empty string
-     * If an operation returns 0 (e.g. draw()), this function
+    virtual QString lastErrorTitle() /Deprecated/;
-     * returns the text of the error associated with the failure.
-     * Interactive users of this provider can then, for example,
-     * call a QMessageBox to display the contents.
-     */
-    virtual QString lastErrorTitle();
 
-    /**
+    //! @deprecated since 2.1 - returns empty string
-     * If an operation returns 0 (e.g. draw()), this function
+    virtual QString lastError() /Deprecated/;
-     * returns the text of the error associated with the failure.
-     * Interactive users of this provider can then, for example,
-     * call a QMessageBox to display the contents.
-     */
-    virtual QString lastError();
 
     /** Get current status error. This error describes some principal problem
      *  for which layer cannot work and thus is not valid. It is not last error
@@ -346,18 +341,12 @@ class QgsMapLayer : QObject
     /** Return pointer to layer's undo stack */
     QUndoStack* undoStack();
 
-    /** Get the QImage used for caching render operations
+    /** @deprecated since 2.1 - returns NULL */
-     * @note This method was added in QGIS 1.4 **/
+    QImage *cacheImage() /Deprecated/;
-    QImage *cacheImage();
+    /** @deprecated since 2.1 - does nothing */
-    /** Set the QImage used for caching render operations
+    void setCacheImage( QImage * thepImage /Transfer/ ) /Deprecated/;
-     * @note This method was added in QGIS 1.4 **/
+    /** @deprecated since 2.1 - does nothing */
-    void setCacheImage( QImage * thepImage /Transfer/ );
+    virtual void onCacheImageDelete() /Deprecated/;
-
-    /**
-     * @brief Is called when the cache image is being deleted. Overwrite and use to clean up.
-     * @note added in 2.0
-     */
-    virtual void onCacheImageDelete();
 
   public slots:
 
@@ -376,9 +365,8 @@ class QgsMapLayer : QObject
     void toggleScaleBasedVisibility( bool theVisibilityFlag );
     bool hasScaleBasedVisibility();
 
-    /** Clear cached image
+    /** @deprecated since 2.1 - does nothing */
-     * added in 1.5 */
+    void clearCacheImage() /Deprecated/;
-    void clearCacheImage();
 
     /** \brief Obtain Metadata for this layer */
     virtual QString metadata();
@@ -388,7 +376,7 @@ class QgsMapLayer : QObject
 
   signals:
 
-    /** Emit a signal to notify of a progress event */
+    //! @deprecated in 2.1 - not emitted anymore
     void drawingProgress( int theProgress, int theTotalSteps );
 
     /** Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) */
@@ -407,8 +395,7 @@ class QgsMapLayer : QObject
      */
     void repaintRequested();
 
-    /**The layer emits this signal when a screen update is requested.
+    //! \note Deprecated in 2.1 and not emitted anymore
-     This signal should be connected with the slot QgsMapCanvas::updateMap()*/
     void screenUpdateRequested();
 
     /** This is used to send a request that any mapcanvas using this layer update its extents */

diff --git a/python/core/qgsmaplayerregistry.sip b/python/core/qgsmaplayerregistry.sip
@@ -119,7 +119,8 @@ class QgsMapLayerRegistry : QObject
      *
      * @note Added in QGIS 1.4
      */
-    void clearAllLayerCaches();
+    //! @deprecated since 2.1 - does nothing
+    void clearAllLayerCaches() /Deprecated/;
 
     /**
      * Reload all provider data caches (currently used for WFS and WMS providers)

diff --git a/python/core/qgsmaplayerrenderer.sip b/python/core/qgsmaplayerrenderer.sip
@@ -0,0 +1,20 @@
+
+class QgsMapLayerRenderer
+{
+%TypeHeaderCode
+#include <qgsmaplayerrenderer.h>
+%End
+
+public:
+  QgsMapLayerRenderer( const QString& layerID );
+  virtual ~QgsMapLayerRenderer();
+
+  //! Do the rendering (based on data stored in the class)
+  virtual bool render() = 0;
+
+  //! Return list of errors (problems) that happened during the rendering
+  QStringList errors() const;
+
+  //! Get access to the ID of the layer rendered by this class
+  QString layerID() const;
+};