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 "dociterator.h"
20 #include "ParagraphList_fwd.h"
22 #include "support/types.h"
31 * These are the elements put on the undo stack. Each object
32 * contains complete paragraphs and sufficient information
33 * to restore the state.
36 /// This is used to combine consecutive undo recordings of the same kind.
39 * Insert something - these will combine to one big chunk
40 * 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.
48 /// Atomic - each of these will have its own entry in the stack
52 /// which kind of operation are we recording for?
54 /// the position of the cursor
55 StableDocumentIterator cursor;
56 /// counted from begin of buffer
57 lyx::paroffset_type from;
58 /// complement to end of this cell
59 lyx::paroffset_type end;
60 /// the contents of the saved paragraphs (for texted)
62 /// the contents of the saved matharray (for mathed)
67 /// this will undo the last action - returns false if no undo possible
68 bool textUndo(BufferView &);
70 /// this will redo the last undo - returns false if no redo possible
71 bool textRedo(BufferView &);
73 /// makes sure the next operation will be stored
78 * Record undo information - call with the current cursor and the 'other
79 * end' of the range of changed paragraphs. So we give an inclusive range.
80 * This is called before you make the changes to the paragraph, and it
81 * will record the original information of the paragraphs in the undo stack.
84 /// the common case: prepare undo for an arbitrary range
85 void recordUndo(LCursor & cur, Undo::undo_kind kind,
86 lyx::paroffset_type from, lyx::paroffset_type to);
88 /// convienience: prepare undo for the range between 'from' and cursor.
89 void recordUndo(LCursor & cur, Undo::undo_kind kind, lyx::paroffset_type from);
91 /// convienience: prepare undo for the single paragraph containing the cursor
92 void recordUndo(LCursor & cur, Undo::undo_kind kind = Undo::ATOMIC);
93 /// convienience: prepare undo for the selected paragraphs
94 void recordUndoSelection(LCursor & cur, Undo::undo_kind kind = Undo::ATOMIC);
96 /// convienience: prepare undo for the single paragraph containing the cursor
97 void recordUndoFullDocument(LCursor & cur);
99 #endif // UNDO_FUNCS_H