Struct undo_stack::UndoStack

pub struct UndoStack<T>
where
    T: Undoable,
{
    pub verbose: bool,
    /* private fields */
}

The main struct where all the undo values are kept.

Fields

verbose: bool

Controls whether warning messages are printed or not. True by default.

Implementations

impl<T> UndoStack<T>

where T: Undoable,

pub fn new(verbose: bool) -> Self

Creates a new, empty Undo stack.

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

Push a discrete “Undoable” value to the undo stack. Automatically clears future_stack redo values. Will do nothing if value matches the value on top of undo stack.

pub fn start_group(&mut self)

Starts a “group” with multiple undo values that can be undone simultaneously.

pub fn finish_group(&mut self)

Finishes the previously started undo group.

pub fn undo(&mut self, project: &mut T::ProjectType) -> Option<&T>

Performs undo, which will call the “restore” method on the restored value. Returns an option with the undone value for convenience.

pub fn redo(&mut self, project: &mut T::ProjectType) -> Option<&T>

Performs redo, which will call the “restore” method on the restored value. Returns an option with the redone value for convenience.

pub fn clear(&mut self)

Completely empties the undo and redo stacks and the temporary buffer.

pub fn is_empty(&self) -> bool

Returns true if both the undo and redo stacks are empty.

pub fn buffer_is_empty(&self) -> bool

Returns true is the temporary buffer is empty.

pub fn start_buffer(&mut self, value: T)

Stores the initial value of a continuously changing interaction - i.e. dragging a GUI slider.

pub fn finish_buffer(&mut self, final_value: T)

Finalizes continuous interaction, stores value from the buffer if change has occurred.

pub fn buffer(&self) -> Option<T>

Returns a copy of buffer contents

Trait Implementations

impl<T> Default for UndoStack<T>

where T: Undoable,

fn default() -> Self

Returns the “default value” for a type.