Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :     qgspluginlayer.h
       3                 :            :     ---------------------
       4                 :            :     begin                : January 2010
       5                 :            :     copyright            : (C) 2010 by Martin Dobias
       6                 :            :     email                : wonder dot sk at gmail dot com
       7                 :            :  ***************************************************************************
       8                 :            :  *                                                                         *
       9                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      10                 :            :  *   it under the terms of the GNU General Public License as published by  *
      11                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      12                 :            :  *   (at your option) any later version.                                   *
      13                 :            :  *                                                                         *
      14                 :            :  ***************************************************************************/
      15                 :            : #ifndef QGSPLUGINLAYER_H
      16                 :            : #define QGSPLUGINLAYER_H
      17                 :            : 
      18                 :            : #include "qgis_core.h"
      19                 :            : #include "qgsmaplayer.h"
      20                 :            : #include "qgsdataprovider.h"
      21                 :            : 
      22                 :            : /**
      23                 :            :  * \ingroup core
      24                 :            :  * \brief Base class for plugin layers. These can be implemented by plugins
      25                 :            :  *  and registered in QgsPluginLayerRegistry.
      26                 :            :  *
      27                 :            :  *  In order to be readable from project files, they should set these attributes in layer DOM node:
      28                 :            :  *  "type" = "plugin"
      29                 :            :  *  "name" = "your_layer_type"
      30                 :            :  */
      31                 :            : class CORE_EXPORT QgsPluginLayer : public QgsMapLayer
      32                 :            : {
      33                 :            :     Q_OBJECT
      34                 :            : 
      35                 :            :   public:
      36                 :            :     QgsPluginLayer( const QString &layerType, const QString &layerName = QString() );
      37                 :            :     ~QgsPluginLayer() override;
      38                 :            : 
      39                 :            : #ifdef SIP_RUN
      40                 :            :     SIP_PYOBJECT __repr__();
      41                 :            :     % MethodCode
      42                 :            :     QString str = QStringLiteral( "<QgsPluginLayer: '%1'>" ).arg( sipCpp->name() );
      43                 :            :     sipRes = PyUnicode_FromString( str.toUtf8().constData() );
      44                 :            :     % End
      45                 :            : #endif
      46                 :            : 
      47                 :            :     /**
      48                 :            :      * Returns a new instance equivalent to this one.
      49                 :            :      * \returns a new layer instance
      50                 :            :      * \since QGIS 3.0
      51                 :            :      */
      52                 :            :     QgsPluginLayer *clone() const override = 0;
      53                 :            : 
      54                 :            :     //! Returns plugin layer type (the same as used in QgsPluginLayerRegistry)
      55                 :            :     QString pluginLayerType();
      56                 :            : 
      57                 :            :     //! Sets extent of the layer
      58                 :            :     void setExtent( const QgsRectangle &extent ) override;
      59                 :            : 
      60                 :            :     /**
      61                 :            :      * Set source string. This is used for example in layer tree to show tooltip.
      62                 :            :      * \since QGIS 2.16
      63                 :            :      */
      64                 :            :     void setSource( const QString &source );
      65                 :            : 
      66                 :            :     QgsDataProvider *dataProvider() override;
      67                 :            :     const QgsDataProvider *dataProvider() const override SIP_SKIP;
      68                 :            : 
      69                 :            :   protected:
      70                 :            :     QString mPluginLayerType;
      71                 :            :     QgsDataProvider *mDataProvider;
      72                 :            : };
      73                 :            : 
      74                 :            : #ifndef SIP_RUN
      75                 :            : ///@cond PRIVATE
      76                 :            : 
      77                 :            : /**
      78                 :            :  * A minimal data provider for plugin layers
      79                 :            :  */
      80                 :            : class QgsPluginLayerDataProvider : public QgsDataProvider
      81                 :            : {
      82                 :            :     Q_OBJECT
      83                 :            : 
      84                 :            :   public:
      85                 :            :     QgsPluginLayerDataProvider( const QString &layerType,
      86                 :            :                                 const QgsDataProvider::ProviderOptions &providerOptions,
      87                 :            :                                 QgsDataProvider::ReadFlags flags );
      88                 :          0 :     void setExtent( const QgsRectangle &extent ) { mExtent = extent; }
      89                 :            :     QgsCoordinateReferenceSystem crs() const override;
      90                 :            :     QString name() const override;
      91                 :            :     QString description() const override;
      92                 :            :     QgsRectangle extent() const override;
      93                 :            :     bool isValid() const override;
      94                 :            : 
      95                 :            :   private:
      96                 :            :     QString mName;
      97                 :            :     QgsRectangle mExtent;
      98                 :            : };
      99                 :            : ///@endcond
     100                 :            : #endif
     101                 :            : 
     102                 :            : #endif // QGSPLUGINLAYER_H