Struct PageNumber 

pub struct PageNumber {
    pub position: PageNumberPosition,
    pub number_format: NumberFormatType,
    pub decoration: String,
}

Page number display settings for a section.

In HWPX, page numbers appear as <hp:pageNum> inside <hp:ctrl>. This struct controls position, format, and optional decoration characters.

Examples

use hwpforge_core::section::PageNumber;
use hwpforge_foundation::{NumberFormatType, PageNumberPosition};

let pn = PageNumber::new(
    PageNumberPosition::BottomCenter,
    NumberFormatType::Digit,
);
assert_eq!(pn.position, PageNumberPosition::BottomCenter);

Fields

position: PageNumberPosition

Where to display the page number.

number_format: NumberFormatType

Numbering format (digits, roman, etc.).

decoration: String

Optional decoration string placed around the number (e.g. "- " for "- 1 -"). Empty means no decoration.

Implementations

impl PageNumber

pub fn new( position: PageNumberPosition, number_format: NumberFormatType, ) -> Self

Creates a new page number with no decoration.

pub fn bottom_center() -> Self

Creates a page number at the bottom-center in plain digit format.

This is the most common page number layout for Korean documents. Equivalent to PageNumber::new(PageNumberPosition::BottomCenter, NumberFormatType::Digit) with an empty decoration.

Examples

use hwpforge_core::section::PageNumber;
use hwpforge_foundation::{NumberFormatType, PageNumberPosition};

let pn = PageNumber::bottom_center();
assert_eq!(pn.position, PageNumberPosition::BottomCenter);
assert_eq!(pn.number_format, NumberFormatType::Digit);
assert!(pn.decoration.is_empty());

pub fn with_decoration( position: PageNumberPosition, number_format: NumberFormatType, decoration: impl Into<String>, ) -> Self

Creates a new page number with decoration characters placed around the number.

Examples

use hwpforge_core::section::PageNumber;
use hwpforge_foundation::{NumberFormatType, PageNumberPosition};

let pn = PageNumber::with_decoration(
    PageNumberPosition::BottomCenter,
    NumberFormatType::Digit,
    "- ",
);
assert_eq!(pn.decoration, "- ");

pub fn with_side_char( position: PageNumberPosition, number_format: NumberFormatType, side_char: impl Into<String>, ) -> Self

👎Deprecated since 0.2.0: Use with_decoration() instead

Creates a new page number with side decoration characters.

Trait Implementations

impl Clone for PageNumber

fn clone(&self) -> PageNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageNumber

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PageNumber

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PageNumber

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

Formats the value using the given formatter.

impl JsonSchema for PageNumber

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 PageNumber

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PageNumber

impl StructuralPartialEq for PageNumber