]> git.lyx.org Git - lyx.git/blobdiff - src/undo_funcs.h
ws changes only
[lyx.git] / src / undo_funcs.h
index 1a9aea9de5f6232bbfa12b6e6f55ff2f6b76ce32..f34005dca6360d0af54212319a5c35472f929959 100644 (file)
@@ -1,29 +1,34 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- *           LyX, The Document Processor
+/**
+ * \file undo_funcs.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           Copyright 1995-2001 The LyX Team.
+ * \author Asger Alstrup
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ * \author André Pönitz
+ * \author Jürgen Vigna
  *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
 
 #ifndef UNDO_FUNCS_H
 #define UNDO_FUNCS_H
 
 #include "undo.h"
-#include "ParagraphList.h"
+#include "ParagraphList_fwd.h"
 
 class BufferView;
 class Paragraph;
 
-/// returns false if no undo possible
+/// This will undo the last action - returns false if no undo possible
 bool textUndo(BufferView *);
 
-/// returns false if no redo possible
+/// This will redo the last undo - returns false if no redo possible
 bool textRedo(BufferView *);
 
-/// makes sure the next operation will be stored
+/// Makes sure the next operation will be stored
 void finishUndo();
 
 /**
@@ -42,17 +47,14 @@ void unFreezeUndo();
  * 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 setUndo(BufferView *, Undo::undo_kind kind,
+void recordUndo(BufferView *, Undo::undo_kind kind,
                    ParagraphList::iterator first, ParagraphList::iterator last);
 /// Convienience: Prepare undo when change in a single paragraph.
-void setUndo(BufferView *, Undo::undo_kind kind,
+void recordUndo(BufferView *, Undo::undo_kind kind,
                    ParagraphList::iterator first);
 
 /// Convienience: Prepare undo for the paragraph that contains the cursor
-void setUndo(BufferView *, Undo::undo_kind kind);
-
-/// Convienience: Prepare and finish undo for the paragraph that contains the cursor
-void setCursorParUndo(BufferView *);
+void recordUndo(BufferView *, Undo::undo_kind kind);
 
 /// Are we avoiding tracking undos currently ?
 extern bool undo_frozen;