Struct Session 

pub struct Session<L: FontLoader> { /* private fields */ }

An editor with keymap, typesetting, undo, clipboard, and host box tokens, driven by a few input calls.

Implementations

impl<L: FontLoader> Session<L>

pub fn new(typesetter: Typesetter<L>) -> Self

An empty editor typeset in display style by typesetter.

pub fn load(&mut self, doc: Document) -> Vec<Repair>

Replace the document, repairing what Document::validate rejects, and clear the history.

pub fn editor(&self) -> &Editor

The editor, for queries such as document, menu, and matrix_shape.

pub fn keymap(&self) -> &Keymap

The keymap, for its palette entries.

pub fn keymap_mut(&mut self) -> &mut Keymap

The keymap, for defining words and switching autocorrect.

pub fn typesetter(&self) -> &Typesetter<L>

The typesetter, whose font loader draws the faces a view’s glyph runs name.

pub fn history(&self) -> &UndoStack

The undo history.

pub fn set_undo_limit(&mut self, limit: usize)

Keep at most limit undo steps.

pub fn set_math_mode(&mut self, mode: MathMode)

Typeset inline or in display style.

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 key(&mut self, input: &KeyInput) -> Update

Feed a key event through the keymap, its commands form one undo step.

pub fn text(&mut self, s: &str) -> Update

Feed committed text such as IME output, as if each character were typed.

pub fn pointer(&mut self, at: Point, extend: bool) -> Update

Place the caret at at, or extend the selection to it, in the coordinates of View::render.

pub fn command(&mut self, cmd: Command) -> Update

Run one host command, such as a toolbar button or a menu row, as its own undo step.

pub fn commit_word(&mut self, word: &str) -> Update

Insert what a palette word inserts, as one undo step like typing it.

pub fn step_over_host_box(&mut self, entry: HostBoxEntry) -> Update

Cross the host box a motion stopped at, when the host does not take the caret into it.

pub fn undo(&mut self) -> Update

Undo the last step.

pub fn redo(&mut self) -> Update

Redo the last undone step.

pub fn copy(&mut self) -> Option<ClipboardData>

Copy the selection to the internal clipboard and return it for the system clipboard.

pub fn cut(&mut self) -> Option<(ClipboardData, Update)>

Copy the selection, then delete it as one undo step.

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

The internal clipboard.

pub fn paste_json(&mut self, json: &str) -> Result<Update, PasteError>

Paste document JSON, giving each host box a fresh token and the size its old token had.

pub fn paste_internal(&mut self) -> Result<Update, TokenError>

Paste the internal clipboard, giving each host box a fresh token.

pub fn paste_text(&mut self, s: &str) -> Update

Paste plain text through the keymap, as one undo step.

pub fn insert_host_box(&mut self) -> Result<(u32, Update), TokenError>

Mint a token and insert a host box carrying it.

pub fn mint_host_token(&mut self) -> Result<u32, TokenError>

Mint a token for a host box the host inserts itself.

pub fn set_host_box_size( &mut self, token: u32, width: Length, height: Length, depth: Length, ) -> Result<(), TokenError>

Lay out token as an empty box of this size, for hosts that draw the box content themselves.

pub fn set_host_boxes(&mut self, provider: Box<dyn HostBoxes>)

Answer \hostbox for tokens without a size through provider.

pub fn host_boxes_changed(&mut self)

Typeset again on the next view, after the provider’s boxes changed.

pub fn live_host_tokens(&mut self) -> BTreeSet<u32>

Tokens the document, the history, or the clipboard reference, and drop the sizes of every other token.

pub fn view(&mut self) -> Result<&View, TypesetError>

The typeset document with its caret and selection geometry, typeset again only after a change.

pub fn preview_word(&mut self, word: &str) -> Option<Result<View, TypesetError>>

A standalone view of what a palette word inserts, None for an unknown word.

Trait Implementations

impl<L: FontLoader> Debug for Session<L>

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

Formats the value using the given formatter.