Struct ColumnSettings 

pub struct ColumnSettings {
    pub column_type: ColumnType,
    pub layout_mode: ColumnLayoutMode,
    pub columns: Vec<ColumnDef>,
}

Multi-column layout settings for a section.

Maps to HWPX <hp:ctrl><hp:colPr>. Single-column layout is represented as None on Section rather than a ColumnSettings with one column.

Examples

use hwpforge_core::column::{ColumnSettings, ColumnType, ColumnLayoutMode};
use hwpforge_foundation::HwpUnit;

let cs = ColumnSettings::equal_columns(3, HwpUnit::from_mm(4.0).unwrap()).unwrap();
assert_eq!(cs.columns.len(), 3);
assert_eq!(cs.column_type, ColumnType::Newspaper);
assert_eq!(cs.layout_mode, ColumnLayoutMode::Left);

Fields

column_type: ColumnType

Column flow type.

layout_mode: ColumnLayoutMode

Column balance strategy.

columns: Vec<ColumnDef>

Individual column definitions. Length = number of columns (>= 2).

Implementations

impl ColumnSettings

pub fn equal_columns(count: u32, gap: HwpUnit) -> Result<Self, &'static str>

Creates an equal-width N-column layout with the given gap.

All columns get the same gap value (last column gap is set to zero by the encoder). Uses ColumnType::Newspaper and ColumnLayoutMode::Left as defaults.

Errors

Returns an error if count < 2 (single-column should be None).

Examples

use hwpforge_core::column::ColumnSettings;
use hwpforge_foundation::HwpUnit;

let cs = ColumnSettings::equal_columns(2, HwpUnit::from_mm(4.0).unwrap()).unwrap();
assert_eq!(cs.columns.len(), 2);

pub fn custom(columns: Vec<ColumnDef>) -> Result<Self, &'static str>

Creates a variable-width column layout from explicit definitions.

Uses ColumnType::Newspaper and ColumnLayoutMode::Left as defaults.

Errors

Returns an error if columns.len() < 2 (single-column should be None).

Examples

use hwpforge_core::column::{ColumnSettings, ColumnDef};
use hwpforge_foundation::HwpUnit;

let cs = ColumnSettings::custom(vec![
    ColumnDef { width: HwpUnit::new(14000).unwrap(), gap: HwpUnit::new(1134).unwrap() },
    ColumnDef { width: HwpUnit::new(27000).unwrap(), gap: HwpUnit::ZERO },
]).unwrap();
assert_eq!(cs.columns.len(), 2);

pub fn count(&self) -> usize

Returns the number of columns.

pub fn is_equal_width(&self) -> bool

Returns true if all columns have the same width (or width is zero, meaning 한글 calculates equal widths).

Trait Implementations

impl Clone for ColumnSettings

fn clone(&self) -> ColumnSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnSettings

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColumnSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ColumnSettings

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

Formats the value using the given formatter.

impl JsonSchema for ColumnSettings

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 ColumnSettings

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

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 ColumnSettings