Struct PageSettings 

pub struct PageSettings {
    pub width: HwpUnit,
    pub height: HwpUnit,
    pub margin_left: HwpUnit,
    pub margin_right: HwpUnit,
    pub margin_top: HwpUnit,
    pub margin_bottom: HwpUnit,
    pub header_margin: HwpUnit,
    pub footer_margin: HwpUnit,
    pub gutter: HwpUnit,
    pub gutter_type: GutterType,
    pub mirror_margins: bool,
    pub landscape: bool,
}

Physical page dimensions and margins for a section.

Contains 8 HwpUnit fields covering all geometry a page needs. Copy because it is 32 bytes – small enough to pass by value.

Presets

• PageSettings::a4() – A4 (210 mm x 297 mm) with 20 mm margins
• PageSettings::letter() – US Letter (8.5“ x 11“) with 1“ margins

Examples

use hwpforge_core::PageSettings;
use hwpforge_foundation::HwpUnit;

let custom = PageSettings {
    width: HwpUnit::from_mm(148.0).unwrap(),
    height: HwpUnit::from_mm(210.0).unwrap(),
    ..PageSettings::a4()
};
assert!(custom.width.to_mm() < 149.0);

Fields

width: HwpUnit

Page width.

height: HwpUnit

Page height.

margin_left: HwpUnit

Left margin.

margin_right: HwpUnit

Right margin.

margin_top: HwpUnit

Top margin.

margin_bottom: HwpUnit

Bottom margin.

header_margin: HwpUnit

Header margin (distance from page top to header baseline).

footer_margin: HwpUnit

Footer margin (distance from page bottom to footer baseline).

gutter: HwpUnit

Binding gutter width. Defaults to 0 (no gutter).

gutter_type: GutterType

Gutter position type. Defaults to LeftOnly.

mirror_margins: bool

Whether to mirror left/right margins on even pages (for bound documents).

landscape: bool

Whether this section uses landscape orientation. When true, the encoder outputs landscape="NARROWLY" (한글’s reversed convention). Width/height should remain in portrait order (e.g. 210x297 for A4); 한글 handles the rotation internally.

Implementations

impl PageSettings

pub fn a4() -> Self

A4 paper (210 mm x 297 mm) with 20 mm margins, 10 mm header/footer.

These are the de-facto default settings for Korean government documents and the HWP editor’s default.

Examples

use hwpforge_core::PageSettings;

let a4 = PageSettings::a4();
assert!((a4.width.to_mm() - 210.0).abs() < 0.1);
assert!((a4.height.to_mm() - 297.0).abs() < 0.1);

pub fn letter() -> Self

US Letter (8.5“ x 11“) with 1“ margins, 0.5“ header/footer.

Examples

use hwpforge_core::PageSettings;

let letter = PageSettings::letter();
assert_eq!(letter.width.as_i32(), 61200); // 8.5 * 7200
assert_eq!(letter.height.as_i32(), 79200); // 11 * 7200

pub fn printable_width(&self) -> HwpUnit

Returns the printable width (page width minus left and right margins).

Examples

use hwpforge_core::PageSettings;

let a4 = PageSettings::a4();
let printable = a4.printable_width();
// 210mm - 20mm - 20mm = 170mm
assert!((printable.to_mm() - 170.0).abs() < 0.5);

pub fn printable_height(&self) -> HwpUnit

Returns the printable height (page height minus top and bottom margins).

Trait Implementations

impl Clone for PageSettings

fn clone(&self) -> PageSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PageSettings

impl Debug for PageSettings

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

Formats the value using the given formatter.

impl Default for PageSettings

fn default() -> Self

Default page settings are A4 with 20 mm margins.

impl<'de> Deserialize<'de> for PageSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PageSettings

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

Formats the value using the given formatter.

impl Eq for PageSettings

impl JsonSchema for PageSettings

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 PageSettings

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

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 PageSettings