qgsrendererregistry.h

Go to the documentation of this file.

/***************************************************************************
    qgsrendererregistry.h
    ---------------------
    begin                : November 2009
    copyright            : (C) 2009 by Martin Dobias
    email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSRENDERERREGISTRY_H
#define QGSRENDERERREGISTRY_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QDomElement>
#include <QIcon>
#include <QMap>
#include <QStringList>
 
// #include "qgis.h"
#include "qgswkbtypes.h"
 
class QgsFeatureRenderer;
class QgsReadWriteContext;
class QgsVectorLayer;
class QgsStyle;
class QgsRendererWidget SIP_EXTERNAL;

class CORE_EXPORT QgsRendererAbstractMetadata
{
  public:
    enum LayerType SIP_ENUM_BASETYPE( IntFlag )
    {
      PointLayer = 1,                              
      LineLayer = 2,                               
      PolygonLayer = 4,                            
      All = PointLayer | LineLayer | PolygonLayer, 
    };
    Q_DECLARE_FLAGS( LayerTypes, LayerType )
 
    
    QgsRendererAbstractMetadata( const QString &name, const QString &visibleName, const QIcon &icon = QIcon() )
      : mName( name )
      , mVisibleName( visibleName )
      , mIcon( icon )
    {}
    virtual ~QgsRendererAbstractMetadata() = default;

    QString name() const { return mName; }

    QString visibleName() const { return mVisibleName; }

    QIcon icon() const { return mIcon; }

    void setIcon( const QIcon &icon ) { mIcon = icon; }

    virtual QgsRendererAbstractMetadata::LayerTypes compatibleLayerTypes() const { return All; }

    virtual QgsFeatureRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) = 0 SIP_FACTORY;

    virtual QgsRendererWidget *createRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *oldRenderer ) SIP_FACTORY
    {
      Q_UNUSED( layer )
      Q_UNUSED( style );
      Q_UNUSED( oldRenderer );
      return nullptr;
    }

    virtual QgsFeatureRenderer *createRendererFromSld( QDomElement &elem, Qgis::GeometryType geomType ) SIP_FACTORY
    {
      Q_UNUSED( elem )
      Q_UNUSED( geomType );
      return nullptr;
    }
 
  protected:
    QString mName;
    QString mVisibleName;
    QIcon mIcon;
};
 
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsRendererAbstractMetadata::LayerTypes )
 
 
typedef QgsFeatureRenderer *( *QgsRendererCreateFunc )( QDomElement &, const QgsReadWriteContext & ) SIP_SKIP;
typedef QgsRendererWidget *( *QgsRendererWidgetFunc )( QgsVectorLayer *, QgsStyle *, QgsFeatureRenderer * ) SIP_SKIP;
typedef QgsFeatureRenderer *( *QgsRendererCreateFromSldFunc )( QDomElement &, Qgis::GeometryType geomType ) SIP_SKIP;

class CORE_EXPORT QgsRendererMetadata : public QgsRendererAbstractMetadata
{
  public:
    QgsRendererMetadata(
      const QString &name,
      const QString &visibleName,
      QgsRendererCreateFunc pfCreate,
      const QIcon &icon = QIcon(),
      QgsRendererWidgetFunc pfWidget = nullptr,
      QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All
    ) SIP_SKIP : QgsRendererAbstractMetadata( name, visibleName, icon ),
                 mCreateFunc( pfCreate ),
                 mWidgetFunc( pfWidget ),
                 mCreateFromSldFunc( nullptr ),
                 mLayerTypes( layerTypes )
    {}

    QgsRendererMetadata(
      const QString &name,
      const QString &visibleName,
      QgsRendererCreateFunc pfCreate,
      QgsRendererCreateFromSldFunc pfCreateFromSld,
      const QIcon &icon = QIcon(),
      QgsRendererWidgetFunc pfWidget = nullptr,
      QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All
    ) SIP_SKIP : QgsRendererAbstractMetadata( name, visibleName, icon ),
                 mCreateFunc( pfCreate ),
                 mWidgetFunc( pfWidget ),
                 mCreateFromSldFunc( pfCreateFromSld ),
                 mLayerTypes( layerTypes )
    {}
 
    QgsFeatureRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) override SIP_FACTORY { return mCreateFunc ? mCreateFunc( elem, context ) : nullptr; }
    QgsRendererWidget *createRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) override SIP_FACTORY
    {
      return mWidgetFunc ? mWidgetFunc( layer, style, renderer ) : nullptr;
    }
    QgsFeatureRenderer *createRendererFromSld( QDomElement &elem, Qgis::GeometryType geomType ) override SIP_FACTORY { return mCreateFromSldFunc ? mCreateFromSldFunc( elem, geomType ) : nullptr; }

    QgsRendererCreateFunc createFunction() const SIP_SKIP { return mCreateFunc; }
    QgsRendererWidgetFunc widgetFunction() const SIP_SKIP { return mWidgetFunc; }
    QgsRendererCreateFromSldFunc createFromSldFunction() const SIP_SKIP { return mCreateFromSldFunc; }

    void setWidgetFunction( QgsRendererWidgetFunc f ) SIP_SKIP { mWidgetFunc = f; }
 
    QgsRendererAbstractMetadata::LayerTypes compatibleLayerTypes() const override { return mLayerTypes; }
 
  protected:
    QgsRendererCreateFunc mCreateFunc;
    QgsRendererWidgetFunc mWidgetFunc;
    QgsRendererCreateFromSldFunc mCreateFromSldFunc;
 
  private:
#ifdef SIP_RUN
    QgsRendererMetadata();
#endif
 
    QgsRendererAbstractMetadata::LayerTypes mLayerTypes;
};
 

 
class CORE_EXPORT QgsRendererRegistry
{
  public:
    QgsRendererRegistry();
    ~QgsRendererRegistry();
 
    QgsRendererRegistry( const QgsRendererRegistry &rh ) = delete;
    QgsRendererRegistry &operator=( const QgsRendererRegistry &rh ) = delete;

    bool addRenderer( QgsRendererAbstractMetadata *metadata SIP_TRANSFER );

    bool removeRenderer( const QString &rendererName );

    QgsRendererAbstractMetadata *rendererMetadata( const QString &rendererName );

    QStringList renderersList( QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All ) const;

    QStringList renderersList( const QgsVectorLayer *layer ) const;
 
  private:
#ifdef SIP_RUN
    QgsRendererRegistry( const QgsRendererRegistry &rh );
#endif

    QMap<QString, QgsRendererAbstractMetadata *> mRenderers;

    QStringList mRenderersOrder;
};
 
#endif // QGSRENDERERREGISTRY_H