QgsFeatureRendererV2::Capabilities to flags

qgis · Aug 2, 2016 · 8182f29 · 8182f29
1 parent 2cf9243
commit 8182f29
Show file tree

Hide file tree

Showing 17 changed files with 61 additions and 26 deletions.
diff --git a/doc/api_break.dox b/doc/api_break.dox
@@ -241,6 +241,12 @@ None will need to be modified, as the method will return an empty geometry if th
 <li>setFields( const QgsFields*, bool ) has been removed, use setFields( const QgsFields&, bool ) instead.</li>
 </ul>
 
+\subsection qgis_api_break_3_0_QgsFeatureRendererV2 QgsFeatureRendererV2
+
+<ul>
+<li>The method capabilities() returns QgsFeatureRendererV2::Capabilities flags instead of an integer. The two are binary compatible.
+</ul>
+
 \subsection qgis_api_break_3_0_QgsGeometry QgsGeometry
 
 <ul>

diff --git a/python/core/symbology-ng/qgscategorizedsymbolrendererv2.sip b/python/core/symbology-ng/qgscategorizedsymbolrendererv2.sip
@@ -68,7 +68,7 @@ class QgsCategorizedSymbolRendererV2 : QgsFeatureRendererV2
     virtual void toSld( QDomDocument& doc, QDomElement &element ) const;
 
     //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities();
+    virtual QgsFeatureRendererV2::Capabilities capabilities();
 
     virtual QString filter( const QgsFields& fields = QgsFields() );
 

diff --git a/python/core/symbology-ng/qgsgraduatedsymbolrendererv2.sip b/python/core/symbology-ng/qgsgraduatedsymbolrendererv2.sip
@@ -111,7 +111,7 @@ class QgsGraduatedSymbolRendererV2 : QgsFeatureRendererV2
     virtual void toSld( QDomDocument& doc, QDomElement &element ) const;
 
     //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities();
+    virtual QgsFeatureRendererV2::Capabilities capabilities();
 
     //! @note symbol2 in python bindings
     virtual QgsSymbolV2List symbols( QgsRenderContext& context ) /PyName=symbols2/;

diff --git a/python/core/symbology-ng/qgsinvertedpolygonrenderer.sip b/python/core/symbology-ng/qgsinvertedpolygonrenderer.sip
@@ -41,7 +41,7 @@ class QgsInvertedPolygonRenderer : QgsFeatureRendererV2
     /** Proxy that will call this method on the embedded renderer. */
     virtual QList<QString> usedAttributes();
     /** Proxy that will call this method on the embedded renderer. */
-    virtual int capabilities();
+    virtual QgsFeatureRendererV2::Capabilities capabilities();
     /** Proxy that will call this method on the embedded renderer.
      * @note available in python bindings as symbol2
      */

diff --git a/python/core/symbology-ng/qgspointdisplacementrenderer.sip b/python/core/symbology-ng/qgspointdisplacementrenderer.sip
@@ -26,7 +26,7 @@ class QgsPointDisplacementRenderer : QgsFeatureRendererV2
     /** Partial proxy that will call this method on the embedded renderer. */
     virtual QList<QString> usedAttributes();
     /** Proxy that will call this method on the embedded renderer. */
-    virtual int capabilities();
+    virtual QgsFeatureRendererV2::Capabilities capabilities();
     /** Proxy that will call this method on the embedded renderer.
       @note available in python as symbols2
      */

diff --git a/python/core/symbology-ng/qgsrendererv2.sip b/python/core/symbology-ng/qgsrendererv2.sip
@@ -172,7 +172,7 @@ class QgsFeatureRendererV2
     //! for debugging
     virtual QString dump() const;
 
-    enum Capabilities
+    enum Capability
     {
       SymbolLevels,           // rendering with symbol levels (i.e. implements symbols(), symbolForFeature())
       RotationField,          // rotate symbols by attribute value
@@ -181,8 +181,10 @@ class QgsFeatureRendererV2
       ScaleDependent          // depends on scale if feature will be rendered (rule based )
     };
 
+    typedef QFlags<QgsFeatureRendererV2::Capability> Capabilities;
+
     //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities();
+    virtual QgsFeatureRendererV2::Capabilities capabilities();
 
     /** For symbol levels
      * @deprecated use symbols( QgsRenderContext& context ) instead

diff --git a/python/core/symbology-ng/qgsrulebasedrendererv2.sip b/python/core/symbology-ng/qgsrulebasedrendererv2.sip
@@ -418,7 +418,7 @@ class QgsRuleBasedRendererV2 : QgsFeatureRendererV2
     virtual QSet<QString> legendKeysForFeature( QgsFeature& feature, QgsRenderContext& context );
 
     //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities();
+    virtual QgsFeatureRendererV2::Capabilities capabilities();
 
     /////
 

diff --git a/python/core/symbology-ng/qgssinglesymbolrendererv2.sip b/python/core/symbology-ng/qgssinglesymbolrendererv2.sip
@@ -41,7 +41,7 @@ class QgsSingleSymbolRendererV2 : QgsFeatureRendererV2
     static QgsFeatureRendererV2* createFromSld( QDomElement& element, Qgis::GeometryType geomType );
 
     //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities();
+    virtual QgsFeatureRendererV2::Capabilities capabilities();
 
     //! @note available in python as symbol2
     virtual QgsSymbolV2List symbols( QgsRenderContext& context ) /PyName=symbols2/;

diff --git a/src/core/symbology-ng/qgscategorizedsymbolrendererv2.h b/src/core/symbology-ng/qgscategorizedsymbolrendererv2.h
@@ -102,7 +102,7 @@ class CORE_EXPORT QgsCategorizedSymbolRendererV2 : public QgsFeatureRendererV2
     virtual void toSld( QDomDocument& doc, QDomElement &element ) const override;
 
     //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities() override { return SymbolLevels | RotationField | Filter; }
+    virtual Capabilities capabilities() override { return SymbolLevels | RotationField | Filter; }
 
     virtual QString filter( const QgsFields& fields = QgsFields() ) override;
 

diff --git a/src/core/symbology-ng/qgsgraduatedsymbolrendererv2.h b/src/core/symbology-ng/qgsgraduatedsymbolrendererv2.h
@@ -155,7 +155,7 @@ class CORE_EXPORT QgsGraduatedSymbolRendererV2 : public QgsFeatureRendererV2
     virtual void toSld( QDomDocument& doc, QDomElement &element ) const override;
 
     //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities() override { return SymbolLevels | RotationField | Filter; }
+    virtual Capabilities capabilities() override { return SymbolLevels | RotationField | Filter; }
 
     //! @note symbol2 in python bindings
     virtual QgsSymbolV2List symbols( QgsRenderContext &context ) override;

diff --git a/src/core/symbology-ng/qgsinvertedpolygonrenderer.cpp b/src/core/symbology-ng/qgsinvertedpolygonrenderer.cpp
@@ -455,7 +455,7 @@ QgsSymbolV2List QgsInvertedPolygonRenderer::symbols( QgsRenderContext& context )
   return mSubRenderer->symbols( context );
 }
 
-int QgsInvertedPolygonRenderer::capabilities()
+QgsFeatureRendererV2::Capabilities QgsInvertedPolygonRenderer::capabilities()
 {
   if ( !mSubRenderer )
   {

diff --git a/src/core/symbology-ng/qgsinvertedpolygonrenderer.h b/src/core/symbology-ng/qgsinvertedpolygonrenderer.h
@@ -76,7 +76,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRendererV2
     /** Proxy that will call this method on the embedded renderer. */
     virtual QList<QString> usedAttributes() override;
     /** Proxy that will call this method on the embedded renderer. */
-    virtual int capabilities() override;
+    virtual Capabilities capabilities() override;
     /** Proxy that will call this method on the embedded renderer.
      * @note available in python bindings as symbol2
      */

diff --git a/src/core/symbology-ng/qgspointdisplacementrenderer.cpp b/src/core/symbology-ng/qgspointdisplacementrenderer.cpp
@@ -275,7 +275,7 @@ QList<QString> QgsPointDisplacementRenderer::usedAttributes()
   return attributeList;
 }
 
-int QgsPointDisplacementRenderer::capabilities()
+QgsFeatureRendererV2::Capabilities QgsPointDisplacementRenderer::capabilities()
 {
   if ( !mRenderer )
   {

diff --git a/src/core/symbology-ng/qgspointdisplacementrenderer.h b/src/core/symbology-ng/qgspointdisplacementrenderer.h
@@ -54,7 +54,7 @@ class CORE_EXPORT QgsPointDisplacementRenderer: public QgsFeatureRendererV2
     /** Partial proxy that will call this method on the embedded renderer. */
     virtual QList<QString> usedAttributes() override;
     /** Proxy that will call this method on the embedded renderer. */
-    virtual int capabilities() override;
+    virtual Capabilities capabilities() override;
     /** Proxy that will call this method on the embedded renderer.
       @note available in python as symbols2
      */

diff --git a/src/core/symbology-ng/qgsrendererv2.h b/src/core/symbology-ng/qgsrendererv2.h
@@ -169,10 +169,12 @@ class CORE_EXPORT QgsFeatureRendererV2
     virtual QString filter( const QgsFields& fields = QgsFields() ) { Q_UNUSED( fields ); return QString::null; }
 
     /**
-     * Returns a set of attributes required for this renderer.
+     * Return a list of attributes required by this renderer. Attributes not listed in here may
+     * not have been requested from the provider at rendering time.
      *
-     * TODO QGIS3: Change QList to QSet
+     * @return A set of attributes
      */
+    // TODO QGIS3: Change QList to QSet
     virtual QList<QString> usedAttributes() = 0;
 
     /**
@@ -182,6 +184,12 @@ class CORE_EXPORT QgsFeatureRendererV2
 
     virtual ~QgsFeatureRendererV2();
 
+    /**
+     * Create a deep copy of this renderer. Should be implemented by all subclasses
+     * and generate a proper subclass.
+     *
+     * @return A copy of this renderer
+     */
     virtual QgsFeatureRendererV2* clone() const = 0;
 
     /**
@@ -196,20 +204,37 @@ class CORE_EXPORT QgsFeatureRendererV2
      */
     virtual bool renderFeature( QgsFeature& feature, QgsRenderContext& context, int layer = -1, bool selected = false, bool drawVertexMarker = false );
 
-    //! for debugging
+    //! Returns debug information about this renderer
     virtual QString dump() const;
 
-    enum Capabilities
+    /**
+     * Used to specify details about a renderer.
+     * Is returned from the capabilities() method.
+     */
+    enum Capability
     {
-      SymbolLevels = 1,               //!< rendering with symbol levels (i.e. implements symbols(), symbolForFeature())
-      RotationField = 1 <<  1,        //!< rotate symbols by attribute value
+      SymbolLevels          = 1,      //!< rendering with symbol levels (i.e. implements symbols(), symbolForFeature())
+      RotationField         = 1 << 1, //!< rotate symbols by attribute value
       MoreSymbolsPerFeature = 1 << 2, //!< may use more than one symbol to render a feature: symbolsForFeature() will return them
-      Filter         = 1 << 3,        //!< features may be filtered, i.e. some features may not be rendered (categorized, rule based ...)
-      ScaleDependent = 1 << 4         //!< depends on scale if feature will be rendered (rule based )
+      Filter                = 1 << 3, //!< features may be filtered, i.e. some features may not be rendered (categorized, rule based ...)
+      ScaleDependent        = 1 << 4  //!< depends on scale if feature will be rendered (rule based )
     };
 
-    //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities() { return 0; }
+    Q_DECLARE_FLAGS( Capabilities, Capability )
+
+    /**
+     * Returns details about internals of this renderer.
+     *
+     * E.g. if you only want to deal with visible features:
+     *
+     * ~~~{.py}
+     * if not renderer.capabilities().testFlag(QgsFeatureRendererV2.Filter) or renderer.willRenderFeature(feature, context):
+     *     deal_with_my_feature()
+     * else:
+     *     skip_the_curren_feature()
+     * ~~~
+     */
+    virtual Capabilities capabilities() { return 0; }
 
     /** For symbol levels
      * @deprecated use symbols( QgsRenderContext& context ) instead
@@ -517,6 +542,8 @@ class CORE_EXPORT QgsFeatureRendererV2
     Q_DISABLE_COPY( QgsFeatureRendererV2 )
 };
 
+Q_DECLARE_OPERATORS_FOR_FLAGS( QgsFeatureRendererV2::Capabilities )
+
 // for some reason SIP compilation fails if these lines are not included:
 class QgsRendererV2Widget;
 class QgsPaintEffectWidget;

diff --git a/src/core/symbology-ng/qgsrulebasedrendererv2.h b/src/core/symbology-ng/qgsrulebasedrendererv2.h
@@ -489,7 +489,7 @@ class CORE_EXPORT QgsRuleBasedRendererV2 : public QgsFeatureRendererV2
     virtual QSet<QString> legendKeysForFeature( QgsFeature& feature, QgsRenderContext& context ) override;
 
     //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities() override { return MoreSymbolsPerFeature | Filter | ScaleDependent; }
+    virtual Capabilities capabilities() override { return MoreSymbolsPerFeature | Filter | ScaleDependent; }
 
     /////
 

diff --git a/src/core/symbology-ng/qgssinglesymbolrendererv2.h b/src/core/symbology-ng/qgssinglesymbolrendererv2.h
@@ -65,7 +65,7 @@ class CORE_EXPORT QgsSingleSymbolRendererV2 : public QgsFeatureRendererV2
     static QgsFeatureRendererV2* createFromSld( QDomElement& element, Qgis::GeometryType geomType );
 
     //! returns bitwise OR-ed capabilities of the renderer
-    virtual int capabilities() override { return SymbolLevels | RotationField; }
+    virtual Capabilities capabilities() override { return SymbolLevels | RotationField; }
 
     //! @note available in python as symbol2
     virtual QgsSymbolV2List symbols( QgsRenderContext& context ) override;