QGIS/python/core/symbology-ng/qgsinvertedpolygonrenderer.sip

75 lines
3.3 KiB
Plaintext
Raw Normal View History

2014-05-24 12:00:44 +07:00
class QgsInvertedPolygonRenderer : QgsFeatureRendererV2
2014-05-23 19:56:18 +02:00
{
%TypeHeaderCode
#include <qgsinvertedpolygonrenderer.h>
%End
public:
2014-05-24 12:07:23 +02:00
/** Constructor
* @param embeddedRenderer optional embeddedRenderer. If null, a default one will be assigned
*/
QgsInvertedPolygonRenderer( const QgsFeatureRendererV2* embeddedRenderer /Transfer/ = 0 );
virtual ~QgsInvertedPolygonRenderer();
2014-05-23 19:56:18 +02:00
2014-05-24 12:07:23 +02:00
/** Used to clone this feature renderer.*/
virtual QgsFeatureRendererV2* clone() /Factory/;
2014-05-23 19:56:18 +02:00
2014-05-24 12:07:23 +02:00
virtual void startRender( QgsRenderContext& context, const QgsFields& fields );
2014-05-23 19:56:18 +02:00
2014-05-24 12:07:23 +02:00
/** Renders a given feature.
* This will here collect features. The actual rendering will be postponed to stopRender()
* @param feature the feature to render
* @param context the rendering context
* @param layer the symbol layer to render, if that makes sense
* @param selected whether this feature has been selected (this will add decorations)
* @param drawVertexMarker whether this feature has vertex markers (in edit mode usually)
* @returns true if the rendering was ok
*/
virtual bool renderFeature( QgsFeature& feature, QgsRenderContext& context, int layer = -1, bool selected = false, bool drawVertexMarker = false );
2014-05-23 19:56:18 +02:00
2014-05-24 12:07:23 +02:00
/**
* The actual rendering will take place here.
* Features collected during renderFeature() are rendered using the embedded feature renderer
*/
virtual void stopRender( QgsRenderContext& context );
2014-05-23 19:56:18 +02:00
2014-05-24 12:07:23 +02:00
/** @returns a textual representation of the renderer */
virtual QString dump() const;
2014-05-23 19:56:18 +02:00
2014-05-24 12:07:23 +02:00
/** 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();
/** Proxy that will call this method on the embedded renderer. */
virtual QgsSymbolV2List symbols();
/** Proxy that will call this method on the embedded renderer. */
virtual QgsSymbolV2* symbolForFeature( QgsFeature& feature );
/** Proxy that will call this method on the embedded renderer. */
virtual QgsSymbolV2List symbolsForFeature( QgsFeature& feat );
/** Proxy that will call this method on the embedded renderer. */
virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize );
/** Proxy that will call this method on the embedded renderer.
@note not available in python bindings
*/
// virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, QString rule = "" );
/** Proxy that will call this method on the embedded renderer. */
virtual bool willRenderFeature( QgsFeature& feat );
2014-05-23 19:56:18 +02:00
2014-05-24 12:07:23 +02:00
/** Creates a renderer out of an XML, for loading*/
static QgsFeatureRendererV2* create( QDomElement& element ) /Factory/;
2014-05-23 19:56:18 +02:00
2014-05-24 12:07:23 +02:00
/** Creates an XML representation of the renderer. Used for saving purpose
* @param doc the XML document where to create the XML subtree
* @returns the created XML subtree
*/
virtual QDomElement save( QDomDocument& doc );
2014-05-23 19:56:18 +02:00
2014-05-24 12:07:23 +02:00
/** sets the embedded renderer
* @param subRenderer the embedded renderer (will be cloned)
*/
void setEmbeddedRenderer( const QgsFeatureRendererV2* subRenderer );
/** @returns the current embedded renderer
*/
const QgsFeatureRendererV2* embeddedRenderer() const;
2014-05-23 19:56:18 +02:00
};