Struct Caption 

pub struct Caption {
    pub side: CaptionSide,
    pub width: Option<HwpUnit>,
    pub gap: HwpUnit,
    pub paragraphs: Vec<Paragraph>,
}

Caption attached to a shape object (table, image, textbox, etc.).

Contains position, gap distance, optional explicit width, and the caption’s paragraph content. Empty paragraphs are valid (한글 allows it).

Default

Default caption: side = Bottom, width = None, gap = 850 HWPUNIT (~3mm), paragraphs = empty.

Examples

use hwpforge_core::caption::{Caption, CaptionSide};
use hwpforge_foundation::HwpUnit;

let cap = Caption::default();
assert_eq!(cap.side, CaptionSide::Bottom);
assert_eq!(cap.gap.as_i32(), 850);
assert!(cap.width.is_none());
assert!(cap.paragraphs.is_empty());

Fields

side: CaptionSide

Position of the caption relative to the object.

width: Option<HwpUnit>

Caption width in HwpUnit. None = auto (same as object width).

gap: HwpUnit

Gap between caption and object. Default: HwpUnit(850) (~3mm).

paragraphs: Vec<Paragraph>

Caption content paragraphs.

Implementations

impl Caption

pub fn new(paragraphs: Vec<Paragraph>, side: CaptionSide) -> Self

Creates a caption with the given paragraphs and side placement.

Uses default gap (850 HWPUNIT ≈ 3mm) and auto width (None).

Examples

use hwpforge_core::caption::{Caption, CaptionSide};
use hwpforge_core::paragraph::Paragraph;
use hwpforge_foundation::ParaShapeIndex;

let cap = Caption::new(
    vec![Paragraph::new(ParaShapeIndex::new(0))],
    CaptionSide::Bottom,
);
assert_eq!(cap.side, CaptionSide::Bottom);
assert_eq!(cap.gap.as_i32(), 850);
assert!(cap.width.is_none());
assert_eq!(cap.paragraphs.len(), 1);

Trait Implementations

impl Clone for Caption

fn clone(&self) -> Caption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Caption

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

Formats the value using the given formatter.

impl Default for Caption

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Caption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Caption

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 Caption

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

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 Caption