pqUndoStackBuilder extends the vtkSMUndoStackBuilder as follows: More...

#include <pqUndoStackBuilder.h>

Inheritance diagram for pqUndoStackBuilder:

Collaboration diagram for pqUndoStackBuilder:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual bool	GetIgnoreIsolatedChanges ()
	Get/Set if all modifications triggerred when not within a Begin/End block should be added to the undo stack or not.
virtual void	SetIgnoreIsolatedChanges (bool)
virtual void	SetUndoStack (vtkSMUndoStack *)
	Overridden to add observers to not record changes when the stack is being undone/redone.
virtual void	OnStateChange (vtkSMSession session, vtkTypeUInt32 globalId, const vtkSMMessage previousState, const vtkSMMessage *newState)
	Overridden to filter unwanted event and manage auto undoset creation.
Static Public Member Functions
static pqUndoStackBuilder *	New ()
static int	IsTypeOf (const char *type)
static pqUndoStackBuilder *	SafeDownCast (vtkObject *o)
Protected Member Functions
	pqUndoStackBuilder ()
	~pqUndoStackBuilder ()
bool	Filter (vtkSMSession *session, vtkTypeUInt32 globalId)
	Return false if this state should be escaped.
Protected Attributes
bool	IgnoreIsolatedChanges
bool	UndoRedoing

Detailed Description

pqUndoStackBuilder extends the vtkSMUndoStackBuilder as follows:

If properties on registered proxies are changed when the builder is not with a BeginOrContinueUndoSet - EndUndoSet block, unless IgnoreIsolatedChanges is true, it will create a UndoSet with that change alone and push it on the stack. IgnoreIsolatedChanges does not have any effect in a BeginOrContinueUndoSet-EndUndoSet block.
pqProxy objects can be added to be ignored for all changes. Thus, any change event triggered from any of the proxies in the ignore list don't result in updating of the undo stack even when those changes happen with a BeginOrContinueUndoSet - EndUndoSet block (this feature isn't implemented currently). With these extensions, following are the points we must remember to ensure that Undo/Redo works.
For any multi-change operations or proxy creation/registration operations such as creating of a source/reader/filter etc. we must explicitly use Begin() and End() blocks.
For modal dialogs which change a bunch of properties when the user hits Ok, such as Application Settings dialog, change input dialogs, we must use Begin() and End().
Any GUI wiget that is a single widget but changes multiple server manager properties or can lead to mutiple undo steps should use Begin and End block eg. Accept button, widget to select scalar to color by etc.
GUI Widgets that are directly linked to a Server Manager property and don't need to be accepted, don't need to worry about Undo/Redo at all. The pqUndoStackBuilder will automatically create elements for such changes and even try to given them friendly labels eg. most Animation panel properties, display panel widgets etc. Currently, this class automatically adds property modifications alone to the stack. We may want to explore the possibility of automatically adding all types of server manager modifications to the stack.

Definition at line 72 of file pqUndoStackBuilder.h.

Constructor & Destructor Documentation

pqUndoStackBuilder::pqUndoStackBuilder ( ) [protected]

pqUndoStackBuilder::~pqUndoStackBuilder ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkSMUndoStackBuilder.

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

Reimplemented from vtkSMUndoStackBuilder.

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

Reimplemented from vtkSMUndoStackBuilder.

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

Reimplemented from vtkSMUndoStackBuilder.

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

Reimplemented from vtkSMUndoStackBuilder.

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

Reimplemented from vtkSMUndoStackBuilder.

virtual bool pqUndoStackBuilder::GetIgnoreIsolatedChanges ( ) [virtual]

Get/Set if all modifications triggerred when not within a Begin/End block should be added to the undo stack or not.

On by default. Must be set before performing changes to Server Manager which the GUI is certain shouldn't be added to the Undo stack.

virtual void pqUndoStackBuilder::SetIgnoreIsolatedChanges ( bool ) [virtual]

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

Overridden to add observers to not record changes when the stack is being undone/redone.

Reimplemented from vtkSMUndoStackBuilder.

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