mitkUndoController.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 mitkUndoController_h
#define mitkUndoController_h
 
#include <mitkOperationEvent.h>
#include <mitkUndoModel.h>
#include <MitkCoreExports.h>
#include <map>
 
namespace mitk
{
  inline constexpr unsigned int DEFAULT_UNDO_REDO_LIMIT = 50;
 
  class MITKCORE_EXPORT UndoController
  {
  public:
    enum UndoType
    {
      LIMITEDLINEARUNDO = 10,
      VERBOSE_LIMITEDLINEARUNDO = 11,
      TREEUNDO = 20
    };
 
    typedef std::map<UndoType, UndoModel::Pointer> UndoModelMap;
    typedef std::map<UndoType, UndoModel::Pointer>::iterator UndoModelMapIter;
 
    static const UndoType DEFAULTUNDOMODEL;
 
    UndoController(UndoType undoType = DEFAULTUNDOMODEL);
    virtual ~UndoController();
 
    bool SetOperationEvent(UndoStackItem *operationEvent);
 
    bool Undo();
 
    bool Undo(bool fine);
 
    bool Redo();
 
    bool Redo(bool fine);
 
    void Clear();
 
    void ClearRedoList();
 
    bool RedoListEmpty();
 
    bool SwitchUndoModel(UndoType undoType);
 
    bool AddUndoModel(UndoType undoType);
 
    bool RemoveUndoModel(UndoType undoType);
 
    int GetLastObjectEventIdInList();
 
    int GetLastGroupEventIdInList();
 
    OperationEvent *GetLastOfType(OperationActor *destination, OperationType opType);
 
    static UndoModel *GetCurrentUndoModel();
 
  private:
    static UndoModel::Pointer m_CurUndoModel;
    static UndoType m_CurUndoType;
    static UndoModelMap m_UndoModelList;
  };
} // namespace mitk
 
#endif