qgslayoutundocommand.h

Go to the documentation of this file.

/***************************************************************************
                          qgslayoutundocommand.h
                          ----------------------
    begin                : July 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 QGSLAYOUTUNDOCOMMAND_H
#define QGSLAYOUTUNDOCOMMAND_H

#include <QUndoCommand>
#include "qgis.h"
#include <QDomDocument>

#include "qgis_core.h"

class QgsLayout;

class CORE_EXPORT QgsAbstractLayoutUndoCommand: public QUndoCommand
{
  public:

    QgsAbstractLayoutUndoCommand( const QString &text, int id = 0, QUndoCommand *parent SIP_TRANSFERTHIS = nullptr );

    void undo() override;
    void redo() override;
    int id() const override { return mId; }

    void saveBeforeState();

    void saveAfterState();

    QDomDocument beforeState() const { return mBeforeState.cloneNode().toDocument(); }

    QDomDocument afterState() const { return mAfterState.cloneNode().toDocument(); }

    virtual bool containsChange() const;

  protected:

    virtual void saveState( QDomDocument &stateDoc ) const = 0;

    virtual void restoreState( QDomDocument &stateDoc ) = 0;

    void setAfterState( const QDomDocument &stateDoc );

    bool mFirstRun = true;

  private:

    QDomDocument mBeforeState;

    QDomDocument mAfterState;

    int mId = 0;

};

class CORE_EXPORT QgsLayoutUndoObjectInterface
{
  public:

    virtual ~QgsLayoutUndoObjectInterface() = default;

    virtual QgsAbstractLayoutUndoCommand *createCommand( const QString &text, int id = 0, QUndoCommand *parent = nullptr ) = 0 SIP_FACTORY;
};


#endif // QGSLAYOUTUNDOCOMMAND_H