mitkLimitedLinearUndo.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkLimitedLinearUndo_h
#define mitkLimitedLinearUndo_h
 
// MITK header
#include <mitkOperationEvent.h>
#include <mitkUndoModel.h>
#include <MitkCoreExports.h>
// STL header
#include <vector>
// ITK header
#ifdef __GNUC__
#pragma GCC visibility push(default)
#endif
#include <itkEventObject.h>
#ifdef __GNUC__
#pragma GCC visibility pop
#endif
 
#include <deque>
 
namespace mitk
{
  class MITKCORE_EXPORT LimitedLinearUndo : public UndoModel
  {
  public:
    typedef std::deque<UndoStackItem *> UndoContainer;
    typedef std::deque<UndoStackItem *>::reverse_iterator UndoContainerRevIter;
 
    mitkClassMacro(LimitedLinearUndo, UndoModel);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
 
    bool SetOperationEvent(UndoStackItem *stackItem) override;
 
    bool Undo() override;
 
    bool Undo(bool) override;
 
    virtual bool Undo(int oeid);
 
    bool Redo() override;
 
    bool Redo(bool) override;
 
    virtual bool Redo(int oeid);
 
    void Clear() override;
 
    void ClearRedoList() override;
 
    bool RedoListEmpty() override;
 
    bool UndoListEmpty() override;
 
    std::size_t GetUndoLimit() const override;
 
    void SetUndoLimit(std::size_t limit) override;
 
    int GetLastObjectEventIdInList() override;
 
    int GetLastGroupEventIdInList() override;
 
    OperationEvent *GetLastOfType(OperationActor *destination, OperationType opType) override;
 
    unsigned int RemoveInvalidOperations() override;
 
  protected:
    LimitedLinearUndo();
 
    ~LimitedLinearUndo() override;
 
    void ClearList(UndoContainer *list);
 
    UndoContainer m_UndoList;
 
    UndoContainer m_RedoList;
 
  private:
    int FirstObjectEventIdOfCurrentGroup(UndoContainer &stack);
 
    std::size_t m_UndoLimit;
 
  };
 
#ifdef __GNUC__
#pragma GCC visibility push(default)
#endif
 
  itkEventMacroDeclaration(UndoStackEvent, itk::ModifiedEvent);
  itkEventMacroDeclaration(UndoEmptyEvent, UndoStackEvent);   
  itkEventMacroDeclaration(RedoEmptyEvent, UndoStackEvent);   
  itkEventMacroDeclaration(UndoNotEmptyEvent, UndoStackEvent); 
  itkEventMacroDeclaration(RedoNotEmptyEvent, UndoStackEvent); 
  itkEventMacroDeclaration(UndoFullEvent, UndoStackEvent);    
  itkEventMacroDeclaration(RedoFullEvent, UndoStackEvent);    
 
#ifdef __GNUC__
#pragma GCC visibility pop
#endif
 
} // namespace mitk
 
#endif