builds server manager undo sets and pushes them on the undo stack. More...

#include <vtkSMUndoStackBuilder.h>

Inheritance diagram for vtkSMUndoStackBuilder:

Collaboration diagram for vtkSMUndoStackBuilder:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Begin (const char *label)
virtual void	End ()
virtual void	PushToStack ()
virtual void	Clear ()
virtual bool	Add (vtkUndoElement *element)
virtual void	OnStateChange (vtkSMSession session, vtkTypeUInt32 globalId, const vtkSMMessage previousState, const vtkSMMessage *newState)
virtual void	OnCreateObject (vtkSMSession session, vtkSMMessage newState)

void	EndAndPushToStack ()

virtual vtkSMUndoStack *	GetUndoStack ()
virtual void	SetUndoStack (vtkSMUndoStack *)

virtual void	SetIgnoreAllChanges (bool)
virtual bool	GetIgnoreAllChanges ()
Static Public Member Functions
static vtkSMUndoStackBuilder *	New ()
static int	IsTypeOf (const char *type)
static vtkSMUndoStackBuilder *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMUndoStackBuilder ()
	~vtkSMUndoStackBuilder ()
virtual void	SetLabel (const char *)
void	InitializeUndoSet ()

virtual bool	HandleChangeEvents ()
Protected Attributes
vtkSMUndoStack *	UndoStack
vtkUndoSet *	UndoSet
char *	Label
int	EnableMonitoring
bool	IgnoreAllChanges

Detailed Description

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 41 of file vtkSMUndoStackBuilder.h.

Constructor & Destructor Documentation

vtkSMUndoStackBuilder::vtkSMUndoStackBuilder ( ) [protected]

vtkSMUndoStackBuilder::~vtkSMUndoStackBuilder ( ) [protected]

Member Function Documentation

static vtkSMUndoStackBuilder* vtkSMUndoStackBuilder::New ( ) [static]

Reimplemented from vtkSMObject.

Reimplemented in pqUndoStackBuilder.

virtual const char* vtkSMUndoStackBuilder::GetClassName ( ) [virtual]

Reimplemented from vtkSMObject.

Reimplemented in pqUndoStackBuilder.

static int vtkSMUndoStackBuilder::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkSMObject.

Reimplemented in pqUndoStackBuilder.

virtual int vtkSMUndoStackBuilder::IsA ( const char * type ) [virtual]

Reimplemented from vtkSMObject.

Reimplemented in pqUndoStackBuilder.

static vtkSMUndoStackBuilder* vtkSMUndoStackBuilder::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkSMObject.

Reimplemented in pqUndoStackBuilder.

void vtkSMUndoStackBuilder::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMObject.

Reimplemented in pqUndoStackBuilder.

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.

virtual void vtkSMUndoStackBuilder::End ( ) [virtual]

Stops monitoring of the vtkSMProxyManager for undoable operations. Any changes made to the proxy manager will not be converted to UndoElements. This method does not push the vtkUndoSet of undo elements built. One must call PushToStack() to push the UndoSet to the Undo stack. Alternatively, one can use the EndAndPushToStack() method which combines End() and PushToStack().

void vtkSMUndoStackBuilder::EndAndPushToStack ( ) [inline]

Convenience method call End(); PushToStack(); in that order.

Definition at line 67 of file vtkSMUndoStackBuilder.h.

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.

virtual void vtkSMUndoStackBuilder::Clear ( ) [virtual]

Discard all recorded changes that haven't been pushed on the UndoStack.

virtual bool vtkSMUndoStackBuilder::Add ( vtkUndoElement * element ) [virtual]

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;

virtual vtkSMUndoStack* vtkSMUndoStackBuilder::GetUndoStack ( ) [virtual]

Get/Set the undo stack that this builder will build.

virtual void vtkSMUndoStackBuilder::SetUndoStack ( vtkSMUndoStack * ) [virtual]

Get/Set the undo stack that this builder will build.

Reimplemented in pqUndoStackBuilder.

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.

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.

virtual void vtkSMUndoStackBuilder::OnStateChange	(	vtkSMSession *	session,
		vtkTypeUInt32	globalId,
		const vtkSMMessage *	previousState,
		const vtkSMMessage *	newState
	)		`[virtual]`