Struct HeaderFooterConfig 

pub struct HeaderFooterConfig {
    pub show_header: bool,
    pub show_footer: bool,
    pub header_height: f32,
    pub footer_height: f32,
    pub header_content: MarginBoxContent,
    pub footer_content: MarginBoxContent,
    pub font_size: f32,
    pub text_color: ColorU,
    pub skip_first_page: bool,
}

Configuration for page headers and footers.

This is a simplified interface for the common case of adding headers and footers. For full GCPM support, use PageTemplate.

Fields

show_header: bool

Whether to show a header on each page

show_footer: bool

Whether to show a footer on each page

header_height: f32

Height of the header area (if shown)

footer_height: f32

Height of the footer area (if shown)

header_content: MarginBoxContent

Content generator for the header

footer_content: MarginBoxContent

Content generator for the footer

font_size: f32

Font size for header/footer text

text_color: ColorU

Text color for header/footer

skip_first_page: bool

Whether to skip header/footer on first page

Implementations

impl HeaderFooterConfig

pub fn with_page_numbers() -> Self

Create a config with page numbers in the footer.

pub fn with_header_and_footer_page_numbers() -> Self

Create a config with page numbers in both header and footer.

pub fn with_header_text(self, text: impl Into<String>) -> Self

Set custom header text.

pub fn with_footer_text(self, text: impl Into<String>) -> Self

Set custom footer text.

pub fn generate_content( &self, content: &MarginBoxContent, info: PageInfo, ) -> String

Generate the text content for a margin box given page info.

pub fn header_text(&self, info: PageInfo) -> String

Get the header text for a specific page.

pub fn footer_text(&self, info: PageInfo) -> String

Get the footer text for a specific page.

Trait Implementations

impl Clone for HeaderFooterConfig

fn clone(&self) -> HeaderFooterConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderFooterConfig

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

Formats the value using the given formatter.

impl Default for HeaderFooterConfig

fn default() -> Self

Returns the “default value” for a type.