4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup
8 * \author Lars Gullik Bjønnes
10 * \author André Pönitz
11 * \author Jürgen Vigna
13 * Full author contact details are available in file CREDITS.
19 #include "ParagraphList_fwd.h"
20 #include "support/types.h"
26 * These are the elements put on the undo stack. Each object
27 * contains complete paragraphs and sufficient information
28 * to restore the state.
33 * The undo kinds are used to combine consecutive undo recordings
38 * Insert something - these will combine to one big chunk
39 * when many inserts come after each other.
44 * Delete something - these will combine to one big chunk
45 * when many deletes come after each other.
49 /// Atomic - each of these will have its own entry in the stack
53 Undo(undo_kind kind, int text,
55 int cursor, int cursor_pos,
56 ParagraphList const & par_arg);
58 /// Which kind of operation are we recording for?
61 /// hosting LyXText counted from buffer begin
64 /// Offset to the first paragraph in the main document paragraph list
67 /// Offset to the last paragraph from the end of the main par. list
71 * Offset from the start of the main document paragraph list,
72 * except if inside an inset, in which case it's the offset
73 * inside the hosting inset.
75 int cursor_par_offset;
77 /// The position of the cursor in the hosting paragraph
80 /// The contents of the paragraphs saved
85 /// This will undo the last action - returns false if no undo possible
86 bool textUndo(BufferView *);
88 /// This will redo the last undo - returns false if no redo possible
89 bool textRedo(BufferView *);
91 /// Makes sure the next operation will be stored
95 * Whilst undo is frozen, all actions do not get added
100 /// Track undos again
104 * Record undo information - call with the first paragraph that will be changed
105 * and the last paragraph that will be changed. So we give an inclusive
107 * This is called before you make the changes to the paragraph, and it
108 * will record the original information of the paragraphs in the undo stack.
110 void recordUndo(Undo::undo_kind kind,
111 LyXText const * text, lyx::paroffset_type first, lyx::paroffset_type last);
113 /// Convienience: Prepare undo when change in a single paragraph.
114 void recordUndo(Undo::undo_kind kind,
115 LyXText const * text, lyx::paroffset_type par);
117 /// Convienience: Prepare undo for the paragraph that contains the cursor
118 void recordUndo(BufferView *, Undo::undo_kind kind);
120 /// Are we avoiding tracking undos currently ?
121 extern bool undo_frozen;
123 #endif // UNDO_FUNCS_H