Skip to main content

HeaderFooter

Struct HeaderFooter 

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

Header/Footer data. Can be seen as three regions left/center/right or as one region. In the first case region* contains the data, in the second it’s content. Each is a TextTag of parsed XML-tags.

Implementations§

Source§

impl HeaderFooter

Source

pub fn new() -> Self

Create

Source

pub fn set_display(&mut self, display: bool)

Is the header displayed. Used to deactivate left side headers.

Source

pub fn display(&self) -> bool

Display

Source

pub fn is_empty(&self) -> bool

true if all regions of the header/footer are empty.

Source

pub fn set_left(&mut self, txt: Vec<TextTag>)

Set the content of the left region of the header.

Attention: This tag must be a text:p otherwise its ignored.

Source

pub fn add_left(&mut self, txt: TextTag)

Adds to the content of the left region of the header.

Attention: This tag must be a text:p otherwise its ignored.

Source

pub fn clear_left(&mut self)

Clear left region.

Source

pub fn left(&self) -> &Vec<TextTag>

Left region.

Source

pub fn left_mut(&mut self) -> &mut Vec<TextTag>

Left region.

Source

pub fn set_center(&mut self, txt: Vec<TextTag>)

Set the content of the center region of the header.

Attention: This tag must be a text:p otherwise its ignored.

Source

pub fn add_center(&mut self, txt: TextTag)

Adds to the content of the center region of the header.

Attention: This tag must be a text:p otherwise its ignored.

Source

pub fn clear_center(&mut self)

Center region.

Source

pub fn center(&self) -> &Vec<TextTag>

Center region.

Source

pub fn center_mut(&mut self) -> &mut Vec<TextTag>

Center region.

Source

pub fn set_right(&mut self, txt: Vec<TextTag>)

Set the content of the right region of the header.

Attention: This tag must be a text:p otherwise its ignored.

Source

pub fn add_right(&mut self, txt: TextTag)

Adds to the content of the right region of the header.

Attention: This tag must be a text:p otherwise its ignored.

Source

pub fn clear_right(&mut self)

Right region.

Source

pub fn right(&self) -> &Vec<TextTag>

Right region.

Source

pub fn right_mut(&mut self) -> &mut Vec<TextTag>

Right region.

Source

pub fn set_content(&mut self, txt: Vec<TextTag>)

Header content, if there are no regions.

Source

pub fn add_content(&mut self, txt: TextTag)

Adds header content, if there are no regions.

Source

pub fn content(&self) -> &Vec<TextTag>

Header content, if there are no regions.

Source

pub fn content_mut(&mut self) -> &mut Vec<TextTag>

Header content, if there are no regions.

Trait Implementations§

Source§

impl Clone for HeaderFooter

Source§

fn clone(&self) -> HeaderFooter

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 HeaderFooter

Source§

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

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

impl Default for HeaderFooter

Source§

fn default() -> HeaderFooter

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

impl GetSize for HeaderFooter

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.