IMcUndoStack Interface |
|
An interface implementing an Undo-Redo manager
Namespace: MediaCy.IQL.Engine
Assembly: MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
SyntaxVB
Public Interface IMcUndoStack
The IMcUndoStack type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CanRedo | Read-only property, checks whether or not a Redo may be performed. |
| CanUndo | Read-only property, checks whether or not an Undo may be performed. |
| Disabled | Read-write property, allows the freezing of Push, Undo or Redo
operations the undo-redo manager. |
| MaxSize | Reflects and sets the maximum number of undo states kept. |
| RedoTopStateContext | Read-only property providing the atributes of the top
state of the stack |
| RedoTopStateDescription | Read-only property providing the atributes of the top
state of the stack |
| RedoTopStateID | Read-only property providing the atributes of the top
state of the stack |
| RedoTopStateOperation | Read-only property providing the atributes of the top
state of the stack |
| RedoTopStateOwner | Read-only property providing the atributes of the top
state of the stack |
| RedoTopStateUndoable | Read-only property providing the atributes of the top
state of the stack |
| RedoTopStateValue | Read-only property providing the atributes of the top
state of the stack |
| UndoTopStateContext | Read-only property providing the atributes of the top
state of the stack |
| UndoTopStateDescription | Read-only property providing the atributes of the top
state of the stack |
| UndoTopStateID | Read-only property providing the atributes of the top
state of the stack |
| UndoTopStateOperation | Read-only property providing the atributes of the top
state of the stack |
| UndoTopStateOwner | Read-only property providing the atributes of the top
state of the stack |
| UndoTopStateUndoable | Read-only property providing the atributes of the top
state of the stack |
| UndoTopStateValue | Read-only property providing the atributes of the top
state of the stack |
Methods| Name | Description | |
|---|---|---|
 | Flush | Drops all states in the Undo stack, and the Redo stack |
| PopRedo | Drops the top state of the Redo stack without performing the redo |
| PopUndo | Drops the top state of the Undo stack without performing the undo |
 | Push | Saves the state of an undoable object for a future Undo operation. |
| Redo | Will save the undoable on top of the Undo stack, update the
undoable with the top of the Redo stack, and drop the top of the Redo stack. The
operation will fail if the Redo stack is empty.
This function will fire two events: AboutToRedo and RedoDone. |
| Undo | Will save the undoable on top of the Redo stack, update the
undoable with the top of the Undo stack, and drop the top of the Undo stack.
This function will fire two events: AboutToUndo and UndoDone. |
RemarksIt uses an Undo and a Redo stack, internally to store the history
of states of the undoables Push saves a state in the Undo stack Undo saves
the undoable in the Redo stack, update the undoable with the top of the Undo
stack, and drops the top of the Undo stack (similar, but reverse for Redo)
The property MaxSize defines the maximum number of states held by both the
Undo and the Redo stack CanUndo and CanRedo, respectively test the presence
of states in the Undo and Redo stack.
The Undo-Redo manager can be set to an insensitive mode, where all functions
(except read-only properties) return without doing anything. A set of
read-only properties gives access to all the attributes of the top state of
the Undo stack, and the top state of the Redo stack.
When this object is attached to an image (IMcImage.UndoStack), the undo
context (ordering and stored information) is relative to the image.
See Also