X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FUndo.h;h=c2b9b5d074b4e6e8fbef33e40e5aac73e74df3b3;hb=44dc38e120e04b7a6b1d275ff8e2f69993739b31;hp=4e83145a47cbad3443e16de378f4dcc0740b87a0;hpb=f6b1c24b990751598bad532d4595090a2dec9061;p=lyx.git diff --git a/src/Undo.h b/src/Undo.h index 4e83145a47..c2b9b5d074 100644 --- a/src/Undo.h +++ b/src/Undo.h @@ -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(CursorData &); + bool undoAction(CursorData &); /// this will redo the last undo - returns false if no redo possible - bool textRedo(CursorData &); + bool redoAction(CursorData &); /// End a sequence of INSERT_UNDO or DELETE_UNDO type of undo /// operations (grouping of consecutive characters insertion/deletion). @@ -80,12 +83,23 @@ 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(CursorData const &); + void endUndoGroup(CursorData const & cur_after); + /// end abruptly the current group and create a new one wih the same nesting level + void splitUndoGroup(CursorData const & cur); + /// return true if an undo group is open and contains at least one element + bool activeUndoGroup() const; /// The general case: record undo information for an arbitrary range. /** @@ -94,26 +108,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(CursorData const & cur, UndoKind kind, - pit_type from, pit_type to); - - /// Convenience: record undo information for the range between - /// 'from' and cursor. - void recordUndo(CursorData 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(CursorData const & cur, UndoKind kind = ATOMIC_UNDO); - /// Convenience: record undo information for the inset - /// containing the cursor. - void recordUndoInset(CursorData const & cur, - UndoKind kind = ATOMIC_UNDO, - Inset const * inset = 0); + /// prepare undo for the inset containing the cursor + void recordUndoInset(CursorData const & cur, Inset const * inset); + + /// Convenience: record undo for buffer parameters + void recordUndoBufferParams(CursorData const & cur); /// Convenience: prepare undo for the whole buffer - void recordUndoFullDocument(CursorData const & cur); + void recordUndoFullBuffer(CursorData const & cur); private: struct Private; @@ -121,6 +131,29 @@ 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 = 0); + + ~UndoGroupHelper(); + + /** Close the current undo group if necessary and create a new one + * for buffer \c buf. + */ + void resetBuffer(Buffer * buf); + +private: + class Impl; + Impl * const d; +}; + + } // namespace lyx