Point fix, earlier forgotten

[lyx.git] / src / undo_funcs.h

diff --git a/src/undo_funcs.h b/src/undo_funcs.h
index 0633f64881c8f9fbd4dcd6384104a1aa6a1f7abb..137843bcae51281d36335c4a44faddaa5e9b6dbb 100644 (file)
--- a/src/undo_funcs.h
+++ b/src/undo_funcs.h
@@ -1,12 +1,17 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
+/**
+ * \file undo_funcs.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author Asger Alstrup
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ * \author André Pönitz
+ * \author Jürgen Vigna
  *
- *           Copyright 1995-2001 The LyX Team.
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
 
 #ifndef UNDO_FUNCS_H
 #define UNDO_FUNCS_H
@@ -17,25 +22,39 @@
 class BufferView;
 class Paragraph;
 
-/// returns false if no undo possible
-extern bool textUndo(BufferView *);
-/// returns false if no redo possible
-extern bool textRedo(BufferView *);
-/// makes sure the next operation will be stored
-extern void finishUndo();
-/// Whilst undo is frozen, all actions do not get added
-/// to the undo stack
-extern void freezeUndo();
+/// This will undo the last action - returns false if no undo possible
+bool textUndo(BufferView *);
+
+/// This will redo the last undo - returns false if no redo possible
+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
-extern void unFreezeUndo();
-/// FIXME
-extern void setUndo(BufferView *, Undo::undo_kind kind,
-                   ParagraphList::iterator first, ParagraphList::iterator behind);
-/// FIXME
-extern void setRedo(BufferView *, Undo::undo_kind kind,
-                   ParagraphList::iterator first, ParagraphList::iterator behind);
-/// FIXME
-extern void setCursorParUndo(BufferView *);
+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.
+ * 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(BufferView *, Undo::undo_kind kind,
+                   ParagraphList::iterator first, ParagraphList::iterator last);
+/// Convienience: Prepare undo when change in a single paragraph.
+void recordUndo(BufferView *, Undo::undo_kind kind,
+                   ParagraphList::iterator first);
+
+/// Convienience: Prepare undo for the paragraph that contains the cursor
+void recordUndo(BufferView *, Undo::undo_kind kind);
 
 /// Are we avoiding tracking undos currently ?
 extern bool undo_frozen;