Skip to main content

UndoStack

Struct UndoStack 

Source
pub struct UndoStack { /* private fields */ }
Expand description

A stack of reversible commands with reactive can_undo/can_redo state and a change stream.

Implementations§

Source§

impl UndoStack

Source

pub fn new() -> Self

Create an empty stack.

Source

pub fn push(&self, command: Box<dyn Command>)

Execute command and push it onto the undo stack, clearing redo.

Source

pub fn undo(&self) -> bool

Undo the most recent command; returns whether anything was undone.

Source

pub fn redo(&self) -> bool

Redo the most recently undone command; returns whether anything was redone.

Source

pub fn clear(&self)

Drop every command; no-op when the stack is already empty.

Source

pub fn can_undo(&self) -> Signal<bool>

Whether an undo is available.

Source

pub fn can_redo(&self) -> Signal<bool>

Whether a redo is available.

Source

pub fn changed(&self) -> EventStream<()>

A stream of events after every push, undo, redo, or clear.

Source

pub fn undo_text(&self) -> Option<String>

The text of the command that would be undone, if any.

Source

pub fn redo_text(&self) -> Option<String>

The text of the command that would be redone, if any.

Trait Implementations§

Source§

impl Default for UndoStack

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.