vtkSMUndoStack.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkSMUndoStack.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkSMUndoStack_h
#define vtkSMUndoStack_h

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkUndoStack.h"

class vtkSMUndoRedoStateLoader;
class vtkSMUndoStackObserver;
class vtkUndoSet;
class vtkCollection;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMUndoStack : public vtkUndoStack
{
public:
  static vtkSMUndoStack* New();
  vtkTypeMacro(vtkSMUndoStack, vtkUndoStack);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Push(const char* label, vtkUndoSet* changeSet) override;

  int Undo() override;

  int Redo() override;

  enum EventIds
  {
    PushUndoSetEvent = 1987,
    ObjectCreationEvent = 1988

  };

protected:
  vtkSMUndoStack();
  ~vtkSMUndoStack() override;

  // Helper method used to push all vtkSMRemoteObject to the collection of
  // all the sessions that have been used across that undoset.
  // (It is more than likely that only one session will be find but in case of
  // collaboration, we might want to support a set of sessions.)
  // This is useful when we execute the undoset to prevent automatic
  // object deletion between 2 undo element calls when a proxy registration
  // is supposed to happen.
  void FillWithRemoteObjects(vtkUndoSet* undoSet, vtkCollection* collection);

private:
  vtkSMUndoStack(const vtkSMUndoStack&) = delete;
  void operator=(const vtkSMUndoStack&) = delete;

  class vtkInternal;
  vtkInternal* Internal;
};

#endif