unit undo-redo-able operation. More...
#include <vtkUndoElement.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual int | Undo ()=0 |
| virtual int | Redo ()=0 |
| virtual void | SetUndoSetWorkingContext (vtkCollection *workCTX) |
| virtual bool | GetMergeable () |
| virtual bool | Merge (vtkUndoElement *vtkNotUsed(new_element)) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkUndoElement * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkUndoElement () | |
| ~vtkUndoElement () | |
| bool | Mergeable |
| vtkCollection * | UndoSetWorkingContext |
| virtual void | SetMergeable (bool) |
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 35 of file vtkUndoElement.h.
Constructor & Destructor Documentation
| vtkUndoElement::vtkUndoElement | ( | ) | [protected] |
| vtkUndoElement::~vtkUndoElement | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkUndoElement::GetClassName | ( | ) | [virtual] |
| static int vtkUndoElement::IsTypeOf | ( | const char * | type | ) | [static] |
| virtual int vtkUndoElement::IsA | ( | const char * | type | ) | [virtual] |
| static vtkUndoElement* vtkUndoElement::SafeDownCast | ( | vtkObject * | o | ) | [static] |
| void vtkUndoElement::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
| 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 pqHelperProxyRegisterUndoElement, vtkSMRemoteObjectUpdateUndoElement, pqProxyModifiedStateUndoElement, vtkSMPropertyModificationUndoElement, vtkSMGlobalPropertiesLinkUndoElement, and vtkSMComparativeAnimationCueUndoElement.
| 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 pqHelperProxyRegisterUndoElement, vtkSMRemoteObjectUpdateUndoElement, pqProxyModifiedStateUndoElement, vtkSMPropertyModificationUndoElement, vtkSMGlobalPropertiesLinkUndoElement, and vtkSMComparativeAnimationCueUndoElement.
| 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.
| virtual bool vtkUndoElement::Merge | ( | vtkUndoElement * | vtkNotUsednew_element | ) | [inline, virtual] |
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 61 of file vtkUndoElement.h.
| virtual void vtkUndoElement::SetUndoSetWorkingContext | ( | vtkCollection * | workCTX | ) | [inline, virtual] |
Definition at line 74 of file vtkUndoElement.h.
| virtual void vtkUndoElement::SetMergeable | ( | bool | ) | [protected, virtual] |
Subclasses must set this flag to enable merging of consecutive elements in an UndoSet.
Member Data Documentation
bool vtkUndoElement::Mergeable [protected] |
Subclasses must set this flag to enable merging of consecutive elements in an UndoSet.
Definition at line 87 of file vtkUndoElement.h.
vtkCollection* vtkUndoElement::UndoSetWorkingContext [protected] |
Subclasses must set this flag to enable merging of consecutive elements in an UndoSet.
Definition at line 88 of file vtkUndoElement.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/VTKExtensions/vtkUndoElement.h
