Struct ListLevel 

pub struct ListLevel {
    pub format: NumberFormat,
    pub text: String,
    pub indent_twips: i32,
    pub hanging_twips: i32,
}

A single indent level of a NumberingDefinition (w:lvl, CT_Lvl).

Only the handful of properties needed to produce a correctly-formatted, correctly-indented list are modeled (numFmt, lvlText, and the indentation CT_Lvl’s own pPr sets) — not pStyle (a paragraph style tied to the level), lvlPicBulletId (a picture bullet), lvlJc (WordprocessingML lets a level’s own number/bullet be right/center aligned within its indent — always left here, matching the common case), suff (what follows the number: tab/space/nothing — always a tab, Word’s default), or per-level run formatting (rPr) — a deliberately plain bullet/number, styled the same as the surrounding text, rather than needing this crate to also model fonts just to reproduce Word’s own Wingdings/Symbol-font bullet glyphs.

Fields

format: NumberFormat

How this level’s number/bullet is formatted (w:numFmt).

text: String

The level’s number/bullet template (w:lvlText‘s val) — a literal bullet character for NumberFormat::Bullet (e.g. "•"), or a placeholder template for the numbered formats, where %1 is this level’s own counter and %2/%3/. refer to ancestor levels’ counters (e.g. "%1." for a simple “1.”, or "%1.%2." for a second level that repeats its parent’s number, matching Word’s own default multilevel numbering).

indent_twips: i32

This level’s left indent, in twips (1/20 pt) — w:pPr/w:ind’s left attribute.

hanging_twips: i32

How far the number/bullet hangs to the left of the following text’s left edge, in twips — w:pPr/w:ind’s hanging attribute. Word’s own default lists always use 360 regardless of level.

Implementations

impl ListLevel

pub fn new( format: NumberFormat, text: impl Into<String>, indent_twips: i32, hanging_twips: i32, ) -> ListLevel

Creates a single indent level with explicit formatting and indentation.

Examples found in repository

examples/docx_styles_and_lists.rs (line 28)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("docx_styles_and_lists.docx");

    let heading_style = Style::new("Heading1", "Heading 1", StyleKind::Paragraph)
        .with_bold(true)
        .with_font_size(32);
    let emphasis_style = Style::new("StrongEmphasis", "Strong Emphasis", StyleKind::Character)
        .with_bold(true)
        .with_color("C00000");

    let bulleted = NumberingDefinition::bullet(1);
    let numbered = NumberingDefinition::decimal(2);
    let custom = NumberingDefinition::new(
        3,
        vec![
            ListLevel::new(NumberFormat::UpperRoman, "%1.", 720, 360),
            ListLevel::new(NumberFormat::LowerLetter, "%2)", 1440, 360),
        ],
    );

    let document = Document::new()
        .with_style(heading_style)
        .with_style(emphasis_style)
        .with_numbering_definition(bulleted)
        .with_numbering_definition(numbered)
        .with_numbering_definition(custom)
        .with_paragraph(heading("Named paragraph and character styles", false))
        .with_paragraph(
            Paragraph::with_text("This paragraph uses the Heading 1 style.")
                .with_style_id("Heading1"),
        )
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Plain text, then "))
                .with_run(Run::new("some strongly emphasized text").with_style_id("StrongEmphasis"))
                .with_run(Run::new(", then plain text again.")),
        )
        .with_paragraph(heading("Bulleted list", true))
        .with_paragraph(Paragraph::with_text("First item").with_numbering(1, 0))
        .with_paragraph(Paragraph::with_text("Second item").with_numbering(1, 0))
        .with_paragraph(Paragraph::with_text("A sub-item, one level deeper").with_numbering(1, 1))
        .with_paragraph(heading("Numbered list", true))
        .with_paragraph(Paragraph::with_text("First step").with_numbering(2, 0))
        .with_paragraph(Paragraph::with_text("Second step").with_numbering(2, 0))
        .with_paragraph(
            Paragraph::with_text("A sub-step, cumulatively numbered").with_numbering(2, 1),
        )
        .with_paragraph(heading(
            "Custom multi-level list (roman numerals, then letters)",
            true,
        ))
        .with_paragraph(Paragraph::with_text("First top-level item").with_numbering(3, 0))
        .with_paragraph(Paragraph::with_text("A lettered sub-item").with_numbering(3, 1))
        .with_paragraph(Paragraph::with_text("Second top-level item").with_numbering(3, 0));

    document.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

Trait Implementations

impl Clone for ListLevel

fn clone(&self) -> ListLevel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListLevel

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

Formats the value using the given formatter.

impl Eq for ListLevel

impl PartialEq for ListLevel

fn eq(&self, other: &ListLevel) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ListLevel