Struct UndoHistory 

pub struct UndoHistory<T> { /* private fields */ }

A history of grouped undo transactions.

Implementations

impl<T> UndoHistory<T>

pub fn new() -> Self

pub fn max_undos(self, max_undos: usize) -> Self

Set the maximum number of undo transactions to keep, defaults to 1000.

Lowering the limit immediately removes the oldest undo transactions.

pub fn group_interval(self, group_interval: Duration) -> Self

Set the interval in which consecutive changes are grouped.

A successful undo or redo ends timed grouping. Explicit grouping is independent and can still append to the current transaction.

pub fn start_grouping(&mut self)

Start explicitly grouping pushed changes into one transaction.

pub fn end_grouping(&mut self)

End explicit grouping of pushed changes.

pub fn is_ignoring(&self) -> bool

Returns whether history recording is currently ignored.

pub fn set_ignoring(&mut self, ignoring: bool)

Sets whether history recording is currently ignored.

pub fn push(&mut self, item: T)

Pushes a change into the current transaction or starts a new one.

pub fn undo(&mut self) -> Option<Vec<T>>

where T: Clone,

Undoes the latest transaction, returning changes newest first.

pub fn redo(&mut self) -> Option<Vec<T>>

where T: Clone,

Redoes the latest undone transaction, returning changes oldest first.

pub fn can_undo(&self) -> bool

Returns whether an undo transaction is available.

pub fn can_redo(&self) -> bool

Returns whether a redo transaction is available.

pub fn clear(&mut self)

Clears both undo and redo transactions.

Trait Implementations

impl<T: Debug> Debug for UndoHistory<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for UndoHistory<T>

fn default() -> Self

Returns the “default value” for a type.