Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                           qgslayoutundocommand.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 QGSLAYOUTUNDOCOMMAND_H
      19                 :            : #define QGSLAYOUTUNDOCOMMAND_H
      20                 :            : 
      21                 :            : #include <QUndoCommand>
      22                 :            : #include "qgis_sip.h"
      23                 :            : #include <QDomDocument>
      24                 :            : 
      25                 :            : #include "qgis_core.h"
      26                 :            : 
      27                 :            : class QgsLayout;
      28                 :            : 
      29                 :            : /**
      30                 :            :  * \ingroup core
      31                 :            :  * \brief Base class for commands to undo/redo layout and layout object changes.
      32                 :            :  * \since QGIS 3.0
      33                 :            : */
      34                 :          0 : class CORE_EXPORT QgsAbstractLayoutUndoCommand: public QUndoCommand
      35                 :            : {
      36                 :            :   public:
      37                 :            : 
      38                 :            :     /**
      39                 :            :      * Constructor for QgsLayoutUndoCommand.
      40                 :            :      * The \a id argument can be used to specify an id number for the source event - this is used to determine whether QUndoCommand
      41                 :            :      * command compression can apply to the command.
      42                 :            :      */
      43                 :            :     QgsAbstractLayoutUndoCommand( const QString &text, int id = 0, QUndoCommand *parent SIP_TRANSFERTHIS = nullptr );
      44                 :            : 
      45                 :            :     void undo() override;
      46                 :            :     void redo() override;
      47                 :          0 :     int id() const override { return mId; }
      48                 :            : 
      49                 :            :     /**
      50                 :            :      * Saves current layout state as before state.
      51                 :            :      * \see beforeState()
      52                 :            :      * \see saveAfterState()
      53                 :            :      */
      54                 :            :     void saveBeforeState();
      55                 :            : 
      56                 :            :     /**
      57                 :            :      * Saves current layout state as after state.
      58                 :            :      * \see afterState()
      59                 :            :      * \see saveBeforeState()
      60                 :            :      */
      61                 :            :     void saveAfterState();
      62                 :            : 
      63                 :            :     /**
      64                 :            :      * Returns the before state for the layout.
      65                 :            :      * \see saveBeforeState()
      66                 :            :      * \see afterState()
      67                 :            :      */
      68                 :            :     QDomDocument beforeState() const { return mBeforeState.cloneNode().toDocument(); }
      69                 :            : 
      70                 :            :     /**
      71                 :            :      * Returns the after state for the layout.
      72                 :            :      * \see saveAfterState()
      73                 :            :      * \see beforeState()
      74                 :            :      */
      75                 :          0 :     QDomDocument afterState() const { return mAfterState.cloneNode().toDocument(); }
      76                 :            : 
      77                 :            :     /**
      78                 :            :      * Returns TRUE if both the before and after states are valid and different.
      79                 :            :      */
      80                 :            :     virtual bool containsChange() const;
      81                 :            : 
      82                 :            :   protected:
      83                 :            : 
      84                 :            :     /**
      85                 :            :      * Saves the state of the object to the specified \a stateDoc.
      86                 :            :      *
      87                 :            :      * Subclasses must implement this to handle encapsulating their current state into a DOM document.
      88                 :            :      *
      89                 :            :      * \see restoreState()
      90                 :            :      */
      91                 :            :     virtual void saveState( QDomDocument &stateDoc ) const = 0;
      92                 :            : 
      93                 :            :     /**
      94                 :            :      * Restores the state of the object from the specified \a stateDoc.
      95                 :            :      *
      96                 :            :      * Subclasses must implement this to handle restoring their current state from the encapsulated state.
      97                 :            :      *
      98                 :            :      * \see saveState()
      99                 :            :      */
     100                 :            :     virtual void restoreState( QDomDocument &stateDoc ) = 0;
     101                 :            : 
     102                 :            :     /**
     103                 :            :      * Manually sets the after state for the command. Generally this should not be called directly.
     104                 :            :      */
     105                 :            :     void setAfterState( const QDomDocument &stateDoc );
     106                 :            : 
     107                 :            :     //! Flag to prevent the first redo() if the command is pushed to the undo stack
     108                 :            :     bool mFirstRun = true;
     109                 :            : 
     110                 :            :   private:
     111                 :            : 
     112                 :            :     //! XML that saves the state before executing the command
     113                 :            :     QDomDocument mBeforeState;
     114                 :            : 
     115                 :            :     //! XML containing the state after executing the command
     116                 :            :     QDomDocument mAfterState;
     117                 :            : 
     118                 :            :     //! Command id
     119                 :            :     int mId = 0;
     120                 :            : 
     121                 :            : };
     122                 :            : 
     123                 :            : /**
     124                 :            :  * \ingroup core
     125                 :            :  * \brief Interface for layout objects which support undo/redo commands.
     126                 :            :  * \since QGIS 3.0
     127                 :            :  */
     128                 :          0 : class CORE_EXPORT QgsLayoutUndoObjectInterface
     129                 :            : {
     130                 :            :   public:
     131                 :            : 
     132                 :            :     /**
     133                 :            :      * Destructor for QgsLayoutUndoObjectInterface.
     134                 :            :      */
     135                 :          0 :     virtual ~QgsLayoutUndoObjectInterface() = default;
     136                 :            : 
     137                 :            :     /**
     138                 :            :      * Creates a new layout undo command with the specified \a text and \a parent.
     139                 :            :      *
     140                 :            :      * The \a id argument can be used to specify an id number for the source event - this is used to determine whether QUndoCommand
     141                 :            :      * command compression can apply to the command.
     142                 :            :      */
     143                 :            :     virtual QgsAbstractLayoutUndoCommand *createCommand( const QString &text, int id = 0, QUndoCommand *parent = nullptr ) = 0 SIP_FACTORY;
     144                 :            : };
     145                 :            : 
     146                 :            : 
     147                 :            : #endif // QGSLAYOUTUNDOCOMMAND_H