Skip to main content

MasterPage

Struct MasterPage 

Source
pub struct MasterPage { /* private fields */ }
Expand description

Defines the structure and content for a page. Refers to a PageStyle for layout information. It must be attached to a Sheet to be used.

use spreadsheet_ods::{pt, Length, WorkBook, Sheet};
use spreadsheet_ods::style::{PageStyle, MasterPage, TableStyle};
use spreadsheet_ods::style::units::Border;
use spreadsheet_ods::xmltree::XmlVec;
use spreadsheet_ods::color::Rgb;
use icu_locale_core::locale;

let mut wb = WorkBook::new(locale!("en-US"));

let mut ps = PageStyle::new("ps1");
ps.set_border(pt!(0.5), Border::Groove, Rgb::new(128,128,128));
ps.headerstyle_mut().set_background_color(Rgb::new(92,92,92));
let ps_ref = wb.add_pagestyle(ps);

let mut mp1 = MasterPage::new("mp1");
mp1.set_pagestyle(&ps_ref);
mp1.header_mut().center_mut().add_text("center");
mp1.footer_mut().right_mut().add_text("right");
let mp1_ref = wb.add_masterpage(mp1);

let mut ts = TableStyle::new("ts1");
ts.set_master_page(&mp1_ref);
let ts_ref = wb.add_tablestyle(ts);

let mut sheet = Sheet::new("sheet 1");
sheet.set_style(&ts_ref);

Implementations§

Source§

impl MasterPage

Source

pub fn new_empty() -> Self

Empty.

Source

pub fn new<S: AsRef<str>>(name: S) -> Self

New MasterPage

Source

pub fn masterpage_ref(&self) -> MasterPageRef

Style reference.

Source

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

Name.

Source

pub fn name(&self) -> &String

Name.

Source

pub fn set_display_name(&mut self, display_name: String)

Name.

Source

pub fn display_name(&self) -> &String

Name.

Source

pub fn set_pagestyle(&mut self, name: &PageStyleRef)

Reference to a page-style.

Source

pub fn pagestyle(&self) -> Option<&PageStyleRef>

Reference to a page-style.

Source

pub fn set_next_masterpage(&mut self, master: &MasterPageRef)

The style:next-style-name attribute specifies the name of the master page that is used for the next page if the current page is entirely filled. If the next style name is not specified, the current master page is used for the next page. The value of this attribute shall be the name of a style:master-page element.

Source

pub fn next_masterpage(&self) -> Option<&MasterPageRef>

Next.

Source

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

Left side header.

Source

pub fn header(&self) -> &HeaderFooter

Left side header.

Source

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

Header.

Source

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

First page header.

Source

pub fn header_first(&self) -> &HeaderFooter

First page header.

Source

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

First page header.

Source

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

Left side header.

Source

pub fn header_left(&self) -> &HeaderFooter

Left side header.

Source

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

Left side header.

Footer.

Source

pub fn footer(&self) -> &HeaderFooter

Footer.

Source

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

Footer.

First page footer.

Source

pub fn footer_first(&self) -> &HeaderFooter

First page footer.

Source

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

First page footer.

Left side footer.

Source

pub fn footer_left(&self) -> &HeaderFooter

Left side footer.

Source

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

Left side footer.

Trait Implementations§

Source§

impl Clone for MasterPage

Source§

fn clone(&self) -> MasterPage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MasterPage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MasterPage

Source§

fn default() -> MasterPage

Returns the “default value” for a type. Read more
Source§

impl GetSize for MasterPage

Source§

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap. Read more
Source§

fn get_heap_size_with_tracker<TRACKER: GetSizeTracker>( &self, tracker: TRACKER, ) -> (usize, TRACKER)

Determines how many bytes this object occupies inside the heap while using a tracker. Read more
Source§

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack. Read more
Source§

fn get_size(&self) -> usize

Determines the total size of the object. Read more
Source§

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)
where T: GetSizeTracker,

Determines the total size of the object while using a tracker. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.