qgspluginlayerregistry.h

Go to the documentation of this file.

/***************************************************************************
                    qgspluginlayerregistry.cpp - class for
                    registering plugin layer creators
                             -------------------
    begin                : Mon Nov 30 2009
    copyright            : (C) 2009 by Mathias Walker, Sourcepole
    email                : mwa at sourcepole.ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSPLUGINLAYERREGSITRY_H
#define QGSPLUGINLAYERREGSITRY_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QDomNode>
#include <QMap>
 
class QgsPluginLayer;

class CORE_EXPORT QgsPluginLayerType
{
  public:
 
    QgsPluginLayerType( const QString &name );
    virtual ~QgsPluginLayerType() = default;
 
    QString name() const;

    virtual QgsPluginLayer *createLayer() SIP_FACTORY;

    virtual QgsPluginLayer *createLayer( const QString &uri ) SIP_FACTORY;

    virtual bool showLayerProperties( QgsPluginLayer *layer );
 
  protected:
    QString mName;
};
 
//=============================================================================

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

    QStringList pluginLayerTypes();

    bool addPluginLayerType( QgsPluginLayerType *pluginLayerType SIP_TRANSFER );

    bool removePluginLayerType( const QString &typeName );

    QgsPluginLayerType *pluginLayerType( const QString &typeName );

    QgsPluginLayer *createLayer( const QString &typeName, const QString &uri = QString() ) SIP_FACTORY;
 
  private:
#ifdef SIP_RUN
    QgsPluginLayerRegistry( const QgsPluginLayerRegistry &rh );
#endif
 
    typedef QMap<QString, QgsPluginLayerType *> PluginLayerTypes;
 
    PluginLayerTypes mPluginLayerTypes;
};
 
#endif // QGSPLUGINLAYERREGSITRY_H