Tanoda
GILES.IUndo Interface Reference
Inheritance diagram for GILES.IUndo:
GILES.UndoDelete GILES.UndoInstantiate GILES.UndoOffsetHolder GILES.UndoReflection GILES.UndoSelection GILES.UndoTransform

Public Member Functions

Hashtable RecordState ()
 
void ApplyState (Hashtable values)
 
void OnExitScope ()
 

Detailed Description

An interface that enables objects to store and load undo-able states.

Definition at line 9 of file IUndo.cs.

Member Function Documentation

◆ ApplyState()

void GILES.IUndo.ApplyState ( Hashtable  values)

Apply the recorded state to the target object using the values stored by RecordState.

Implemented in GILES.UndoDelete, GILES.UndoInstantiate, GILES.UndoReflection, GILES.UndoSelection, GILES.UndoOffsetHolder, and GILES.UndoTransform.

◆ OnExitScope()

void GILES.IUndo.OnExitScope ( )

Called when a state is purged from the undo or redo stack. Commonly used by objects to release memory once no longer needed.

Implemented in GILES.UndoDelete, GILES.UndoInstantiate, GILES.UndoOffsetHolder, GILES.UndoReflection, GILES.UndoSelection, and GILES.UndoTransform.

◆ RecordState()

Hashtable GILES.IUndo.RecordState ( )

Record the current state of the target object. RecordState() should grab the current state of the object pointed to, not the current state as stored.

RecordState should return a hashtable that contains all the information necessary to reconstitute the object. How the data is stored is up to the implementation, since it is also left to the implementing class to reconstruct itself using this same information in ApplyState.

Implemented in GILES.UndoDelete, GILES.UndoInstantiate, GILES.UndoOffsetHolder, GILES.UndoReflection, GILES.UndoSelection, and GILES.UndoTransform.


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