Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                           qgslayoutserializableobject.h
       3                 :            :                           -----------------------------
       4                 :            :     begin                : July 2017
       5                 :            :     copyright            : (C) 2017 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            : ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSLAYOUTSERIALIZABLEOBJECT_H
      19                 :            : #define QGSLAYOUTSERIALIZABLEOBJECT_H
      20                 :            : 
      21                 :            : #include "qgis_sip.h"
      22                 :            : #include "qgis_core.h"
      23                 :            : #include "qgslayoutundocommand.h"
      24                 :            : 
      25                 :            : class QDomElement;
      26                 :            : class QDomDocument;
      27                 :            : class QgsReadWriteContext;
      28                 :            : class QgsAbstractLayoutUndoCommand;
      29                 :            : 
      30                 :            : /**
      31                 :            :  * \ingroup core
      32                 :            :  * \brief An interface for layout objects which can be stored and read from DOM elements.
      33                 :            :  * \since QGIS 3.0
      34                 :            : */
      35                 :          0 : class CORE_EXPORT QgsLayoutSerializableObject : public QgsLayoutUndoObjectInterface
      36                 :            : {
      37                 :            :   public:
      38                 :            : 
      39                 :            :     /**
      40                 :            :      * Returns the object type as a string.
      41                 :            :      *
      42                 :            :      * This string must be a unique, single word, character only representation of the item type, eg "LayoutScaleBar"
      43                 :            :      */
      44                 :            :     virtual QString stringType() const = 0;
      45                 :            : 
      46                 :            :     /**
      47                 :            :      * Returns the layout the object belongs to.
      48                 :            :      */
      49                 :            :     virtual QgsLayout *layout() = 0;
      50                 :            : 
      51                 :            :     /**
      52                 :            :      * Stores the objects's state in a DOM element. The \a parentElement should refer to the parent layout's DOM element.
      53                 :            :      * \see readXml()
      54                 :            :      */
      55                 :            :     virtual bool writeXml( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context ) const = 0;
      56                 :            : 
      57                 :            :     /**
      58                 :            :      * Sets the objects's state from a DOM element. \a element is the DOM node corresponding to the object.
      59                 :            :      * \see writeXml()
      60                 :            :      */
      61                 :            :     virtual bool readXml( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) = 0;
      62                 :            : 
      63                 :            :     QgsAbstractLayoutUndoCommand *createCommand( const QString &text, int id, QUndoCommand *parent = nullptr ) override SIP_FACTORY;
      64                 :            : 
      65                 :            :   private:
      66                 :            : 
      67                 :            :     friend class QgsLayoutSerializableObjectUndoCommand;
      68                 :            : 
      69                 :            : };
      70                 :            : 
      71                 :            : #endif // QGSLAYOUTSERIALIZABLEOBJECT_H