qgsmaplayerrenderer.h

Go to the documentation of this file.

/***************************************************************************
  qgsmaplayerrenderer.h
  --------------------------------------
  Date                 : December 2013
  Copyright            : (C) 2013 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 QGSMAPLAYERRENDERER_H
#define QGSMAPLAYERRENDERER_H

#include <QStringList>

#include "qgis_core.h"

class QgsFeedback;
class QgsRenderContext;

class CORE_EXPORT QgsMapLayerRenderer
{
  public:

    QgsMapLayerRenderer( const QString &layerID, QgsRenderContext *context = nullptr )
      : mLayerID( layerID )
      , mContext( context )
    {}

    virtual ~QgsMapLayerRenderer() = default;

    virtual bool render() = 0;

    virtual QgsFeedback *feedback() const { return nullptr; }

    QStringList errors() const { return mErrors; }

    QString layerId() const { return mLayerID; }

    QgsRenderContext *renderContext() { return mContext; }

  protected:
    QStringList mErrors;
    QString mLayerID;

  private:

    // TODO QGIS 4.0 - make reference instead of pointer!

    QgsRenderContext *mContext = nullptr;
};

#endif // QGSMAPLAYERRENDERER_H