src/Undo.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Undo.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  * \author Lars Gullik Bjønnes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Jürgen Vigna
  12  * \author Abdelrazak Younes
  13  *
  14  * Full author contact details are available in file CREDITS.
  15  */
  16
  17 #ifndef UNDO_H
  18 #define UNDO_H
  19
  20 #include "support/types.h"
  21
  22 namespace lyx {
  23
  24 class Buffer;
  25 class BufferParams;
  26 class CursorData;
  27 class Inset;
  28 class MathData;
  29 class ParagraphList;
  30
  31 /// This is used to combine consecutive undo recordings of the same kind.
  32 enum UndoKind {
  33         /**
  34         * Insert something - these will combine to one big chunk
  35         * when many inserts come after each other.
  36         */
  37         INSERT_UNDO,
  38         /**
  39         * Delete something - these will combine to one big chunk
  40         * when many deletes come after each other.
  41         */
  42         DELETE_UNDO,
  43         /// Atomic - each of these will have its own entry in the stack
  44         ATOMIC_UNDO
  45 };
  46
  47
  48 class Undo
  49 {
  50 public:
  51
  52         Undo(Buffer &);
  53
  54         ~Undo();
  55
  56         /// Clear out all undo/redo contents.
  57         void clear();
  58
  59         /// this will undo the last action - returns false if no undo possible
  60         bool textUndo(CursorData &);
  61
  62         /// this will redo the last undo - returns false if no redo possible
  63         bool textRedo(CursorData &);
  64
  65         /// End a sequence of INSERT_UNDO or DELETE_UNDO type of undo
  66         /// operations (grouping of consecutive characters insertion/deletion).
  67         void finishUndo();
  68
  69         ///
  70         bool hasUndoStack() const;
  71         ///
  72         bool hasRedoStack() const;
  73
  74         /// Mark all the elements of the undo and redo stacks as dirty
  75         void markDirty();
  76
  77         /// open a new group of undo operations.
  78         /**
  79          *  Groups can be nested. Such a nested group e.g. { {} {} } is undone in
  80          *  a single step. This means you can add a group whenever you are not sure.
  81          */
  82         void beginUndoGroup();
  83         /// open a new group as above and specify a cursor to set as cur_before
  84         /// of the group's undo elements.
  85         /**
  86          * This cursor takes precedence over what is passed to recordUndo.
  87          * In the case of nested groups, only the first cur_before is
  88          * taken in account. The cursor is reset at the end of the
  89          * top-level group.
  90          */
  91         void beginUndoGroup(CursorData const & cur_before);
  92         /// end the current undo group.
  93         void endUndoGroup();
  94         /// end the current undo group and set UndoElement::cur_after if necessary.
  95         void endUndoGroup(CursorData const & cur_after);
  96
  97         /// The general case: record undo information for an arbitrary range.
  98         /**
  99          * Record undo information - call with the current cursor and
 100          * the 'other end' of the range of changed paragraphs. So we
 101          * give an inclusive range. This is called before you make the
 102          * changes to the paragraph, and it will record the original
 103          * information of the paragraphs in the undo stack.
 104          * Kind of undo is always ATOMIC_UNDO.
 105          */
 106         void recordUndo(CursorData const & cur, pit_type from, pit_type to);
 107
 108         /// Convenience: record undo information for the single
 109         /// paragraph or cell containing the cursor.
 110         void recordUndo(CursorData const & cur, UndoKind kind = ATOMIC_UNDO);
 111
 112         /// prepare undo for the inset containing the cursor
 113         void recordUndoInset(CursorData const & cur, Inset const * inset);
 114
 115         /// Convenience: record undo for buffer parameters
 116         void recordUndoBufferParams(CursorData const & cur);
 117
 118         /// Convenience: prepare undo for the whole buffer
 119         void recordUndoFullBuffer(CursorData const & cur);
 120
 121 private:
 122         struct Private;
 123         Private * const d;
 124 };
 125
 126
 127 /** Helper class to simplify the use of undo groups across several buffers.
 128  *
 129  *  The undo group is created when the object is instanciated; it is
 130  *  then ended as the object goes out of scope or the buffer is reset
 131  *  (see below)
 132  */
 133 class UndoGroupHelper {
 134 public:
 135         UndoGroupHelper(Buffer * buf) : buffer_(0)
 136         {
 137                 resetBuffer(buf);
 138         }
 139
 140         ~UndoGroupHelper()
 141         {
 142                 resetBuffer(0);
 143         }
 144
 145         /** Close the current undo group if necessary and create a new one
 146          * for buffer \c buf.
 147          */
 148         void resetBuffer(Buffer * buf);
 149
 150 private:
 151         Buffer * buffer_;
 152 };
 153
 154
 155
 156 } // namespace lyx
 157
 158 #endif // UNDO_H