qgsmasterlayoutinterface.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutinterface.h
                             --------------------
    begin                : December 2017
    copyright            : (C) 2017 by 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 QGSLAYOUTINTERFACE_H
#define QGSLAYOUTINTERFACE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QDomElement>
#include <QIcon>
#include <QString>
 
class QgsProject;
class QgsReadWriteContext;
class QgsStyleEntityVisitorInterface;
 
#ifdef SIP_RUN
// clang-format off
% ModuleHeaderCode
#include "qgsprintlayout.h"
#include "qgsreport.h"
% End
// clang-format on
#endif

  class CORE_EXPORT QgsMasterLayoutInterface
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    switch ( sipCpp->layoutType() )
    {
      case QgsMasterLayoutInterface::PrintLayout:
        sipType = sipType_QgsPrintLayout;
        *sipCppRet = static_cast<QgsPrintLayout *>( sipCpp );
        break;
      case QgsMasterLayoutInterface::Report:
        *sipCppRet = static_cast<QgsReport *>( sipCpp );
        sipType = sipType_QgsReport;
        break;
      default:
        sipType = NULL;
    }
  SIP_END
#endif
 
  public:

    enum Type
    {
      PrintLayout = 0, 
      Report = 1,      
    };
 
    virtual ~QgsMasterLayoutInterface() = default;

    virtual QgsMasterLayoutInterface *clone() const = 0 SIP_FACTORY;

    virtual QgsMasterLayoutInterface::Type layoutType() const = 0;

    virtual QString name() const = 0;

    virtual QIcon icon() const = 0;

    virtual void setName( const QString &name ) = 0;

    virtual QgsProject *layoutProject() const = 0;

    virtual QDomElement writeLayoutXml( QDomDocument &document, const QgsReadWriteContext &context ) const = 0;

    virtual bool readLayoutXml( const QDomElement &layoutElement, const QDomDocument &document, const QgsReadWriteContext &context ) = 0;

    virtual void updateSettings() = 0;

    virtual bool layoutAccept( QgsStyleEntityVisitorInterface *visitor ) const
    {
      Q_UNUSED( visitor );
      return true;
    }
};
 
#endif //QGSLAYOUTINTERFACE_H