traitsui.undo module

Defines the manager for Undo and Redo history for Traits user interface support.

class traitsui.undo.AbstractUndoItem

Bases: pyface.undo.abstract_command.AbstractCommand

Abstract base class for undo items.

This class is deprecated and will be removed in TraitsUI 8. Any custom subclasses of this class should either subclass from AbstractCommand, or provide the ICommand interface.

do()

Does nothing.

All undo items log events after they have happened, so by default they do not do anything when added to the history.

merge(other)

Merges two undo items if possible.

merge_undo(undo_item)

Merges two undo items if possible.

This method is deprecated.

name = "Edit"

A simple default name.

redo()

Re-does the change.

undo()

Undoes the change.

class traitsui.undo.ListUndoItem

Bases: traitsui.undo.AbstractUndoItem

A change to a list, which can be undone.

added = List()

Items added to the list

index = Int()

Starting index

merge(undo_item)

Merges two undo items if possible.

merge_undo(undo_item)

Merges two undo items if possible.

This is deprecated.

name = Str()

Name of the trait that changed

object = Instance(HasTraits)

Object that the change occurred on

redo()

Re-does the change.

removed = List()

Items removed from the list

undo()

Undoes the change.

class traitsui.undo.UndoHistory

Bases: traits.has_traits.HasStrictTraits

Manages a list of undoable changes.

add(undo_item, extend=False)

Adds an UndoItem to the history.

can_redo = Property(Bool, observe='_can_redo')

Can an action be redone?

can_undo = Property(Bool, observe='_can_undo')

Can an action be undone?

clear()

Clears the undo history.

extend(undo_item)

Extends the undo history.

If possible the method merges the new UndoItem with the last item in the history; otherwise, it appends the new item.

history = List()

List of accumulated undo changes. Each item is a list of AbstractUndoItems that should be done or undone as a group. This trait should be considered private. This trait is no longer used.

manager = Instance(IUndoManager, allow_none=False)

The undo manager for the history.

now = Property(Int, observe='stack._index')

The current position in the list

redo()

Redoes an operation.

redoable = Event(False)

Fired when state changes to redoable

revert()

Reverts all changes made so far and clears the history.

stack = Instance(ICommandStack, allow_none=False)

The command stack for the history.

undo()

Undoes an operation.

undoable = Event(False)

Fired when state changes to undoable

class traitsui.undo.UndoHistoryUndoItem

Bases: traitsui.undo.AbstractUndoItem

An undo item for the undo history.

history = Instance(UndoHistory)

The undo history to undo or redo

redo()

Re-does the change.

undo()

Undoes the change.

class traitsui.undo.UndoItem

Bases: traitsui.undo.AbstractUndoItem

A change to an object trait, which can be undone.

merge(undo_item)

Merges two undo items if possible.

merge_undo(undo_item)

Merges two undo items if possible.

This is deprecated.

name = Str()

Name of the trait that changed

new_value = Property()

New value of the changed trait

object = Instance(HasTraits)

Object the change occurred on

old_value = Property()

Old value of the changed trait

redo()

Re-does the change.

undo()

Undoes the change.