Libraries.Interface.Undo.Edit Documentation

Edit is a class for controlling undoing and redoing actions inside of a user interface or game. Each Edit is expected to store and manage its own state. The names, RedoName and UndoName are presentation names for the class, which can be used in an interface for the user.

Example Code

use Libraries.Interface.Undo.Edit
    Edit edit
    edit:Undo()

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
CanRedo()This action detects whether an operation can be redone and returns true if it can.
CanUndo()This action detects whether an operation can be undone and returns true if it can.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Dispose()This action tells this Edit to free up any state it is holding, if any.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetRedoName()This action returns the presentation name for redoing this operation.
GetUndoName()This action returns the presentation name for undoing this operation.
Redo()This action redoes an operation.
Undo()This action undoes an operation.

Actions Documentation

CanRedo()

This action detects whether an operation can be redone and returns true if it can. By default, not overriding this action means the answer will always be true.

Example Code

use Libraries.Interface.Undo.Edit
        Edit edit
        output edit:CanRedo()

Return

boolean:

CanUndo()

This action detects whether an operation can be undone and returns true if it can. By default, not overriding this action means the answer will always be true.

Example Code

use Libraries.Interface.Undo.Edit
        Edit edit
        output edit:CanUndo()

Return

boolean:

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Dispose()

This action tells this Edit to free up any state it is holding, if any.

Example Code

use Libraries.Interface.Undo.Edit
        Edit edit
        edit:Dispose()

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetRedoName()

This action returns the presentation name for redoing this operation.

Example Code

use Libraries.Interface.Undo.Edit
        Edit edit
        output edit:GetRedoName()

Return

text:

GetUndoName()

This action returns the presentation name for undoing this operation.

Example Code

use Libraries.Interface.Undo.Edit
        Edit edit
        output edit:GetUndoName()

Return

text:

Redo()

This action redoes an operation.

Example Code

use Libraries.Interface.Undo.Edit
        Edit edit
        edit:Redo()

Undo()

This action undoes an operation.

Example Code

use Libraries.Interface.Undo.Edit
        Edit edit
        edit:Undo()