qgslayoutundostack.h

Go to the documentation of this file.

/***************************************************************************
                          qgslayoutundostack.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 QGSLAYOUTUNDOSTACK_H
#define QGSLAYOUTUNDOSTACK_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayoutitem.h"
#include "qgslayoutundocommand.h"
 
class QgsLayout;
class QUndoStack;

class CORE_EXPORT QgsLayoutUndoStack : public QObject
{
    Q_OBJECT
 
  public:
    QgsLayoutUndoStack( QgsLayout *layout );

    void beginMacro( const QString &commandText );

    void endMacro();

    void beginCommand( QgsLayoutUndoObjectInterface *object, const QString &commandText, int id = 0 );

    void endCommand();

    void cancelCommand();

    QUndoStack *stack();

    void notifyUndoRedoOccurred( QgsLayoutItem *item );

    void blockCommands( bool blocked );

    bool isBlocked() const;

    void push( QUndoCommand *command SIP_TRANSFER );
 
  signals:

    void undoRedoOccurredForItems( QSet< QString > itemUuids );
 
  private slots:
 
    void indexChanged();
 
  private:
    QgsLayout *mLayout = nullptr;
 
    std::unique_ptr< QUndoStack > mUndoStack;
 
    std::vector< std::unique_ptr< QgsAbstractLayoutUndoCommand > > mActiveCommands;
 
    QSet< QString > mUndoRedoOccurredItemUuids;
 
    int mBlockedCommands = 0;
 
#ifdef SIP_RUN
    QgsLayoutUndoStack( const QgsLayoutUndoStack &other );
#endif
};
 
#endif // QGSLAYOUTUNDOCOMMAND_H