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"
29 * These are the elements put on the undo stack. Each object
30 * contains complete paragraphs and sufficient information
31 * to restore the state.
34 /// This is used to combine consecutive undo recordings of the same kind.
37 * Insert something - these will combine to one big chunk
38 * when many inserts come after each other.
42 * Delete something - these will combine to one big chunk
43 * when many deletes come after each other.
46 /// Atomic - each of these will have its own entry in the stack
50 /// which kind of operation are we recording for?
52 /// hosting LyXText counted from buffer begin
54 /// cell in a tabular or similar
56 /// offset to the first paragraph in the paragraph list
58 /// offset to the last paragraph from the end of paragraph list
60 /// offset to the first paragraph in the paragraph list
62 /// the position of the cursor in the hosting paragraph
64 /// the contents of the saved paragraphs (for texted)
66 /// the contents of the saved matharray (for mathed)
73 /// this will undo the last action - returns false if no undo possible
74 bool textUndo(BufferView &);
76 /// this will redo the last undo - returns false if no redo possible
77 bool textRedo(BufferView &);
79 /// makes sure the next operation will be stored
82 /// whilst undo is frozen, no actions gets added to the undo stack
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.
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);
100 /// convienience: prepare undo for the range between 'from' and cursor.
101 void recordUndo(LCursor & cur, Undo::undo_kind kind, lyx::paroffset_type from);
103 /// convienience: prepare undo for the single paragraph containing the cursor
104 void recordUndo(LCursor & cur, Undo::undo_kind kind = Undo::ATOMIC);
105 /// convienience: prepare undo for the selected paragraphs
106 void recordUndoSelection(LCursor & cur, Undo::undo_kind kind = Undo::ATOMIC);
108 /// convienience: prepare undo for the single paragraph containing the cursor
109 void recordUndoFullDocument(LCursor & cur);
111 #endif // UNDO_FUNCS_H