X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FUndo.h;h=59f3ca44fc93a58975ee459ffc9440e5889a5ac1;hb=fd42194c7e661e024e34e56166b193284fa5a693;hp=d5748a97ea4b116e5ce33e4b6b26653780345afd;hpb=ec3aed75ad965160a96547b7e36c924c5df7a91b;p=lyx.git diff --git a/src/Undo.h b/src/Undo.h index d5748a97ea..59f3ca44fc 100644 --- a/src/Undo.h +++ b/src/Undo.h @@ -23,7 +23,7 @@ namespace lyx { class Buffer; class BufferParams; -class DocIterator; +class CursorData; class Inset; class MathData; class ParagraphList; @@ -47,6 +47,9 @@ enum UndoKind { class Undo { + /// noncopyable + Undo(Undo const &); + void operator=(Undo const &); public: Undo(Buffer &); @@ -57,10 +60,10 @@ public: void clear(); /// this will undo the last action - returns false if no undo possible - bool textUndo(DocIterator &); + bool textUndo(CursorData &); /// this will redo the last undo - returns false if no redo possible - bool textRedo(DocIterator &); + bool textRedo(CursorData &); /// End a sequence of INSERT_UNDO or DELETE_UNDO type of undo /// operations (grouping of consecutive characters insertion/deletion). @@ -80,12 +83,19 @@ public: * a single step. This means you can add a group whenever you are not sure. */ void beginUndoGroup(); - + /// open a new group as above and specify a cursor to set as cur_before + /// of the group's undo elements. + /** + * This cursor takes precedence over what is passed to recordUndo. + * In the case of nested groups, only the first cur_before is + * taken into account. The cursor is reset at the end of the + * top-level group. + */ + void beginUndoGroup(CursorData const & cur_before); /// end the current undo group. void endUndoGroup(); - /// end the current undo group and set UndoElement::cur_after if necessary. - void endUndoGroup(DocIterator const &); + void endUndoGroup(CursorData const & cur_after); /// The general case: record undo information for an arbitrary range. /** @@ -94,26 +104,22 @@ public: * give an inclusive range. This is called before you make the * changes to the paragraph, and it will record the original * information of the paragraphs in the undo stack. + * Kind of undo is always ATOMIC_UNDO. */ - void recordUndo(DocIterator const & cur, UndoKind kind, - pit_type from, pit_type to); - - /// Convenience: record undo information for the range between - /// 'from' and cursor. - void recordUndo(DocIterator const & cur, UndoKind kind, pit_type from); + void recordUndo(CursorData const & cur, pit_type from, pit_type to); /// Convenience: record undo information for the single /// paragraph or cell containing the cursor. - void recordUndo(DocIterator const & cur, UndoKind kind = ATOMIC_UNDO); + void recordUndo(CursorData const & cur, UndoKind kind = ATOMIC_UNDO); + + /// prepare undo for the inset containing the cursor + void recordUndoInset(CursorData const & cur, Inset const * inset); - /// Convenience: record undo information for the inset - /// containing the cursor. - void recordUndoInset(DocIterator const & cur, - UndoKind kind = ATOMIC_UNDO, - Inset const * inset = 0); + /// Convenience: record undo for buffer parameters + void recordUndoBufferParams(CursorData const & cur); /// Convenience: prepare undo for the whole buffer - void recordUndoFullDocument(DocIterator const & cur); + void recordUndoFullBuffer(CursorData const & cur); private: struct Private; @@ -121,6 +127,34 @@ private: }; +/** Helper class to simplify the use of undo groups across several buffers. + * + * The undo group is created when the object is instanciated; it is + * then ended as the object goes out of scope or the buffer is reset + * (see below) + */ +class UndoGroupHelper { +public: + UndoGroupHelper(Buffer * buf) : buffer_(0) + { + resetBuffer(buf); + } + + ~UndoGroupHelper() + { + resetBuffer(0); + } + + /** Close the current undo group if necessary and create a new one + * for buffer \c buf. + */ + void resetBuffer(Buffer * buf); + +private: + Buffer * buffer_; +}; + + } // namespace lyx