Struct Flow 

pub struct Flow<'a> {
    pub document: &'a Document,
    pub pictures: &'a mut Pictures,
    pub zoom: f32,
    pub palette: Palette,
    pub scroll_to_heading: Option<usize>,
    pub scroll_to_place: Option<String>,
    pub followed: Option<String>,
    pub page: Option<&'a mut PageEditor>,
    pub find: Option<Highlights<'a>>,
    pub selectable: bool,
    /* private fields */
}

The state a run of blocks is drawn with.

Fields

document: &'a Document

The document, for its styles and its pictures.

pictures: &'a mut Pictures

Pictures decoded so far.

zoom: f32

Screen points per ODF point.

palette: Palette

The colours to draw in where the document names none.

scroll_to_heading: Option<usize>

The heading, counted from zero in document order, to bring into view.

Set by a panel that lists a document’s headings. It is answered while the body is drawn, because the only moment a heading’s position is known is the moment it is laid out.

scroll_to_place: Option<String>

A place in the document to bring into view: a bookmark’s name, or a heading’s text written Name|outline. Answered while the body is drawn, for the same reason scroll_to_heading is.

followed: Option<String>

A place in the document that a link just followed asked for, for the view to set scroll_to_place to on the next frame.

page: Option<&'a mut PageEditor>

The page editor, which puts a caret in every paragraph under the root and paints them. Outside edit mode there is none.

find: Option<Highlights<'a>>

The matches of a search, drawn behind the text they are in.

selectable: bool

Whether text in the page can be dragged over to select it. Off on a slide in edit mode, where a drag moves the shape instead.

Implementations

impl<'a> Flow<'a>

pub fn new( document: &'a Document, pictures: &'a mut Pictures, zoom: f32, ) -> Self

A flow over a document, drawing at a zoom.

pub fn start_at(&mut self, prefix: Vec<usize>)

Name where the root this flow draws sits under something larger, so that every path it reports and matches is from that larger root: a slide’s label is drawn from the shape and edited from the page.

impl Flow<'_>

pub fn blocks(&mut self, ui: &mut Ui, parent: &Element, width: f32)

Draw every block under an element, in order.

width is the space available in screen points, and is what a paragraph wraps to.

pub fn frame(&mut self, ui: &mut Ui, frame: &Element, width: f32)

A frame: a box with a picture, a text box or an object in it.

Public because a slide reaches it directly. Everywhere else a frame is found among a parent’s children by Self::blocks, but a shape on a slide is the frame, and asking blocks to draw it would look inside it for blocks and find a draw:image, which is not one.