ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMUndoStackBuilder Class Reference

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

#include <vtkSMUndoStackBuilder.h>

Inheritance diagram for vtkSMUndoStackBuilder:
Inheritance graph
[legend]
Collaboration diagram for vtkSMUndoStackBuilder:
Collaboration graph
[legend]

Public Types

typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

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)
 Begins monitoring of the vtkSMProxyManager for undoable operations. More...
 
virtual void End ()
 Stops monitoring of the vtkSMProxyManager for undoable operations. More...
 
virtual void PushToStack ()
 If any undoable changes were recorded by the builder, this will push the vtkUndoSet formed on to the UndoStack. More...
 
virtual void Clear ()
 Discard all recorded changes that haven't been pushed on the UndoStack. More...
 
virtual bool Add (vtkUndoElement *element)
 One can add arbritary elements to the active undo set. More...
 
virtual void OnStateChange (vtkSMSession *session, vtkTypeUInt32 globalId, const vtkSMMessage *previousState, const vtkSMMessage *newState)
 
virtual void OnCreateObject (vtkSMSession *session, vtkSMMessage *newState)
 
void EndAndPushToStack ()
 Convenience method call End(); PushToStack(); in that order. More...
 
virtual vtkSMUndoStackGetUndoStack ()
 Get/Set the undo stack that this builder will build. More...
 
virtual void SetUndoStack (vtkSMUndoStack *)
 Get/Set the undo stack that this builder will build. More...
 
virtual void SetIgnoreAllChanges (bool)
 If IgnoreAllChanges is true, any server manager changes will be ignored even if the changes happened within a Begin()-End() call. More...
 
virtual bool GetIgnoreAllChanges ()
 If IgnoreAllChanges is true, any server manager changes will be ignored even if the changes happened within a Begin()-End() call. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMUndoStackBuilderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMUndoStackBuilderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMUndoStackBuilder ()
 
 ~vtkSMUndoStackBuilder ()
 
virtual void SetLabel (const char *)
 
virtual bool HandleChangeEvents ()
 Returns if the event raised by the proxy manager should be converted to undo elements. More...
 
void InitializeUndoSet ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Protected Attributes

vtkSMUndoStackUndoStack
 
vtkUndoSetUndoSet
 
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 43 of file vtkSMUndoStackBuilder.h.

Member Typedef Documentation

§ Superclass

Definition at line 47 of file vtkSMUndoStackBuilder.h.

Constructor & Destructor Documentation

§ vtkSMUndoStackBuilder()

vtkSMUndoStackBuilder::vtkSMUndoStackBuilder ( )
protected

§ ~vtkSMUndoStackBuilder()

vtkSMUndoStackBuilder::~vtkSMUndoStackBuilder ( )
protected

Member Function Documentation

§ New()

static vtkSMUndoStackBuilder* vtkSMUndoStackBuilder::New ( )
static

§ GetClassName()

virtual const char* vtkSMUndoStackBuilder::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

Reimplemented in pqUndoStackBuilder.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMObject.

Reimplemented in pqUndoStackBuilder.

§ SafeDownCast()

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

§ 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

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().

§ EndAndPushToStack()

void vtkSMUndoStackBuilder::EndAndPushToStack ( )
inline

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

Definition at line 76 of file vtkSMUndoStackBuilder.h.

§ 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()

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;

§ GetUndoStack()

virtual vtkSMUndoStack* vtkSMUndoStackBuilder::GetUndoStack ( )
virtual

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

§ SetUndoStack()

virtual void vtkSMUndoStackBuilder::SetUndoStack ( vtkSMUndoStack )
virtual

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

Reimplemented in pqUndoStackBuilder.

§ 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()

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

Reimplemented in pqUndoStackBuilder.

§ OnCreateObject()

virtual void vtkSMUndoStackBuilder::OnCreateObject ( vtkSMSession session,
vtkSMMessage newState 
)
virtual

§ 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

Member Data Documentation

§ UndoStack

vtkSMUndoStack* vtkSMUndoStackBuilder::UndoStack
protected

Definition at line 137 of file vtkSMUndoStackBuilder.h.

§ UndoSet

vtkUndoSet* vtkSMUndoStackBuilder::UndoSet
protected

Definition at line 138 of file vtkSMUndoStackBuilder.h.

§ Label

char* vtkSMUndoStackBuilder::Label
protected

Definition at line 139 of file vtkSMUndoStackBuilder.h.

§ EnableMonitoring

int vtkSMUndoStackBuilder::EnableMonitoring
protected

Definition at line 152 of file vtkSMUndoStackBuilder.h.

§ IgnoreAllChanges

bool vtkSMUndoStackBuilder::IgnoreAllChanges
protected

Definition at line 153 of file vtkSMUndoStackBuilder.h.


The documentation for this class was generated from the following file: