vtkSMUndoStackBuilder.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMUndoStackBuilder_h
#define vtkSMUndoStackBuilder_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMMessageMinimal.h"            // needed for vtkSMMessage
#include "vtkSMObject.h"
 
class vtkSMProxy;
class vtkSMUndoStack;
class vtkUndoElement;
class vtkUndoSet;
class vtkSMSession;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMUndoStackBuilder : public vtkSMObject
{
public:
  static vtkSMUndoStackBuilder* New();
  vtkTypeMacro(vtkSMUndoStackBuilder, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual void Begin(const char* label);
 
  virtual void End();
 
 
  void EndAndPushToStack()
  {
    this->End();
    this->PushToStack();
  }
 
  virtual void PushToStack();
 
  virtual void Clear();
 
  virtual bool Add(vtkUndoElement* element);
 
 
  vtkGetObjectMacro(UndoStack, vtkSMUndoStack);
  virtual void SetUndoStack(vtkSMUndoStack*);
 
 
  vtkSetMacro(IgnoreAllChanges, bool);
  vtkGetMacro(IgnoreAllChanges, bool);
 
  // Record a state change on a RemoteObject
  virtual void OnStateChange(vtkSMSession* session, vtkTypeUInt32 globalId,
    const vtkSMMessage* previousState, const vtkSMMessage* newState);
 
  // Indicate that a new object was created.
  // Simply fires the vtkSMUndoStack::ObjectCreationEvent from the undo-stack.
  virtual void OnCreateObject(vtkSMSession* session, vtkSMMessage* newState);
 
protected:
  vtkSMUndoStackBuilder();
  ~vtkSMUndoStackBuilder() override;
 
  vtkSMUndoStack* UndoStack;
  vtkUndoSet* UndoSet;
  char* Label;
  vtkSetStringMacro(Label);
 
  virtual bool HandleChangeEvents() { return (this->EnableMonitoring > 0); }
 
  void InitializeUndoSet();
 
  // used to count Begin/End call to make sure they stay consistent
  // and make sure that a begin occurs before recording any event
  int EnableMonitoring;
  bool IgnoreAllChanges;
 
private:
  vtkSMUndoStackBuilder(const vtkSMUndoStackBuilder&) = delete;
  void operator=(const vtkSMUndoStackBuilder&) = delete;
};
 
#endif