X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FUndo.h;h=d5748a97ea4b116e5ce33e4b6b26653780345afd;hb=612109bb6e5e61ba3c3693696f329eac3a288b5b;hp=b0889319ab988f027475b7374bb33efd47d95230;hpb=17dd64586252db85b4b8268b400afe4402ec5024;p=lyx.git

diff --git a/src/Undo.h b/src/Undo.h
index b0889319ab..d5748a97ea 100644
--- 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;
 
@@ -44,19 +45,6 @@ enum UndoKind {
 };
 
 
-/**
- * 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.
- *
- * 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.
- */
 class Undo
 {
 public:
@@ -65,13 +53,17 @@ 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 &);
 
 	/// this will redo the last undo - returns false if no redo possible
 	bool textRedo(DocIterator &);
 
-	/// makes sure the next operation will be stored
+	/// End a sequence of INSERT_UNDO or DELETE_UNDO type of undo
+	/// operations (grouping of consecutive characters insertion/deletion).
 	void finishUndo();
 
 	///
@@ -79,24 +71,46 @@ 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
+	/// end the current undo group.
 	void endUndoGroup();
 
-	/// The general case: prepare undo for an arbitrary range.
+	/// end the current undo group and set UndoElement::cur_after if necessary.
+	void endUndoGroup(DocIterator const &);
+
+	/// The general case: record undo information for an arbitrary 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(DocIterator const & cur, UndoKind kind,
 		pit_type from, pit_type to);
 
-	/// Convenience: prepare undo for the range between 'from' and cursor.
+	/// Convenience: record undo information for the range between
+	/// 'from' and cursor.
 	void recordUndo(DocIterator const & cur, UndoKind kind, pit_type from);
 
-	/// Convenience: prepare undo for the single paragraph or cell
-	/// containing the cursor
+	/// Convenience: record undo information for the single
+	/// paragraph or cell containing the cursor.
 	void recordUndo(DocIterator const & cur, UndoKind kind = ATOMIC_UNDO);
-	/// Convenience: prepare undo for the inset containing the cursor
-	void recordUndoInset(DocIterator const & cur, UndoKind kind = ATOMIC_UNDO);
+
+	/// Convenience: record undo information for the inset
+	/// containing the cursor.
+	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);