Struct Editor 

pub struct Editor { /* private fields */ }

A headless structural math editor that never typesets, keeps no history, and has no callbacks.

Implementations

impl Editor

pub fn new() -> Self

An empty editor.

pub fn from_document(doc: &Document) -> Result<Self, DocumentError>

An editor holding doc, which must pass Document::validate, see Document::repair.

pub fn document(&self) -> Document

The whole document.

pub fn revision(&self) -> u64

Advances on every content change and on Editor::restore, never on motion.

pub fn cursor(&self) -> CaretPath

The caret, which is the selection focus while a selection is active.

pub fn set_cursor(&mut self, at: &CaretPath) -> Result<(), PathError>

Place the caret, collapsing the selection and closing the menu.

pub fn selection(&self) -> Option<Selection>

The active selection, None when the caret is collapsed.

pub fn set_selection( &mut self, anchor: &CaretPath, focus: &CaretPath, ) -> Result<(), PathError>

Select between two carets in the same sequence and close the menu.

pub fn at_start(&self) -> bool

Whether the caret is before everything in the formula.

pub fn at_end(&self) -> bool

Whether the caret is after everything in the formula.

pub fn at_slot_start(&self) -> bool

Whether the caret is at the start of its slot.

pub fn at_slot_end(&self) -> bool

Whether the caret is at the end of its slot.

pub fn in_text_slot(&self) -> bool

Whether the caret is inside \text{}.

pub fn menu(&self) -> Option<MenuView>

The open swap or delete menu.

pub fn matrix_shape(&self) -> Option<(usize, usize)>

Rows and columns of the matrix whose cell holds the caret.

pub fn input_context(&self) -> InputContext

Everything a keymap needs to know about the caret in one call.

pub fn set_host_box_policy(&mut self, policy: HostBoxPolicy)

Choose whether horizontal motion steps over host boxes or stops and reports them.

pub fn place_at(&mut self, edge: Edge)

Put the caret at an edge of the formula, clearing selection and menu.

pub fn source(&self) -> Source

LaTeX for typesetting, with \phantom{x} boxes in empty slots so they can be drawn.

pub fn display_source(&self) -> Source

Clean LaTeX with spans, so hosts can map a caret to a byte offset in what users see.

pub fn render( &self, source: &Source, fragment: &Fragment, ) -> Result<RenderOutput, StaleSource>

Geometry for the caret, selection, placeholders, menu, and host boxes over fragment.

pub fn hit_test( &self, source: &Source, fragment: &Fragment, at: Point, ) -> Result<Option<CaretPath>, StaleSource>

The caret nearest at, None when the fragment has no geometry to hit.

pub fn snapshot(&self) -> Snapshot

The current state for a host undo stack.

pub fn restore(&mut self, s: &Snapshot) -> Result<(), RestoreError>

Return to a snapshot, closing the menu and advancing the revision, unchanged on error.

pub fn selection_document(&self) -> Option<Document>

The selected nodes as a standalone document for the clipboard.

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

The selection as clean LaTeX for external clipboards.

pub fn exec(&mut self, cmd: Command) -> Outcome

Run one command and report what it did.

Trait Implementations

impl Default for Editor

fn default() -> Self

Returns the “default value” for a type.