Struct spreadsheet_ods::style::PageLayout

pub struct PageLayout { /* fields omitted */ }

Page layout. Contains all header and footer information.

use spreadsheet_ods::{write_ods, WorkBook};
use spreadsheet_ods::{cm};
use spreadsheet_ods::style::{HeaderFooter, PageLayout, Length};
use color::Rgb;
use spreadsheet_ods::style::{AttrFoBackgroundColor, AttrFoMinHeight, AttrFoMargin};

let mut wb = WorkBook::new();

let mut pl = PageLayout::new_default();

pl.set_background_color(Rgb::new(12, 129, 252));

pl.header_attr_mut().set_min_height(cm!(0.75));
pl.header_attr_mut().set_margin_left(cm!(0.15));
pl.header_attr_mut().set_margin_right(cm!(0.15));
pl.header_attr_mut().set_margin_bottom(Length::Cm(0.75));

pl.header_mut().center_mut().push_text("middle ground");
pl.header_mut().left_mut().push_text("left wing");
pl.header_mut().right_mut().push_text("right wing");

wb.add_pagelayout(pl);

write_ods(&wb, "test_out/hf0.ods").unwrap();

Implementations

impl PageLayout

pub fn new_default() -> Self

Create with name "Mpm1" and masterpage-name "Default".

pub fn new_report() -> Self

Create with name "Mpm2" and masterpage-name "Report".

pub fn set_name(&mut self, name: String)

Name.

pub fn name(&self) -> &String

Name.

pub fn set_master_page_name(&mut self, name: String)

In the xml pagelayout is split in two pieces. Each has a name.

pub fn master_page_name(&self) -> &String

In the xml pagelayout is split in two pieces. Each has a name.

pub fn attr_iter(&self) -> AttrMapIter

Iterator over the attributes of this pagelayout.

pub fn set_header(&mut self, header: HeaderFooter)

Left side header.

pub fn header(&self) -> &HeaderFooter

Left side header.

pub fn header_mut(&mut self) -> &mut HeaderFooter

Header.

pub fn set_header_left(&mut self, header: HeaderFooter)

Left side header.

pub fn header_left(&self) -> &HeaderFooter

Left side header.

pub fn header_left_mut(&mut self) -> &mut HeaderFooter

Left side header.

pub fn header_attr(&self) -> &HeaderFooterAttr

Attributes for header.

pub fn header_attr_mut(&mut self) -> &mut HeaderFooterAttr

Attributes for header.

pub fn set_footer(&mut self, footer: HeaderFooter)

Footer.

pub fn footer(&self) -> &HeaderFooter

Footer.

pub fn footer_mut(&mut self) -> &mut HeaderFooter

Footer.

pub fn set_footer_left(&mut self, footer: HeaderFooter)

Left side footer.

pub fn footer_left(&self) -> &HeaderFooter

Left side footer.

pub fn footer_left_mut(&mut self) -> &mut HeaderFooter

Left side footer.

pub fn footer_attr(&self) -> &HeaderFooterAttr

Attributes for footer.

pub fn footer_attr_mut(&mut self) -> &mut HeaderFooterAttr

Attributes for footer.

Trait Implementations

impl AttrFoBackgroundColor for PageLayout

fn set_background_color(&mut self, color: Rgb<u8>)

Border style.

impl AttrFoBorder for PageLayout

fn set_border(&mut self, width: Length, border: Border, color: Rgb<u8>)

Border style all four sides.

fn set_border_bottom(&mut self, width: Length, border: Border, color: Rgb<u8>)

Border style.

fn set_border_top(&mut self, width: Length, border: Border, color: Rgb<u8>)

Border style.

fn set_border_left(&mut self, width: Length, border: Border, color: Rgb<u8>)

Border style.

fn set_border_right(&mut self, width: Length, border: Border, color: Rgb<u8>)

Border style.

fn set_border_line_width(
    &mut self,
    inner: Length,
    spacing: Length,
    outer: Length
)

Widths for double borders.

fn set_border_line_width_bottom(
    &mut self,
    inner: Length,
    spacing: Length,
    outer: Length
)

Widths for double borders.

fn set_border_line_width_left(
    &mut self,
    inner: Length,
    spacing: Length,
    outer: Length
)

Widths for double borders.

fn set_border_line_width_right(
    &mut self,
    inner: Length,
    spacing: Length,
    outer: Length
)

Widths for double borders.

fn set_border_line_width_top(
    &mut self,
    inner: Length,
    spacing: Length,
    outer: Length
)

Widths for double borders.

impl AttrFoMargin for PageLayout

fn set_margin(&mut self, margin: Length)

fn set_margin_bottom(&mut self, margin: Length)

fn set_margin_left(&mut self, margin: Length)

fn set_margin_right(&mut self, margin: Length)

fn set_margin_top(&mut self, margin: Length)

impl AttrFoPadding for PageLayout

fn set_padding(&mut self, padding: Length)

fn set_padding_bottom(&mut self, padding: Length)

fn set_padding_left(&mut self, padding: Length)

fn set_padding_right(&mut self, padding: Length)

fn set_padding_top(&mut self, padding: Length)

impl AttrMap for PageLayout

fn attr_map(&self) -> &AttrMapType

Reference to the map of actual attributes.

fn attr_map_mut(&mut self) -> &mut AttrMapType

Reference to the map of actual attributes.

fn has_attr(&self) -> bool

Are there any attributes?

fn add_all(&mut self, data: Vec<(&str, String)>)

Add from Vec

fn set_attr(&mut self, name: &str, value: String)

Adds an attribute.

fn clear_attr(&mut self, name: &str) -> Option<String>

Removes an attribute.

fn attr(&self, name: &str) -> Option<&String>

Returns the attribute.

impl AttrStyleDynamicSpacing for PageLayout

fn set_dynamic_spacing(&mut self, dynamic: bool)

impl AttrStyleShadow for PageLayout

fn set_shadow(
    &mut self,
    x_offset: Length,
    y_offset: Length,
    blur: Option<Length>,
    color: Rgb<u8>
)

impl AttrSvgHeight for PageLayout

fn set_height(&mut self, height: Length)

impl Clone for PageLayout

fn clone(&self) -> PageLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageLayout

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

Formats the value using the given formatter.

impl Default for PageLayout

fn default() -> PageLayout

Returns the "default value" for a type.