undo.h

Go to the documentation of this file.

#ifndef undo_h
#define undo_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Kristofer Tingdahl
 Date:          4-11-2002
 RCS:           $Id$
________________________________________________________________________


-*/

#include "algomod.h"
#include "bufstringset.h"
#include "callback.h"

class UndoEvent;

mExpClass(Algo) Undo : public CallBacker
{
public:
                                Undo();
    virtual                     ~Undo();

    void                        removeAll();
    int                         maxLength() const;
    void                        setMaxLength(int);
    int                         addEvent(UndoEvent* event,
                                         const char* description=0);
    int                         currentEventID() const;
    int                         firstEventID() const;
    int                         lastEventID() const;

    void                        removeAllAfterCurrentEvent();
    void                        removeAllBeforeCurrentEvent();

    bool                        isUserInteractionEnd(int eventid) const;
    void                        setUserInteractionEnd(int eventid,bool=true);
    int                         getNextUserInteractionEnd(int start) const;

    BufferString                getDesc(int eventid) const;
    void                        setDesc(int eventid,const char* d);
    BufferString                unDoDesc() const;
    BufferString                reDoDesc() const;
    bool                        canUnDo() const;
    bool                        unDo(int nrtimes=1,bool userinteraction=true);

    bool                        canReDo() const;
    bool                        reDo(int nrtimes=1,bool userinteraction=true);

    Notifier<Undo>              changenotifier; //Any change
    Notifier<Undo>              undoredochange; //can**Do() or **DoDesc() change

protected:
    int                         indexOf(int eventid) const;

    void                        removeOldEvents();
    void                        removeStartToAndIncluding(int);
    int                         currenteventid_;
    int                         firsteventid_;
    int                         maxsize_;

    ObjectSet<UndoEvent>        events_;
    int                         userendscount_;

    Threads::Lock               addlock_;
};


mExpClass(Algo) UndoEvent
{
public:
                                UndoEvent();
    virtual                     ~UndoEvent();

    BufferString                getDesc() const;
    void                        setDesc(const char*);

    void                        setUserInteractionEnd(bool=true);
    bool                        isUserInteractionEnd() const;

    virtual const char*         getStandardDesc() const         = 0;
    virtual bool                unDo()                          = 0;
    virtual bool                reDo()                          = 0;

protected:
    BufferString*               desc_;
    bool                        isuserinteractionend_;
};


mExpClass(Algo) BinIDUndoEvent : public UndoEvent
{
public:
    virtual const BinID&        getBinID() const;
};


#endif