src/undo.h

   1 // -*- C++ -*-
   2 /**
   3  * \file undo.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  * \author Lars Gullik Bjønnes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Jürgen Vigna
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #ifndef UNDO_H
  17 #define UNDO_H
  18
  19 #include "ParagraphList_fwd.h"
  20 #include "support/types.h"
  21
  22 class LCursor;
  23 class BufferView;
  24
  25
  26 /**
  27  * These are the elements put on the undo stack. Each object
  28  * contains complete paragraphs and sufficient information
  29  * to restore the state.
  30  */
  31 class Undo {
  32 public:
  33         /// This is used to combine consecutive undo recordings of the same kind.
  34         enum undo_kind {
  35                 /**
  36                  * Insert something - these will combine to one big chunk
  37                  * when many inserts come after each other.
  38                  */
  39                 INSERT,
  40                 /**
  41                  * Delete something - these will combine to one big chunk
  42                  * when many deletes come after each other.
  43                  */
  44                 DELETE,
  45                 /// Atomic - each of these will have its own entry in the stack
  46                 ATOMIC
  47         };
  48
  49         /// constructor
  50         Undo(undo_kind kind, int text, int index,
  51                 int first_par, int end_par, int cursor_par, int cursor_pos);
  52
  53 public:
  54         /// which kind of operation are we recording for?
  55         undo_kind kind;
  56         /// hosting LyXText counted from buffer begin
  57         int text;
  58         /// cell in a tabular or similar
  59         int index;
  60         /// offset to the first paragraph in the paragraph list
  61         int first_par;
  62         /// offset to the last paragraph from the end of paragraph list
  63         int end_par;
  64         /// offset to the first paragraph in the paragraph list
  65         int cursor_par;
  66         /// the position of the cursor in the hosting paragraph
  67         int cursor_pos;
  68         /// the contents of the paragraphs saved
  69         ParagraphList pars;
  70 };
  71
  72
  73 /// this will undo the last action - returns false if no undo possible
  74 bool textUndo(BufferView &);
  75
  76 /// this will redo the last undo - returns false if no redo possible
  77 bool textRedo(BufferView &);
  78
  79 /// makes sure the next operation will be stored
  80 void finishUndo();
  81
  82 /// whilst undo is frozen, all actions do not get added to the undo stack
  83 void freezeUndo();
  84
  85 /// track undos again
  86 void unFreezeUndo();
  87
  88
  89 /**
  90  * Record undo information - call with the current cursor and the 'other
  91  * end' of the range of changed  paragraphs.  So we give an inclusive range.
  92  * This is called before you make the changes to the paragraph, and it
  93  * will record the original information of the paragraphs in the undo stack.
  94  */
  95
  96 /// the common case: prepare undo for an arbitrary range
  97 void recordUndo(LCursor & cur, Undo::undo_kind kind,
  98         lyx::paroffset_type from, lyx::paroffset_type to);
  99
 100 /// convienience: prepare undo for the range between 'from' and cursor.
 101 void recordUndo(LCursor & cur, Undo::undo_kind kind, lyx::paroffset_type from);
 102
 103 /// convienience: prepare undo for the single paragraph containing the cursor
 104 void recordUndo(LCursor & cur, Undo::undo_kind kind);
 105
 106 /// convienience: prepare undo for the single paragraph containing the cursor
 107 void recordUndoFullDocument(LCursor & cur);
 108
 109 /// are we avoiding tracking undos currently?
 110 extern bool undo_frozen;
 111
 112 #endif // UNDO_FUNCS_H