Struct HeaderFooter 

pub struct HeaderFooter {
    pub paragraphs: Vec<Paragraph>,
    pub apply_page_type: ApplyPageType,
}

A header or footer region containing paragraphs.

In HWPX, headers and footers appear as <hp:header> / <hp:footer> elements inside <hp:ctrl> in the section body. Each contains its own paragraphs and an ApplyPageType controlling which pages it applies to.

Examples

use hwpforge_core::section::HeaderFooter;
use hwpforge_core::paragraph::Paragraph;
use hwpforge_foundation::{ApplyPageType, ParaShapeIndex};

let hf = HeaderFooter::new(
    vec![Paragraph::new(ParaShapeIndex::new(0))],
    ApplyPageType::Both,
);
assert_eq!(hf.paragraphs.len(), 1);
assert_eq!(hf.apply_page_type, ApplyPageType::Both);

Fields

paragraphs: Vec<Paragraph>

Paragraphs composing the header/footer content.

apply_page_type: ApplyPageType

Which pages this header/footer applies to.

Implementations

impl HeaderFooter

pub fn new(paragraphs: Vec<Paragraph>, apply_page_type: ApplyPageType) -> Self

Creates a new header/footer with the given paragraphs and page scope.

pub fn all_pages(paragraphs: Vec<Paragraph>) -> Self

Creates a header/footer applied to all pages (both odd and even).

This is the most common case for simple documents that use a single header or footer on every page.

Examples

use hwpforge_core::section::HeaderFooter;
use hwpforge_core::paragraph::Paragraph;
use hwpforge_foundation::{ApplyPageType, ParaShapeIndex};

let hf = HeaderFooter::all_pages(vec![Paragraph::new(ParaShapeIndex::new(0))]);
assert_eq!(hf.apply_page_type, ApplyPageType::Both);
assert_eq!(hf.paragraphs.len(), 1);

pub fn both(paragraphs: Vec<Paragraph>) -> Self

👎Deprecated since 0.2.0: Use all_pages() instead

Creates a header/footer applied to all pages.

Trait Implementations

impl Clone for HeaderFooter

fn clone(&self) -> HeaderFooter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderFooter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HeaderFooter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HeaderFooter

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

Formats the value using the given formatter.

impl JsonSchema for HeaderFooter

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for HeaderFooter

fn eq(&self, other: &HeaderFooter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HeaderFooter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HeaderFooter