Struct spreadsheet_ods::WorkBook

pub struct WorkBook { /* fields omitted */ }

Book is the main structure for the Spreadsheet.

Implementations

impl WorkBook

pub fn new() -> Self

Empty.

pub fn version(&self) -> &String

Set ODS version.

pub fn set_version(&mut self, version: String)

ODS version.

pub fn config(&self) -> &WorkBookConfig

Configuration flags.

pub fn config_mut(&mut self) -> &mut WorkBookConfig

Configuration flags.

pub fn num_sheets(&self) -> usize

Number of sheets.

pub fn sheet_idx<S: AsRef<str>>(&self, name: S) -> Option<usize>

Finds the sheet index by the sheet-name.

pub fn detach_sheet(&mut self, n: usize) -> Detached<usize, Sheet>

Detaches a sheet. Useful if you have to make mutating calls to the workbook and the sheet intermixed.

Warning

The sheet has to be re-attached before saving the workbook.

Panics

Panics if the sheet has already been detached. Panics if n is out of bounds.

pub fn attach_sheet(&mut self, sheet: Detached<usize, Sheet>)

Reattaches the sheet in the place it was before.

Panics

Panics if n is out of bounds.

pub fn sheet(&self, n: usize) -> &Sheet

Returns a certain sheet.

Panics

Panics if n is out of bounds.

pub fn sheet_mut(&mut self, n: usize) -> &mut Sheet

Returns a certain sheet.

Panics

Panics if n does not exist.

pub fn insert_sheet(&mut self, i: usize, sheet: Sheet)

Inserts the sheet at the given position.

pub fn push_sheet(&mut self, sheet: Sheet)

Appends a sheet.

pub fn remove_sheet(&mut self, n: usize) -> Sheet

Removes a sheet from the table.

Panics

Panics if the sheet was detached.

pub fn add_def_style(&mut self, value_type: ValueType, style: &CellStyleRef)

Adds a default-style for all new values. This information is only used when writing the data to the ODS file.

pub fn def_style(&self, value_type: ValueType) -> Option<&String>

Returns the default style name.

pub fn find_value_format(&self, style_name: &str) -> Option<&ValueFormat>

Finds a ValueFormat starting with the stylename attached to a cell.

pub fn add_font(&mut self, font: FontFaceDecl)

Adds a font.

pub fn remove_font(&mut self, name: &str) -> Option<FontFaceDecl>

Removes a font.

pub fn font(&self, name: &str) -> Option<&FontFaceDecl>

Returns the FontDecl.

pub fn font_mut(&mut self, name: &str) -> Option<&mut FontFaceDecl>

Returns a mutable FontDecl.

pub fn add_tablestyle(&mut self, style: TableStyle) -> TableStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

pub fn remove_tablestyle(&mut self, name: &str) -> Option<TableStyle>

Removes a style.

pub fn tablestyle(&self, name: &str) -> Option<&TableStyle>

Returns the style.

pub fn tablestyle_mut(&mut self, name: &str) -> Option<&mut TableStyle>

Returns the mutable style.

pub fn add_rowstyle(&mut self, style: RowStyle) -> RowStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

pub fn remove_rowstyle(&mut self, name: &str) -> Option<RowStyle>

Removes a style.

pub fn rowstyle(&self, name: &str) -> Option<&RowStyle>

Returns the style.

pub fn rowstyle_mut(&mut self, name: &str) -> Option<&mut RowStyle>

Returns the mutable style.

pub fn add_colstyle(&mut self, style: ColStyle) -> ColStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

pub fn remove_colstyle(&mut self, name: &str) -> Option<ColStyle>

Removes a style.

pub fn colstyle(&self, name: &str) -> Option<&ColStyle>

Returns the style.

pub fn colstyle_mut(&mut self, name: &str) -> Option<&mut ColStyle>

Returns the mutable style.

pub fn add_cellstyle(&mut self, style: CellStyle) -> CellStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

pub fn remove_cellstyle(&mut self, name: &str) -> Option<CellStyle>

Removes a style.

pub fn cellstyle(&self, name: &str) -> Option<&CellStyle>

Returns the style.

pub fn cellstyle_mut(&mut self, name: &str) -> Option<&mut CellStyle>

Returns the mutable style.

pub fn add_paragraphstyle(&mut self, style: ParagraphStyle) -> ParagraphStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

pub fn remove_paragraphstyle(&mut self, name: &str) -> Option<ParagraphStyle>

Removes a style.

pub fn paragraphstyle(&self, name: &str) -> Option<&ParagraphStyle>

Returns the style.

pub fn paragraphstyle_mut(&mut self, name: &str) -> Option<&mut ParagraphStyle>

Returns the mutable style.

pub fn add_textstyle(&mut self, style: TextStyle) -> TextStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

pub fn remove_textstyle(&mut self, name: &str) -> Option<TextStyle>

Removes a style.

pub fn textstyle(&self, name: &str) -> Option<&TextStyle>

Returns the style.

pub fn textstyle_mut(&mut self, name: &str) -> Option<&mut TextStyle>

Returns the mutable style.

pub fn add_graphicstyle(&mut self, style: GraphicStyle) -> GraphicStyleRef

Adds a style. Unnamed styles will be assigned an automatic name.

pub fn remove_graphicstyle(&mut self, name: &str) -> Option<GraphicStyle>

Removes a style.

pub fn graphicstyle(&self, name: &str) -> Option<&GraphicStyle>

Returns the style.

pub fn graphicstyle_mut(&mut self, name: &str) -> Option<&mut GraphicStyle>

Returns the mutable style.

pub fn add_format(&mut self, vstyle: ValueFormat) -> ValueFormatRef

Adds a value format. Unnamed formats will be assigned an automatic name.

pub fn remove_format(&mut self, name: &str) -> Option<ValueFormat>

Removes the format.

pub fn format(&self, name: &str) -> Option<&ValueFormat>

Returns the format.

pub fn format_mut(&mut self, name: &str) -> Option<&mut ValueFormat>

Returns the mutable format.

pub fn add_pagestyle(&mut self, pstyle: PageStyle) -> PageStyleRef

Adds a value PageStyle. Unnamed formats will be assigned an automatic name.

pub fn remove_pagestyle(&mut self, name: &str) -> Option<PageStyle>

Removes the PageStyle.

pub fn pagestyle(&self, name: &str) -> Option<&PageStyle>

Returns the PageStyle.

pub fn pagestyle_mut(&mut self, name: &str) -> Option<&mut PageStyle>

Returns the mutable PageStyle.

pub fn add_masterpage(&mut self, mpage: MasterPage) -> MasterPageRef

Adds a value MasterPage. Unnamed formats will be assigned an automatic name.

pub fn remove_masterpage(&mut self, name: &str) -> Option<MasterPage>

Removes the MasterPage.

pub fn masterpage(&self, name: &str) -> Option<&MasterPage>

Returns the MasterPage.

pub fn masterpage_mut(&mut self, name: &str) -> Option<&mut MasterPage>

Returns the mutable MasterPage.

pub fn add_validation(&mut self, valid: Validation) -> ValidationRef

Adds a Validation. Nameless validations will be assigned a name.

pub fn remove_validation(&mut self, name: &str) -> Option<Validation>

Removes a Validation.

pub fn validation(&self, name: &str) -> Option<&Validation>

Returns the Validation.

pub fn validation_mut(&mut self, name: &str) -> Option<&mut Validation>

Returns a mutable Validation.

Trait Implementations

impl Clone for WorkBook

fn clone(&self) -> WorkBook

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkBook

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

Formats the value using the given formatter.

impl Default for WorkBook

fn default() -> WorkBook

Returns the “default value” for a type.