Struct kaolinite::event::EventMgmt

pub struct EventMgmt { /* private fields */ }

For managing events for purposes of undo and redo

Implementations

impl EventMgmt

pub fn register(&mut self, ev: Event)

Register that an event has occurred with the event manager

pub fn commit(&mut self)

This will commit the current patch to the undo stack, ready to be undone. You can call this after every space character, for example, which would make it so that every undo action would remove the previous word the user typed.

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

Provide a list of actions to perform in order of when they should be applied for purposes of undoing (you’ll need to reverse the events themselves manually)

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

Provide a list of events to execute in order of when they should be applied for purposes of redoing

pub fn is_undo_empty(&self) -> bool

Returns true if the undo stack is empty, meaning no patches have been applied

pub fn is_redo_empty(&self) -> bool

Returns true if the redo stack is empty, meaning no patches have been undone

pub fn is_patch_empty(&self) -> bool

Returns true if the current patch is empty, meaning no edits have been done since the last commit

Trait Implementations

impl Clone for EventMgmt

fn clone(&self) -> EventMgmt

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventMgmt

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

Formats the value using the given formatter.

impl Default for EventMgmt

fn default() -> EventMgmt

Returns the “default value” for a type.

impl PartialEq for EventMgmt

fn eq(&self, other: &EventMgmt) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EventMgmt

impl StructuralPartialEq for EventMgmt