Previous IDL Reference Guide: iTools Object Classes Next

IDLitManipulator::CommitUndoValues

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitManipulator::CommitUndoValues function method is used to complete a transaction that is occurring as a result of the manipulator interaction. This method works in conjunction with the RecordUndoValues method.

When a manipulator interaction is complete, the manipulator should call this method, which in turn calls the RecordFinalValues method of the operation associated with the manipulator. The RecordFinalValues method records any information needed to undo the operation and places the information in the iTool's undo-redo transaction buffer.

For interactive manipulators, the CommitUndoValues method should be called by the OnMouseUp method.


Note
This method must be called on the current manipulator before being called on a superclass to ensure that the current selection state maintained by the manipulator is valid.

Syntax

Result = Obj->[IDLitManipulator::]CommitUndoValues([/UNCOMMIT])

Return Value

Returns 1 if the commit was successful, or 0 otherwise.

Arguments

None

Keywords

UNCOMMIT

Set this keyword to discard any pending information from a previous call to RecordUndoValues. The interaction is not recorded in the iTool's undo-redo transaction buffer.

Version History

6.0
Introduced

  IDL Online Help (March 06, 2007)