listerrors.lyx : Update a link.

[lyx.git] / src / Undo.h

diff --git a/src/Undo.h b/src/Undo.h
index 20e3445d60a5fe0810d1d62cc4eb27adc4a71265..5f6694104a6e72c1094fc53ffa8ff2d9bac7e448 100644 (file)
--- a/src/Undo.h
+++ b/src/Undo.h
@@ -5,10 +5,10 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Asger Alstrup
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author John Levon
- * \author André Pönitz
- * \author Jürgen Vigna
+ * \author André Pönitz
+ * \author Jürgen Vigna
  * \author Abdelrazak Younes
  *
  * Full author contact details are available in file CREDITS.
@@ -24,6 +24,7 @@ namespace lyx {
 class Buffer;
 class BufferParams;
 class DocIterator;
+class Inset;
 class MathData;
 class ParagraphList;
 
@@ -52,6 +53,9 @@ public:
 
        ~Undo();
 
+       /// Clear out all undo/redo contents.
+       void clear();
+
        /// this will undo the last action - returns false if no undo possible
        bool textUndo(DocIterator &);
 
@@ -59,7 +63,7 @@ public:
        bool textRedo(DocIterator &);
 
        /// End a sequence of INSERT_UNDO or DELETE_UNDO type of undo
-       /// operations.
+       /// operations (grouping of consecutive characters insertion/deletion).
        void finishUndo();
 
        ///
@@ -67,7 +71,14 @@ public:
        ///
        bool hasRedoStack() const;
 
-       /// open a new group of undo operations. Groups can be nested.
+       /// Mark all the elements of the undo and redo stacks as dirty
+       void markDirty();
+
+       /// open a new group of undo operations.
+       /**
+        *  Groups can be nested. Such a nested group e.g. { {} {} } is undone in
+        *  a single step. This means you can add a group whenever you are not sure.
+        */
        void beginUndoGroup();
 
        /// end the current undo group.
@@ -80,14 +91,6 @@ public:
         * give an inclusive range. This is called before you make the
         * changes to the paragraph, and it will record the original
         * information of the paragraphs in the undo stack.
-        *
-        * FIXME: We need something to record undo in partial grids
-        * for mathed. Right now we use recordUndoInset if more than
-        * one cell is changed, but that puts the cursor in front of
-        * the inset after undo. We would need something like
-        * recordUndoGrid(DocIterator & cur, UndoKind kind, idx_type
-        * from, idx_type to); and store the cell information in class
-        * Undo.
         */
        void recordUndo(DocIterator const & cur, UndoKind kind,
                pit_type from, pit_type to);
@@ -102,8 +105,9 @@ public:
 
        /// Convenience: record undo information for the inset
        /// containing the cursor.
-       void recordUndoInset(DocIterator const & cur, 
-                            UndoKind kind = ATOMIC_UNDO);
+       void recordUndoInset(DocIterator const & cur,
+                            UndoKind kind = ATOMIC_UNDO,
+                            Inset const * inset = 0);
 
        /// Convenience: prepare undo for the whole buffer
        void recordUndoFullDocument(DocIterator const & cur);