Struct Editing 

pub struct Editing {
    pub on: bool,
    pub asking: bool,
    /* private fields */
}

The shell’s editing state, handed to the view on every frame.

Fields

on: bool

Whether the window is in edit mode. Outside it a view draws and selects and never opens an editor.

asking: bool

A question is up over the window, and the keys belong to it: a view does not open an editor on the Enter that answers it.

Implementations

impl Editing

pub fn reset(&mut self)

A document was just read or closed: nothing to undo, nothing changed.

pub fn touch(&mut self)

The content changed, in a way that need not have begun an undo step.

pub fn revision(&self) -> u64

A number that is different whenever the text may be.

pub fn record(&mut self, content: &Element)

Take a snapshot of the content tree before an edit changes it.

Every edit calls this first, with the tree as it stands, and then mutates. A redo history is discarded, because the edit that follows is a new branch.

pub fn record_snapshot(&mut self, content: Element, caret: Option<Caret>)

The same, for a snapshot already taken, with where the caret stood in it: an editor that learns only after an edit whether it succeeded takes the tree before trying, and records it once it has.

pub fn undo( &mut self, current: &Element, caret: Option<Caret>, ) -> Option<(Element, Option<Caret>)>

Take the last edit back. Given the tree as it stands and where the caret is, so that the edit can be redone; answers the tree to put in its place and where the caret was in it.

pub fn redo( &mut self, current: &Element, caret: Option<Caret>, ) -> Option<(Element, Option<Caret>)>

Put back the edit last taken back, the same way.

pub fn can_undo(&self) -> bool

Whether there is anything to undo.

pub fn can_redo(&self) -> bool

Whether there is anything to redo.

pub fn modified(&self) -> bool

Whether the document differs from the file it was read from or last saved to. Undoing back to that state answers false again.

pub fn mark_saved(&mut self)

The document was written: what it holds now is what the file holds.

Trait Implementations

impl Default for Editing

fn default() -> Self

Returns the “default value” for a type.