ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkUndoElement Class Referenceabstract

unit undo-redo-able operation. More...

#include <vtkUndoElement.h>

Inheritance diagram for vtkUndoElement:
Inheritance graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int Undo ()=0
 Undo the operation encapsulated by this element. More...
 
virtual int Redo ()=0
 Redo the operation encaspsulated by this element. More...
 
virtual bool Merge (vtkUndoElement *vtkNotUsed(new_element))
 Called on the older element in the UndoSet to merge with the element being added if both the elements are mergeable. More...
 
virtual void SetUndoSetWorkingContext (vtkCollection *workCTX)
 
virtual bool GetMergeable ()
 Returns if this undo element can be merged with other undo elements. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkUndoElementSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkUndoElement ()
 
 ~vtkUndoElement ()
 
bool Mergeable
 Subclasses must set this flag to enable merging of consecutive elements in an UndoSet. More...
 
vtkCollection * UndoSetWorkingContext
 Subclasses must set this flag to enable merging of consecutive elements in an UndoSet. More...
 
virtual void SetMergeable (bool)
 Subclasses must set this flag to enable merging of consecutive elements in an UndoSet. More...
 

Detailed Description

unit undo-redo-able operation.

This is an abstract class that defines the API for an undo-redo-able operation. One or more vtkUndoElement objects can define a single undo-redo step. Every concrete implementation of this class must know how to undo as well as redo the operation, and save and load the state as an XML.

vtkUndoElement, vtkUndoSet and vtkUndoStack form the undo/redo framework core.

See also
vtkUndoStack vtkUndoSet

Definition at line 37 of file vtkUndoElement.h.

Member Typedef Documentation

§ Superclass

typedef vtkObject vtkUndoElement::Superclass

Definition at line 40 of file vtkUndoElement.h.

Constructor & Destructor Documentation

§ vtkUndoElement()

vtkUndoElement::vtkUndoElement ( )
protected

§ ~vtkUndoElement()

vtkUndoElement::~vtkUndoElement ( )
protected

Member Function Documentation

§ GetClassName()

virtual const char* vtkUndoElement::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

void vtkUndoElement::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ Undo()

virtual int vtkUndoElement::Undo ( )
pure virtual

Undo the operation encapsulated by this element.

Returns
the status of the operation, 1 on success, 0 otherwise.

Implemented in vtkSMRemoteObjectUpdateUndoElement, vtkSMGlobalPropertiesLinkUndoElement, vtkSMPropertyModificationUndoElement, pqProxyModifiedStateUndoElement, and vtkSMComparativeAnimationCueUndoElement.

§ Redo()

virtual int vtkUndoElement::Redo ( )
pure virtual

Redo the operation encaspsulated by this element.

Returns
the status of the operation, 1 on success, 0 otherwise.

Implemented in vtkSMRemoteObjectUpdateUndoElement, vtkSMGlobalPropertiesLinkUndoElement, vtkSMPropertyModificationUndoElement, pqProxyModifiedStateUndoElement, and vtkSMComparativeAnimationCueUndoElement.

§ GetMergeable()

virtual bool vtkUndoElement::GetMergeable ( )
virtual

Returns if this undo element can be merged with other undo elements.

When an undo element is added to a vtkUndoSet unsing AddElement, an attempt is made to "merge" the element with the most recently added undo element, if any, if both the undo elements are mergeable.

§ Merge()

virtual bool vtkUndoElement::Merge ( vtkUndoElement vtkNotUsednew_element)
inlinevirtual

Called on the older element in the UndoSet to merge with the element being added if both the elements are mergeable.

Returns if the merge was successful. Default implementation doesn't do anything.

Reimplemented in vtkSMPropertyModificationUndoElement.

Definition at line 73 of file vtkUndoElement.h.

§ SetUndoSetWorkingContext()

virtual void vtkUndoElement::SetUndoSetWorkingContext ( vtkCollection *  workCTX)
inlinevirtual

Definition at line 82 of file vtkUndoElement.h.

§ SetMergeable()

virtual void vtkUndoElement::SetMergeable ( bool  )
protectedvirtual

Subclasses must set this flag to enable merging of consecutive elements in an UndoSet.

Member Data Documentation

§ Mergeable

bool vtkUndoElement::Mergeable
protected

Subclasses must set this flag to enable merging of consecutive elements in an UndoSet.

Definition at line 96 of file vtkUndoElement.h.

§ UndoSetWorkingContext

vtkCollection* vtkUndoElement::UndoSetWorkingContext
protected

Subclasses must set this flag to enable merging of consecutive elements in an UndoSet.

Definition at line 97 of file vtkUndoElement.h.


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