GroupUndoTask

public class GroupUndoTask : UndoTask

An undo task that encloses multiple UndoTasks in it

  • Gets or sets a value specifying whether to discard the undo group if it’s opened on an UndoSystem while it receives an undo/redo call

    Declaration

    Swift

    public var discardOnOperation: Bool

  • Gets or sets whether to reverse the order of the operations on undo

    Declaration

    Swift

    public var reverseOnUndo: Bool

  • The list of undo tasks enclosed in this GroupUndoTask

    Declaration

    Swift

    private(set) public var undoList: [UndoTask] { get }

  • Initializes a new instance of the GroupUndoTask class with a description

    Declaration

    Swift

    public init(description: String)

    Parameters

    description

    The description for this GroupUndoTask

  • Initializes a new instance of the GroupUndoTask class with a list of tasks to perform and a description

    Declaration

    Swift

    public init(tasks: [UndoTask], description: String, discardOnOperation: Bool = false, reverseOnUndo: Bool = true)

    Parameters

    tasks

    The tasks to perform
    description

    The description for this GroupUndoTask
    discardOnOperation

    Whether to discard the undo group if it’s opened on an UndoSystem while it receives an undo/redo call
    reverseOnUndo

    Whether to perform the undo operations in the reverse order the tasks where added

  • Adds a new task on this GroupUndoTask

    Declaration

    Swift

    public func addTask(_ task: UndoTask)

    Parameters

    task

    The task to add to this GroupUndoTask

  • Adds a list of tasks on this GroupUndoTask

    Declaration

    Swift

    public func addTasks(_ tasks: [UndoTask])

    Parameters

    tasks

    The tasks to add to this GroupUndoTask

  • Clears this UndoTask object

    Declaration

    Swift

    public func clear()

  • Undoes this task

    Declaration

    Swift

    public func undo()

  • Redoes this task

    Declaration

    Swift

    public func redo()

  • Returns a short string description of this UndoTask

    Declaration

    Swift

    public func getDescription() -> String