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
12 * \author Abdelrazak Younes
14 * Full author contact details are available in file CREDITS.
20 #include "support/types.h"
30 /// This is used to combine consecutive undo recordings of the same kind.
33 * Insert something - these will combine to one big chunk
34 * when many inserts come after each other.
38 * Delete something - these will combine to one big chunk
39 * when many deletes come after each other.
42 /// Atomic - each of these will have its own entry in the stack
55 /// this will undo the last action - returns false if no undo possible
56 bool textUndo(DocIterator &);
58 /// this will redo the last undo - returns false if no redo possible
59 bool textRedo(DocIterator &);
61 /// End a sequence of INSERT_UNDO or DELETE_UNDO type of undo
62 /// operations (grouping of consecutive characters insertion/deletion).
66 bool hasUndoStack() const;
68 bool hasRedoStack() const;
70 /// Mark all the elements of the undo and redo stacks as dirty
73 /// open a new group of undo operations.
75 * Groups can be nested. Such a nested group e.g. { {} {} } is undone in
76 * a single step. This means you can add a group whenever you are not sure.
78 void beginUndoGroup();
80 /// end the current undo group.
83 /// The general case: record undo information for an arbitrary range.
85 * Record undo information - call with the current cursor and
86 * the 'other end' of the range of changed paragraphs. So we
87 * give an inclusive range. This is called before you make the
88 * changes to the paragraph, and it will record the original
89 * information of the paragraphs in the undo stack.
91 void recordUndo(DocIterator const & cur, UndoKind kind,
92 pit_type from, pit_type to);
94 /// Convenience: record undo information for the range between
95 /// 'from' and cursor.
96 void recordUndo(DocIterator const & cur, UndoKind kind, pit_type from);
98 /// Convenience: record undo information for the single
99 /// paragraph or cell containing the cursor.
100 void recordUndo(DocIterator const & cur, UndoKind kind = ATOMIC_UNDO);
102 /// Convenience: record undo information for the inset
103 /// containing the cursor.
104 void recordUndoInset(DocIterator const & cur,
105 UndoKind kind = ATOMIC_UNDO);
107 /// Convenience: prepare undo for the whole buffer
108 void recordUndoFullDocument(DocIterator const & cur);