qgsmapdecoration.h

Go to the documentation of this file.

/***************************************************************************
                          qgsmapdecoration.h
                          ----------------
    begin                : April 2017
    copyright            : (C) 2017 by Mathieu Pellerin
    email                : nirvn dot asia 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 QGSMAPDECORATION_H
#define QGSMAPDECORATION_H
 
#include "qgis_core.h"
 
#include <QString>
 
class QgsMapSettings;
class QgsRenderContext;

class CORE_EXPORT QgsMapDecoration
{
  public:
    QgsMapDecoration() = default;
 
    virtual ~QgsMapDecoration() = default;

    virtual void render( const QgsMapSettings &mapSettings, QgsRenderContext &context ) = 0;

    const QString displayName() const { return mDisplayName; }

    virtual bool hasFixedMapPosition() const { return false; }
 
  protected:
    void setDisplayName( const QString &name ) { mDisplayName = name; }
 
  private:
    QString mDisplayName;
};
 
#endif //QGSMAPDECORATION_H