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 LyXText;
  23 class BufferView;
  24
  25 /**
  26  * These are the elements put on the undo stack. Each object
  27  * contains complete paragraphs and sufficient information
  28  * to restore the state.
  29  */
  30 class Undo {
  31 public:
  32         /**
  33          * The undo kinds are used to combine consecutive undo recordings
  34          * of the same kind.
  35          */
  36         enum undo_kind {
  37                 /**
  38                  * Insert something - these will combine to one big chunk
  39                  * when many inserts come after each other.
  40                  */
  41                 INSERT,
  42
  43                 /**
  44                  * Delete something - these will combine to one big chunk
  45                  * when many deletes come after each other.
  46                  */
  47                 DELETE,
  48
  49                 /// Atomic - each of these will have its own entry in the stack
  50                 ATOMIC
  51         };
  52         /// constructor
  53         Undo(undo_kind kind, int text, int index,
  54                 int first_par, int end_par, int cursor_par, int cursor_pos);
  55
  56         /// which kind of operation are we recording for?
  57         undo_kind kind;
  58
  59         /// hosting LyXText counted from buffer begin
  60         int text;
  61
  62         /// cell in a tabular or similar
  63         int index;
  64
  65         /// offset to the first paragraph in the paragraph list
  66         int first_par;
  67
  68         /// offset to the last paragraph from the end of parargraph list
  69         int end_par;
  70
  71         /// offset to the first paragraph in the paragraph list
  72         int cursor_par;
  73
  74         /// the position of the cursor in the hosting paragraph
  75         int cursor_pos;
  76
  77         /// the contents of the paragraphs saved
  78         ParagraphList pars;
  79 };
  80
  81
  82 /// this will undo the last action - returns false if no undo possible
  83 bool textUndo(BufferView *);
  84
  85 /// this will redo the last undo - returns false if no redo possible
  86 bool textRedo(BufferView *);
  87
  88 /// makes sure the next operation will be stored
  89 void finishUndo();
  90
  91 /// whilst undo is frozen, all actions do not get added to the undo stack
  92 void freezeUndo();
  93
  94 /// track undos again
  95 void unFreezeUndo();
  96
  97 /**
  98  * Record undo information - call with the first paragraph that will be changed
  99  * and the last paragraph that will be changed. So we give an inclusive
 100  * range.
 101  * This is called before you make the changes to the paragraph, and it
 102  * will record the original information of the paragraphs in the undo stack.
 103  */
 104 void recordUndo(Undo::undo_kind kind,
 105         LyXText const * text, lyx::paroffset_type first, lyx::paroffset_type last);
 106
 107 /// convienience: prepare undo when change in a single paragraph
 108 void recordUndo(Undo::undo_kind kind,
 109         LyXText const * text, lyx::paroffset_type par);
 110
 111 /// convienience: prepare undo for the paragraph that contains the cursor
 112 void recordUndo(BufferView *, Undo::undo_kind kind);
 113
 114 /// are we avoiding tracking undos currently?
 115 extern bool undo_frozen;
 116
 117 #endif // UNDO_FUNCS_H