Struct FlowModel 

pub struct FlowModel<'a> { /* private fields */ }

The paragraphs under a root in a content tree, for one frame’s editing.

Implementations

impl<'a> FlowModel<'a>

pub fn new( content: &'a mut Element, styles: &'a mut Styles, root: Vec<usize>, editing: &'a mut Editing, ) -> Self

The paragraphs under the element at a path in a content tree, whose document’s styles are styles.

pub fn tagged(self, tag: Vec<usize>) -> Self

Have the caret an undo step remembers begin with these indices, which the view takes off again when it is asked to put the caret back.

pub fn within(self, scope: Vec<usize>) -> Self

Keep to the paragraphs under one element beneath the root, so that moving and joining never leave it: a slide’s label does not run on into the next shape.

pub fn is_block(&self, selection: &Selection<Vec<usize>>, block: Block) -> bool

Whether a block is what every paragraph a selection runs over already is, which is when its button is lit and pressing it takes it off.

pub fn replace_matches( &mut self, matches: &[&Match], with: &str, new_step: bool, ) -> Replaced

Replace each match of a search with a text, last first so that the offsets of the ones before hold. The first replacement begins an undo step when new_step says so and the rest join it. Answers how many were replaced.

pub fn apply_block(&mut self, editor: &mut PageEditor, block: Block) -> bool

Make the paragraphs a selection runs over a kind of paragraph, or take them out of it where they already are one, as one step to undo, and put the selection back over the same paragraphs. Answers whether the document changed.

Trait Implementations

impl Model for FlowModel<'_>

type Paragraph = Vec<usize>

Names a paragraph. An edit may change what any paragraph is called, so the editor holds only the positions the model hands back.

fn text(&self, paragraph: &Vec<usize>) -> Option<String>

The paragraph’s text, with a line break as '\n' and a tab as '\t'. None when the model has no such paragraph.

fn next(&self, paragraph: &Vec<usize>) -> Option<Vec<usize>>

The editable paragraph after this one in document order.

fn previous(&self, paragraph: &Vec<usize>) -> Option<Vec<usize>>

The editable paragraph before this one in document order.

fn first(&self) -> Option<Vec<usize>>

The first editable paragraph, None when there is none.

fn last(&self) -> Option<Vec<usize>>

The last editable paragraph, None when there is none.

fn marked( &self, from: &Position<Vec<usize>>, to: &Position<Vec<usize>>, mark: Mark, ) -> Option<bool>

Whether the text from one position to another carries a mark: Some when all of it says the same, None when it differs. Two positions that are the same answer for the text typed there would take its formatting from. A model that keeps no formatting leaves this as it is, which says nothing is marked, and refuses Edit::Format.

fn fragment( &self, from: &Position<Vec<usize>>, to: &Position<Vec<usize>>, ) -> Option<Fragment>

A copy of the text from one position to another that keeps what the plain text of it cannot, for pasting back into this model. The editor holds it beside the plain text it put on the clipboard and uses it only while the clipboard still holds that text. A model that keeps no formatting leaves this as it is and pastes are plain.

fn paste_fragment( &mut self, at: &Position<Vec<usize>>, fragment: &Fragment, new_step: bool, ) -> Option<Position<Vec<usize>>>

Put a Fragment this model made in at a position, as one edit, and answer where the caret stands after it. new_step is as for Self::apply. None refuses it, and the paste is plain.

fn apply( &mut self, edit: Edit<'_, Vec<usize>>, new_step: bool, ) -> Option<Position<Vec<usize>>>

Make an edit, and answer where the caret stands after it: after the replacing text, at the start of the second half of a split, or for a format at the end of the formatted text. None refuses the edit and leaves the document as it was.