mitkOperationEvent.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 mitkOperationEvent_h
#define mitkOperationEvent_h
 
#include <mitkOperation.h>
#include <mitkOperationActor.h>
#include <mitkUndoModel.h>
 
#include <mitkITKEventObserverGuard.h>
 
#include <list>
#include <string>
 
 
#include <MitkCoreExports.h>
 
namespace mitk
{
  class MITKCORE_EXPORT UndoStackItem
  {
  public:
    UndoStackItem(std::string description = "");
 
    virtual ~UndoStackItem();
 
    static int GetCurrGroupEventId();
 
    static int GetCurrObjectEventId();
 
    int GetGroupEventId();
 
    int GetObjectEventId();
 
    std::string GetDescription();
 
    virtual void ReverseOperations();
 
    virtual void ReverseAndExecute();
 
    virtual bool IsValid() const = 0;
 
    static void IncCurrObjectEventId();
 
    static void IncCurrGroupEventId();
 
  protected:
    //##Documentation
    //## @brief true, if operation and undooperation have been swapped/changed
    bool m_Reversed;
 
  private:
    static int m_CurrObjectEventId;
 
    static int m_CurrGroupEventId;
 
    int m_ObjectEventId;
 
    int m_GroupEventId;
 
    std::string m_Description;
 
    UndoStackItem(UndoStackItem &);        // hide copy constructor
    void operator=(const UndoStackItem &); // hide operator=
  };
 
  class MITKCORE_EXPORT OperationEvent : public UndoStackItem
  {
  public:
    OperationEvent(OperationActor *destination,
                   Operation *operation,
                   Operation *undoOperation,
                   std::string description = "");
 
    ~OperationEvent() override;
 
    Operation *GetOperation();
 
    OperationActor *GetDestination();
 
    friend class UndoModel;
 
    void ReverseOperations() override;
 
    void ReverseAndExecute() override;
 
    bool IsValid() const override;
 
  protected:
    void OnObjectDeleted();
 
  private:
    // Has to be observed for itk::DeleteEvents.
    // When destination is deleted, this stack item is invalid!
    OperationActor* m_Destination;
 
    //## reference to the operation
    Operation *m_Operation;
 
    //## reference to the undo operation
    Operation *m_UndoOperation;
 
    //## hide copy constructor
    OperationEvent(OperationEvent &);
    //## hide operator=
    void operator=(const OperationEvent &);
 
    ITKEventObserverGuard m_DelObserver;
 
    //## stores if destination is valid or already has been freed
    bool m_Invalid;
  };
 
} // namespace mitk
 
#endif