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"
31 /// This is used to combine consecutive undo recordings of the same kind.
34 * Insert something - these will combine to one big chunk
35 * when many inserts come after each other.
39 * Delete something - these will combine to one big chunk
40 * when many deletes come after each other.
43 /// Atomic - each of these will have its own entry in the stack
56 /// Clear out all undo/redo contents.
59 /// this will undo the last action - returns false if no undo possible
60 bool textUndo(CursorData &);
62 /// this will redo the last undo - returns false if no redo possible
63 bool textRedo(CursorData &);
65 /// End a sequence of INSERT_UNDO or DELETE_UNDO type of undo
66 /// operations (grouping of consecutive characters insertion/deletion).
70 bool hasUndoStack() const;
72 bool hasRedoStack() const;
74 /// Mark all the elements of the undo and redo stacks as dirty
77 /// open a new group of undo operations.
79 * Groups can be nested. Such a nested group e.g. { {} {} } is undone in
80 * a single step. This means you can add a group whenever you are not sure.
82 void beginUndoGroup();
84 /// end the current undo group.
87 /// end the current undo group and set UndoElement::cur_after if necessary.
88 void endUndoGroup(CursorData const &);
90 /// The general case: record undo information for an arbitrary range.
92 * Record undo information - call with the current cursor and
93 * the 'other end' of the range of changed paragraphs. So we
94 * give an inclusive range. This is called before you make the
95 * changes to the paragraph, and it will record the original
96 * information of the paragraphs in the undo stack.
97 * Kind of undo is always ATOMIC_UNDO.
99 void recordUndo(CursorData const & cur, pit_type from, pit_type to);
101 /// Convenience: record undo information for the single
102 /// paragraph or cell containing the cursor.
103 void recordUndo(CursorData const & cur, UndoKind kind = ATOMIC_UNDO);
105 /// prepare undo for the inset containing the cursor
106 void recordUndoInset(CursorData const & cur, Inset const * inset);
108 /// Convenience: record undo for buffer parameters
109 void recordUndoBufferParams(CursorData const & cur);
111 /// Convenience: prepare undo for the whole buffer
112 void recordUndoFullBuffer(CursorData const & cur);
120 /** Helper class to simplify the use of undo groups across several buffers.
122 * The undo group is created when the object is instanciated; it is
123 * then ended as the object goes out of scope or the buffer is reset
126 class UndoGroupHelper {
128 UndoGroupHelper(Buffer * buf) : buffer_(0)
138 /** Close the current undo group if necessary and create a new one
141 void resetBuffer(Buffer * buf);