File indexing completed on 2024-05-12 04:35:05

 /* This file is part of the TikZKit project.
  *
  * Copyright (C) 2015 Dominik Haumann <dhaumann@kde.org>
  *
  * This library is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Library General Public License as published
  * by the Free Software Foundation, either version 2 of the License, or
  * (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public License
  * along with this library; see the file COPYING.LIB.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
 
 #ifndef TIKZ_UNDO_MANAGER_H
 #define TIKZ_UNDO_MANAGER_H
 
 #include <QAbstractItemModel>
 #include <QList>
 
 namespace tikz {
 namespace core {
 
 class Document;
 class UndoManagerPrivate;
 class UndoGroup;
 class UndoItem;
 
 /**
  * Base class for undo/redo items.
  */
 class UndoManager : public QAbstractItemModel
 {
     Q_OBJECT
 
 public:
     /**
      * Constructor. Sets the associated tikz::core::document to @p doc.
      */
     UndoManager(Document* doc);
 
     /**
      * Virtual destructor.
      */
     virtual ~UndoManager();
 
     /**
      * Accessor to the tikz Document.
      */
     Document* document();
 
 public Q_SLOTS:
     /**
      * Mark the current undo/redo state as clean.
      * Typically, the clean state matches the modified state of the doucment.
      */
     void setClean();
 
 public:
     /**
      * Returns whether undo can currently be invoked or not.
      */
     bool undoAvailable() const;
 
     /**
      * Returns whether redo can currently be invoked or not.
      */
     bool redoAvailable() const;
 
     /**
      * Returns the clean state.
      */
     bool isClean() const;
 
 Q_SIGNALS:
     /**
      * This signal is emitted whenever the clean state changes.
      */
     void cleanChanged(bool clean);
 
 public Q_SLOTS:
     /**
      * Undo one undo/redo group.
      * This applies all items in the previous undo group
      */
     void undo();
 
     /**
      * Redo one undo/redo group.
      * This applies all items in the next redo group
      */
     void redo();
 
     /**
      * Remove all undo/redo items.
      */
     void clear();
 
     /**
      * Add the undo item @p item to the current undo group.
      */
     void addUndoItem(UndoItem *item);
 
 public:
     /**
      * Returns a list of all undo groups.
      * You must not delete the pointers to the UndoGroup%s.
      */
     QList<UndoGroup*> undoGroups() const;
 
 public:
     /**
      * Start a new undo group.
      * All items added through addUndoItem() are grouped together into one
      * undo/redo action. To finish a transaction, call commitTransaction().
      * If a currently pending transaction should be aborted (e.g., the user
      * pressed ESC), just call cancelTransaction() before finally calling
      * commitTransaction().
      * @param text the text of the undo item.
      *
      * @note startTransaction() and commitTransaction() are ref-counted.
      *       Always make sure these two calls are balanced.
      */
     void startTransaction(const QString & text = QString());
 
     /**
      * Cancel the currently pending transaction.
      *
      * If you call cancelTransaction(), all the added items are un-done
      * again and the currently pending undo/redo group is deleted.
      * @note Make sure to call commitTransaction(), though.
      */
     void cancelTransaction();
 
     /**
      * Commits the currently pending transaction, if it was not canceled
      * through cancelTransaction().
      */
     void commitTransaction();
 
     /**
      * Returns whether there is a currently pending transaction.
      */
     bool transactionActive() const;
 
 //
 // Implementation of QAbstractItemModel
 //
 public:
     /**
      * Returns a QModelIndex for the requested position.
      */
     QModelIndex index(int row, int column, const QModelIndex & parent = QModelIndex()) const override;
 
     /**
      * Returns a parent QModelIndex for @p index.
      */
     QModelIndex parent(const QModelIndex & index) const override;
 
     /**
      * Returns the number of child items (rows) for @p parent.
      */
     int rowCount(const QModelIndex & parent = QModelIndex()) const override;
 
     /**
      * Returns the number of columns for the index @p parent.
      */
     int columnCount(const QModelIndex & parent = QModelIndex()) const override;
 
     /**
      * Returns the data for @p index.
      */
     QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const override;
 
     /**
      * Inserts @p count rows starting at @p row.
      */
     bool insertRows(int row, int count, const QModelIndex & parent = QModelIndex()) override;
 
     /**
      * Removes @p count rows starting at @p row.
      */
     bool removeRows(int row, int count, const QModelIndex & parent = QModelIndex()) override;
 
 public:
     // for debugging
     void printTree();
 
 private:
     /**
      * Pimpl pointer to the held data.
      */
     UndoManagerPrivate * const d;
 };
 
 }
 }
 
 #endif // TIKZ_UNDO_MANAGER_H
 
 // kate: indent-width 4; replace-tabs on;