builds server manager undo sets and pushes them on the undo stack.
More...
#include <vtkSMUndoStackBuilder.h>
builds server manager undo sets and pushes them on the undo stack.
vtkSMUndoStackBuilder records Server Manager changes that are undo/redo able and collects them. To begin recording such changes one must call Begin(). To end recording use End(). One can have multiple blocks of Begin-End before pushing the changes on the Undo Stack. To push all collected changes onto the Undo Stack as a single undoable step, use PushToStack(). Applications can subclass vtkSMUndoStackBuilder to record GUI related changes and add them to the undo stack.
Definition at line 43 of file vtkSMUndoStackBuilder.h.
◆ Superclass
◆ vtkSMUndoStackBuilder()
vtkSMUndoStackBuilder::vtkSMUndoStackBuilder |
( |
| ) |
|
|
protected |
◆ ~vtkSMUndoStackBuilder()
vtkSMUndoStackBuilder::~vtkSMUndoStackBuilder |
( |
| ) |
|
|
protected |
◆ New()
◆ GetClassName()
virtual const char* vtkSMUndoStackBuilder::GetClassName |
( |
| ) |
|
|
virtual |
◆ IsTypeOf()
static int vtkSMUndoStackBuilder::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
◆ IsA()
virtual int vtkSMUndoStackBuilder::IsA |
( |
const char * |
type | ) |
|
|
virtual |
◆ SafeDownCast()
◆ PrintSelf()
void vtkSMUndoStackBuilder::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
◆ Begin()
virtual void vtkSMUndoStackBuilder::Begin |
( |
const char * |
label | ) |
|
|
virtual |
Begins monitoring of the vtkSMProxyManager for undoable operations.
All noted actions are converted to UndoElements and collected. One vtkUndoElement is created per action. All undo elements become a part of a vtkUndoSet which is pushed on to the Undo Stack on PushToStack(). label
is a suggestion for the UndoSet that will be built. If the UndoSet already has elements implying it hasn't been pushed to the stack then the label is ignored.
◆ End()
virtual void vtkSMUndoStackBuilder::End |
( |
| ) |
|
|
virtual |
◆ EndAndPushToStack()
void vtkSMUndoStackBuilder::EndAndPushToStack |
( |
| ) |
|
|
inline |
◆ PushToStack()
virtual void vtkSMUndoStackBuilder::PushToStack |
( |
| ) |
|
|
virtual |
If any undoable changes were recorded by the builder, this will push the vtkUndoSet formed on to the UndoStack.
The UndoStack which the builder is building must be set by using SetUndoStack(). If the UndoSet is empty, it is not pushed on the stack. After pushing, the UndoSet is cleared so the builder is ready to collect new modifications.
◆ Clear()
virtual void vtkSMUndoStackBuilder::Clear |
( |
| ) |
|
|
virtual |
Discard all recorded changes that haven't been pushed on the UndoStack.
◆ Add()
One can add arbritary elements to the active undo set.
It is essential that the StateLoader on the UndoStack can handle the arbritary undo elements. If that element has been escaped for any reason, the method will return false;
◆ GetUndoStack()
Get/Set the undo stack that this builder will build.
◆ SetUndoStack()
◆ SetIgnoreAllChanges()
virtual void vtkSMUndoStackBuilder::SetIgnoreAllChanges |
( |
bool |
| ) |
|
|
virtual |
If IgnoreAllChanges is true, any server manager changes will be ignored even if the changes happened within a Begin()-End() call.
This provides a mechanism for the application to perform non-undoable operations irrespective of whether a undo set if being built. By default, it is set to false.
◆ GetIgnoreAllChanges()
virtual bool vtkSMUndoStackBuilder::GetIgnoreAllChanges |
( |
| ) |
|
|
virtual |
If IgnoreAllChanges is true, any server manager changes will be ignored even if the changes happened within a Begin()-End() call.
This provides a mechanism for the application to perform non-undoable operations irrespective of whether a undo set if being built. By default, it is set to false.
◆ OnStateChange()
◆ OnCreateObject()
◆ SetLabel()
virtual void vtkSMUndoStackBuilder::SetLabel |
( |
const char * |
| ) |
|
|
protectedvirtual |
◆ HandleChangeEvents()
virtual bool vtkSMUndoStackBuilder::HandleChangeEvents |
( |
| ) |
|
|
inlineprotectedvirtual |
Returns if the event raised by the proxy manager should be converted to undo elements.
Definition at line 146 of file vtkSMUndoStackBuilder.h.
◆ InitializeUndoSet()
void vtkSMUndoStackBuilder::InitializeUndoSet |
( |
| ) |
|
|
protected |
◆ UndoStack
◆ UndoSet
◆ Label
char* vtkSMUndoStackBuilder::Label |
|
protected |
◆ EnableMonitoring
int vtkSMUndoStackBuilder::EnableMonitoring |
|
protected |
◆ IgnoreAllChanges
bool vtkSMUndoStackBuilder::IgnoreAllChanges |
|
protected |
The documentation for this class was generated from the following file: