Struct TextDocument 

pub struct TextDocument {
    pub document: Document,
}

An OpenDocument text document.

The body is a flow of block elements — paragraphs, headings, lists, tables, sections, frames — in the order they are read, which is the order they are drawn. Nothing here paginates: a page layout says how wide a line may be, and that is what Self::page_layout is for.

Fields

document: Document

The package and everything shared with the other two formats.

Implementations

impl TextDocument

pub fn read(bytes: &[u8]) -> Result<Self, Error>

Read a .odt package.

Errors

The bytes are not a text document, or its content.xml cannot be read.

pub fn body(&self) -> Option<&Element>

The office:text element: the flow.

None for a package that declares itself a text document and carries no text body, which is a broken document rather than an empty one.

pub fn body_mut(&mut self) -> Option<&mut Element>

The same, for changing it.

pub fn body_path(&self) -> Option<Vec<usize>>

Where Self::body is under the content root, as a path of child indices: what an editor addresses the body’s paragraphs from.

pub fn page_layout(&self) -> PageLayout

The page layout the document’s first master page points at.

A text document has one master page per page style, and the first is the one the body starts on. Where there is none, or no styles.xml at all, the default of PageLayout applies.

pub fn text_width(&self) -> f32

The width a line of body text may be: the page less its side margins.

pub fn outline(&self) -> Vec<Heading>

The document’s headings, as an outline for navigating it: each heading’s level, its text, and its position among the body’s children.

Only the top level of the body is walked. A heading inside a table cell or a frame is not a heading in the outline — ODF permits one and no application lists it — and a heading inside a section is, which is why sections are descended into.

pub fn paragraph_style(&self, element: &Element) -> Rc<Properties>

The style a block element asks for, resolved.

The family is the one the element belongs to, which for everything in a text flow is Family::Paragraph except a table and its parts.