rename Inset to InsetOld

[lyx.git] / src / undo.h

diff --git a/src/undo.h b/src/undo.h
index e0c4899d9223bed37157ae9ae03087e2e724bdfa..b9c8e3df990afcbfba20d61acbf28aaa5d2897d2 100644 (file)
--- a/src/undo.h
+++ b/src/undo.h
@@ -1,9 +1,9 @@
 // -*- C++ -*-
 /* This file is part of
  * ======================================================
- * 
+ *
  *           LyX, The Document Processor
- *      
+ *
  *           Copyright 1995 Matthias Ettrich
  *           Copyright 1995-2001 The LyX Team.
  *
@@ -12,47 +12,69 @@
 #ifndef UNDO_H
 #define UNDO_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-class Paragraph;
+#include "ParagraphList.h"
 
-///
+/**
+ * These are the elements put on the undo stack. Each object
+ * contains complete paragraphs and sufficient information
+ * to restore the state. The work is done in undo_funcs.C
+ */
 class Undo {
 public:
-       /// The undo kinds
+       /**
+        * The undo kinds are used to combine consecutive undo recordings
+        * of the same kind.
+        */
        enum undo_kind {
-               ///
+               /**
+                * Insert something - these will combine to one big chunk
+                * when many inserts come after each other.
+                */
                INSERT,
-               ///
+
+               /**
+                * Delete something - these will combine to one big chunk
+                * when many deletes come after each other.
+                */
                DELETE,
-               ///
-               EDIT,
-               ///
-               FINISH
+
+               /// Atomic - each of these will have its own entry in the stack
+               ATOMIC
        };
        ///
+       Undo(undo_kind kind, int inset_id,
+            int first, int last,
+            int cursor, int cursor_pos,
+            ParagraphList const & par_arg);
+
+       /// Which kind of operation are we recording for?
        undo_kind kind;
-       ///
-       int number_of_before_par;
-       ///
-       int number_of_behind_par;
-       ///
-       int number_of_cursor_par;
-       ///
-       int number_of_inset_id; // valid if >= 0, if < 0 then not in inset
-       ///
-       int cursor_pos; // valid if >= 0
-       ///
-       Paragraph * par;
-       ///
-       Undo(undo_kind kind_arg, int id_inset_arg,
-            int number_before_arg, int number_behind_arg,
-            int cursor_par_arg, int cursor_pos_arg,
-            Paragraph * par_arg);
-       ///
-       ~Undo();
+
+       /**
+        * ID of hosting inset if the cursor is in one. 
+        * if -1, then the cursor is not in an inset.
+        * if >= 0, then the cursor is in inset with given id.
+        */ 
+       int inset_id;
+
+       /// Offset to the first paragraph in the main document paragraph list
+       int first_par_offset;
+
+       /// Offset to the last paragraph from the end of the main par. list
+       int last_par_offset;
+
+       /**
+        * Offset from the start of the main document paragraph list,
+        * except if inside an inset, in which case it's the offset
+        * inside the hosting inset.
+        */
+       int cursor_par_offset;
+
+       /// The position of the cursor in the hosting paragraph
+       int cursor_pos;
+
+       /// The contents of the paragraphs saved
+       ParagraphList pars;
 };