The way this was done here is inconsistent with how it is done

[features.git] / src / Undo.h

diff --git a/src/Undo.h b/src/Undo.h
index f91b02fe8fd7c0d13970bc4c6c9658b762265101..c2acf4af216b78060c7ed3893a965fbfecaa57aa 100644 (file)
--- a/src/Undo.h
+++ b/src/Undo.h
@@ -23,7 +23,7 @@ namespace lyx {
 
 class Buffer;
 class BufferParams;
-class DocIterator;
+class CursorData;
 class Inset;
 class MathData;
 class ParagraphList;
@@ -53,11 +53,14 @@ 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 &);
+       bool textUndo(CursorData &);
 
        /// this will redo the last undo - returns false if no redo possible
-       bool textRedo(DocIterator &);
+       bool textRedo(CursorData &);
 
        /// End a sequence of INSERT_UNDO or DELETE_UNDO type of undo
        /// operations (grouping of consecutive characters insertion/deletion).
@@ -81,6 +84,9 @@ public:
        /// end the current undo group.
        void endUndoGroup();
 
+       /// end the current undo group and set UndoElement::cur_after if necessary.
+       void endUndoGroup(CursorData const &);
+
        /// The general case: record undo information for an arbitrary range.
        /**
         * Record undo information - call with the current cursor and
@@ -88,26 +94,22 @@ 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.
+        * Kind of undo is always ATOMIC_UNDO.
         */
-       void recordUndo(DocIterator const & cur, UndoKind kind,
-               pit_type from, pit_type to);
-
-       /// Convenience: record undo information for the range between
-       /// 'from' and cursor.
-       void recordUndo(DocIterator const & cur, UndoKind kind, pit_type from);
+       void recordUndo(CursorData const & cur, pit_type from, pit_type to);
 
        /// Convenience: record undo information for the single
        /// paragraph or cell containing the cursor.
-       void recordUndo(DocIterator const & cur, UndoKind kind = ATOMIC_UNDO);
+       void recordUndo(CursorData const & cur, UndoKind kind = ATOMIC_UNDO);
+
+       /// prepare undo for the inset containing the cursor
+       void recordUndoInset(CursorData const & cur, Inset const * inset);
 
-       /// Convenience: record undo information for the inset
-       /// containing the cursor.
-       void recordUndoInset(DocIterator const & cur,
-                            UndoKind kind = ATOMIC_UNDO,
-                            Inset const * inset = 0);
+       /// Convenience: record undo for buffer parameters
+       void recordUndoBufferParams(CursorData const & cur);
 
        /// Convenience: prepare undo for the whole buffer
-       void recordUndoFullDocument(DocIterator const & cur);
+       void recordUndoFullBuffer(CursorData const & cur);
 
 private:
        struct Private;
@@ -115,6 +117,34 @@ private:
 };
 
 
+/** Helper class to simplify the use of undo groups across several buffers.
+ *
+ *  The undo group is created when the object is instanciated; it is
+ *  then ended as the object goes out of scope or the buffer is reset
+ *  (see below)
+ */
+class UndoGroupHelper {
+public:
+       UndoGroupHelper(Buffer * buf) : buffer_(0)
+       {
+               resetBuffer(buf);
+       }
+
+       ~UndoGroupHelper()
+       {
+               resetBuffer(0);
+       }
+
+       /** Close the current undo group if necessary and create a new one
+        * for buffer \c buf.
+        */
+       void resetBuffer(Buffer * buf);
+
+private:
+       Buffer * buffer_;
+};
+
+
 
 } // namespace lyx