]> git.lyx.org Git - lyx.git/blobdiff - src/undo.h
fix reading the author field.
[lyx.git] / src / undo.h
index a45e97bff56493e78e23b73a3ab3903e14467a31..501ace924e1b0bc713d4d9b6ff9ea66ace85b1ed 100644 (file)
 #ifndef UNDO_H
 #define UNDO_H
 
+#include "dociterator.h"
 #include "ParagraphList_fwd.h"
+
 #include "support/types.h"
 
-class LyXText;
+#include <string>
+
+class LCursor;
 class BufferView;
 
+
 /**
  * These are the elements put on the undo stack. Each object
  * contains complete paragraphs and sufficient information
  * to restore the state.
  */
-class Undo {
-public:
-       /**
-        * The undo kinds are used to combine consecutive undo recordings
-        * of the same kind.
-        */
+struct Undo {
+       /// This is 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,
-
                /// Atomic - each of these will have its own entry in the stack
                ATOMIC
        };
-       /// constructor
-       Undo(undo_kind kind, int text, int index,
-               int first_par, int end_par, int cursor_par, int cursor_pos);
 
-       /// which kind of operation are we recording for?
+       /// Which kind of operation are we recording for?
        undo_kind kind;
-
-       /// hosting LyXText counted from buffer begin
-       int text;
-
-       /// cell in a tabular or similar
-       int index;
-
-       /// offset to the first paragraph in the paragraph list
-       int first_par;
-
-       /// offset to the last paragraph from the end of parargraph list
-       int end_par;
-
-       /// offset to the first paragraph in the paragraph list
-       int cursor_par;
-
-       /// the position of the cursor in the hosting paragraph
-       int cursor_pos;
-
-       /// the contents of the paragraphs saved
+       /// the position of the cursor
+       StableDocIterator cursor;
+       /// counted from begin of buffer
+       lyx::par_type from;
+       /// complement to end of this cell
+       lyx::par_type end;
+       /// the contents of the saved paragraphs (for texted)
        ParagraphList pars;
+       /// the contents of the saved matharray (for mathed)
+       std::string array;
 };
 
 
 /// this will undo the last action - returns false if no undo possible
-bool textUndo(BufferView *);
+bool textUndo(BufferView &);
 
 /// this will redo the last undo - returns false if no redo possible
-bool textRedo(BufferView *);
+bool textRedo(BufferView &);
 
 /// makes sure the next operation will be stored
 void finishUndo();
 
-/// whilst undo is frozen, all actions do not get added to the undo stack
-void freezeUndo();
-
-/// track undos again
-void unFreezeUndo();
 
 /**
- * Record undo information - call with the first paragraph that will be changed
- * and the last paragraph that will be changed. So we give an inclusive
- * range.
+ * Record undo information - call with the current cursor and the 'other
+ * end' of the range of changed  paragraphs.  So we 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.
  */
-void recordUndo(Undo::undo_kind kind,
-       LyXText const * text, lyx::paroffset_type first, lyx::paroffset_type last);
 
-/// convienience: prepare undo when change in a single paragraph
-void recordUndo(Undo::undo_kind kind,
-       LyXText const * text, lyx::paroffset_type par);
+/// The general case: prepare undo for an arbitrary range.
+void recordUndo(LCursor & cur, Undo::undo_kind kind,
+       lyx::par_type from, lyx::par_type to);
+
+/// Convenience: prepare undo for the range between 'from' and cursor.
+void recordUndo(LCursor & cur, Undo::undo_kind kind, lyx::par_type from);
 
-/// convienience: prepare undo for the paragraph that contains the cursor
-void recordUndo(BufferView *, Undo::undo_kind kind);
-void recordUndo(BufferView &, Undo::undo_kind kind);
+/// Convenience: prepare undo for the single paragraph or cell
+/// containing the cursor
+void recordUndo(LCursor & cur, Undo::undo_kind kind = Undo::ATOMIC);
+/// Convenience: prepare undo for the inset containing the cursor
+void recordUndoInset(LCursor & cur, Undo::undo_kind kind = Undo::ATOMIC);
+/// Convenience: prepare undo for the selected paragraphs
+void recordUndoSelection(LCursor & cur, Undo::undo_kind kind = Undo::ATOMIC);
 
-/// are we avoiding tracking undos currently?
-extern bool undo_frozen;
+/// Convenience: prepare undo for the single paragraph containing the cursor
+void recordUndoFullDocument(LCursor & cur);
 
 #endif // UNDO_FUNCS_H