vtkUndoStack.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkUndoStack_h
#define vtkUndoStack_h

#include "vtkObject.h"
#include "vtkPVVTKExtensionsCoreModule.h" // needed for export macro

class vtkUndoStackInternal;
class vtkUndoSet;

class VTKPVVTKEXTENSIONSCORE_EXPORT vtkUndoStack : public vtkObject
{
public:
  enum EventIds
  {
    UndoSetRemovedEvent = 1989,
    UndoSetClearedEvent = 1990
  };

  static vtkUndoStack* New();
  vtkTypeMacro(vtkUndoStack, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

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

  const char* GetUndoSetLabel(unsigned int position);

  const char* GetRedoSetLabel(unsigned int position);

  unsigned int GetNumberOfUndoSets();

  unsigned int GetNumberOfRedoSets();

  int CanUndo() { return (this->GetNumberOfUndoSets() > 0); }

  int CanRedo() { return (this->GetNumberOfRedoSets() > 0); }

  virtual vtkUndoSet* GetNextUndoSet();

  virtual vtkUndoSet* GetNextRedoSet();

  virtual int Undo();

  virtual int Redo();

  void PopUndoStack();

  void PopRedoStack();

  void Clear();


  vtkGetMacro(InUndo, bool);


  vtkGetMacro(InRedo, bool);


  vtkSetClampMacro(StackDepth, int, 1, 100);
  vtkGetMacro(StackDepth, int);

protected:
  vtkUndoStack();
  ~vtkUndoStack() override;

  vtkUndoStackInternal* Internal;
  int StackDepth;

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

  bool InUndo;
  bool InRedo;
};

#endif