qgspainteffectregistry.h

Go to the documentation of this file.

/***************************************************************************
                             qgspainteffectregistry.h
                             ------------------------
    begin                : January 2015
    copyright            : (C) 2015 Nyall Dawson
    email                : nyall dot dawson 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 QGSPAINTEFFECTREGISTRY_H
#define QGSPAINTEFFECTREGISTRY_H

#include "qgis.h"
#include <QDomElement>
#include <QDomDocument>

class QgsPaintEffect;
class QgsPaintEffectWidget;

class CORE_EXPORT QgsPaintEffectAbstractMetadata
{
  public:

    QgsPaintEffectAbstractMetadata( const QString& name, const QString& visibleName );

    virtual ~QgsPaintEffectAbstractMetadata() {}

    QString name() const { return mName; }

    QString visibleName() const { return mVisibleName; }

    virtual QgsPaintEffect* createPaintEffect( const QgsStringMap& map ) = 0;

    virtual QgsPaintEffectWidget* createWidget() { return nullptr; }

  protected:
    QString mName;
    QString mVisibleName;

};

typedef QgsPaintEffect*( *QgsPaintEffectCreateFunc )( const QgsStringMap& );
typedef QgsPaintEffectWidget*( *QgsPaintEffectWidgetFunc )();

class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
{

  public:

    QgsPaintEffectMetadata( const QString& name, const QString& visibleName,
                            QgsPaintEffectCreateFunc pfCreate,
                            QgsPaintEffectWidgetFunc pfWidget = nullptr )
        : QgsPaintEffectAbstractMetadata( name, visibleName )
        , mCreateFunc( pfCreate )
        , mWidgetFunc( pfWidget )
    {}

    QgsPaintEffectCreateFunc createFunction() const { return mCreateFunc; }

    QgsPaintEffectWidgetFunc widgetFunction() const { return mWidgetFunc; }

    void setWidgetFunction( QgsPaintEffectWidgetFunc f ) { mWidgetFunc = f; }

    virtual QgsPaintEffect* createPaintEffect( const QgsStringMap& map ) override { return mCreateFunc ? mCreateFunc( map ) : nullptr; }

    virtual QgsPaintEffectWidget* createWidget() override { return mWidgetFunc ? mWidgetFunc() : nullptr; }

  protected:
    QgsPaintEffectCreateFunc mCreateFunc;
    QgsPaintEffectWidgetFunc mWidgetFunc;
};


class CORE_EXPORT QgsPaintEffectRegistry
{
  public:

    static QgsPaintEffectRegistry* instance();

    QgsPaintEffectAbstractMetadata* effectMetadata( const QString& name ) const;

    bool addEffectType( QgsPaintEffectAbstractMetadata* metadata );

    QgsPaintEffect* createEffect( const QString& name, const QgsStringMap& properties = QgsStringMap() ) const;

    QgsPaintEffect* createEffect( const QDomElement& element ) const;

    QStringList effects() const;

    static QgsPaintEffect* defaultStack();

    static bool isDefaultStack( QgsPaintEffect* effect );

  protected:
    QgsPaintEffectRegistry();
    ~QgsPaintEffectRegistry();

    QMap<QString, QgsPaintEffectAbstractMetadata*> mMetadata;

  private:

    QgsPaintEffectRegistry( const QgsPaintEffectRegistry& rh );
    QgsPaintEffectRegistry& operator=( const QgsPaintEffectRegistry& rh );
};

#endif //QGSPAINTEFFECTREGISTRY_H