Struct Section 

pub struct Section {
    pub paragraphs: Vec<Paragraph>,
    pub page_settings: PageSettings,
    pub header: Option<HeaderFooter>,
    pub footer: Option<HeaderFooter>,
    pub page_number: Option<PageNumber>,
    pub column_settings: Option<ColumnSettings>,
    pub visibility: Option<Visibility>,
    pub line_number_shape: Option<LineNumberShape>,
    pub page_border_fills: Option<Vec<PageBorderFillEntry>>,
    pub master_pages: Option<Vec<MasterPage>>,
    pub begin_num: Option<BeginNum>,
    pub text_direction: TextDirection,
}

A document section: paragraphs + page geometry.

Examples

use hwpforge_core::section::Section;
use hwpforge_core::PageSettings;
use hwpforge_core::paragraph::Paragraph;
use hwpforge_foundation::ParaShapeIndex;

let section = Section::with_paragraphs(
    vec![Paragraph::new(ParaShapeIndex::new(0))],
    PageSettings::a4(),
);
assert_eq!(section.paragraph_count(), 1);

Fields

paragraphs: Vec<Paragraph>

Ordered paragraphs in this section.

page_settings: PageSettings

Page dimensions and margins for this section.

header: Option<HeaderFooter>

Optional header for this section.

footer: Option<HeaderFooter>

Optional footer for this section.

page_number: Option<PageNumber>

Optional page number settings for this section.

column_settings: Option<ColumnSettings>

Multi-column layout. None = single column (default).

visibility: Option<Visibility>

Visibility flags for headers, footers, borders, etc. None = default visibility (show everything).

line_number_shape: Option<LineNumberShape>

Line numbering settings. None = no line numbers.

page_border_fills: Option<Vec<PageBorderFillEntry>>

Page border/fill entries. None = default 3 entries (BOTH/EVEN/ODD with borderFillIDRef=1).

master_pages: Option<Vec<MasterPage>>

Master pages (background content rendered behind the body). None = no master pages (default).

begin_num: Option<BeginNum>

Starting numbers for auto-numbering sequences. None = default values (all start at 1).

text_direction: TextDirection

Text writing direction for this section. Defaults to TextDirection::Horizontal (가로쓰기).

Implementations

impl Section

pub fn new(page_settings: PageSettings) -> Self

Creates an empty section with the given page settings.

Examples

use hwpforge_core::section::Section;
use hwpforge_core::PageSettings;

let section = Section::new(PageSettings::a4());
assert!(section.is_empty());

pub fn with_paragraphs( paragraphs: Vec<Paragraph>, page_settings: PageSettings, ) -> Self

Creates a section with pre-built paragraphs.

Examples

use hwpforge_core::section::Section;
use hwpforge_core::PageSettings;
use hwpforge_core::paragraph::Paragraph;
use hwpforge_foundation::ParaShapeIndex;

let section = Section::with_paragraphs(
    vec![Paragraph::new(ParaShapeIndex::new(0))],
    PageSettings::letter(),
);
assert_eq!(section.paragraph_count(), 1);

pub fn with_text_direction(self, dir: TextDirection) -> Self

Sets the text writing direction for this section and returns self.

Examples

use hwpforge_core::section::Section;
use hwpforge_core::PageSettings;
use hwpforge_foundation::TextDirection;

let section = Section::new(PageSettings::a4())
    .with_text_direction(TextDirection::Vertical);
assert_eq!(section.text_direction, TextDirection::Vertical);

pub fn add_paragraph(&mut self, paragraph: Paragraph)

Appends a paragraph to this section.

pub fn paragraph_count(&self) -> usize

Returns the number of paragraphs.

pub fn is_empty(&self) -> bool

Returns true if this section has no paragraphs.

Trait Implementations

impl Clone for Section

fn clone(&self) -> Section

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Section

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Section

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Section

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

Formats the value using the given formatter.

impl JsonSchema for Section

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 Section

fn eq(&self, other: &Section) -> 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 Section

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 Section