Struct Placeholder 

pub struct Placeholder {
    pub kind: PlaceholderKind,
    pub index: Option<u32>,
}

<p:nvPr><p:ph type=".." idx=".."/></p:nvPr> (CT_Placeholder) — a shape’s placeholder role: which slot of the slide layout/master it fills, so its position/formatting can be inherited from there instead of being set explicitly. This crate never resolves that inheritance (no slide layout/master model beyond a single fixed, empty one — see Presentation’s doc comment); recording Placeholder on a read-back shape is purely informational; nothing else in this crate consults it.

Fields

kind: PlaceholderKind

type — which slot this shape fills (ST_PlaceholderType).

index: Option<u32>

idx — disambiguates multiple placeholders of the same kind on one layout (e.g. several body placeholders). None omits the attribute, matching a title placeholder’s own convention (real PowerPoint never writes idx on title/ctrTitle).

Implementations

impl Placeholder

pub fn new(kind: PlaceholderKind) -> Placeholder

Creates a placeholder role with no explicit index.

Examples found in repository

examples/pptx_shapes_and_placeholders.rs (line 44)

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

    let plain_shape = AutoShape::new(2, "Plain autoshape")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(5_000_000, 1_000_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_paragraph(TextParagraph::new().with_run(TextRun::text("A plain autoshape."))),
        );

    let text_box = AutoShape::new(2, "Text box")
        .with_text_box(true)
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(5_000_000, 1_000_000),
            ),
        )
        .with_text_body(TextBody::new().with_paragraph(
            TextParagraph::new().with_run(TextRun::text("A genuine text box (txBox=\"1\").")),
        ));

    let title = AutoShape::new(2, "Title placeholder")
        .with_placeholder(Placeholder::new(PlaceholderKind::CenterTitle))
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(10_515_600, 1_325_563),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_paragraph(TextParagraph::new().with_run(TextRun::text("Title placeholder"))),
        );
    let subtitle =
        AutoShape::new(3, "Subtitle placeholder")
            .with_placeholder(Placeholder::new(PlaceholderKind::SubTitle).with_index(1))
            .with_properties(
                ShapeProperties::new().with_transform(
                    Transform2D::new()
                        .with_offset(838_200, 2_400_000)
                        .with_extent(10_515_600, 800_000),
                ),
            )
            .with_text_body(TextBody::new().with_paragraph(
                TextParagraph::new().with_run(TextRun::text("Subtitle placeholder")),
            ));

    let hyperlinked_shape = AutoShape::new(2, "Hyperlinked shape")
        .with_hyperlink("https://www.rust-lang.org")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(5_000_000, 1_000_000),
            ),
        )
        .with_text_body(TextBody::new().with_paragraph(
            TextParagraph::new().with_run(TextRun::text("Click this shape to open a link.")),
        ));

    let presentation = Presentation::new()
        .with_slide(Slide::new().with_shape(Shape::AutoShape(plain_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(text_box)))
        .with_slide(
            Slide::new()
                .with_shape(Shape::AutoShape(title))
                .with_shape(Shape::AutoShape(subtitle)),
        )
        .with_slide(Slide::new().with_shape(Shape::AutoShape(hyperlinked_shape)));

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

pub fn with_index(self, index: u32) -> Placeholder

Sets this placeholder’s idx attribute.

Examples found in repository

examples/pptx_shapes_and_placeholders.rs (line 58)

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

    let plain_shape = AutoShape::new(2, "Plain autoshape")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(5_000_000, 1_000_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_paragraph(TextParagraph::new().with_run(TextRun::text("A plain autoshape."))),
        );

    let text_box = AutoShape::new(2, "Text box")
        .with_text_box(true)
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(5_000_000, 1_000_000),
            ),
        )
        .with_text_body(TextBody::new().with_paragraph(
            TextParagraph::new().with_run(TextRun::text("A genuine text box (txBox=\"1\").")),
        ));

    let title = AutoShape::new(2, "Title placeholder")
        .with_placeholder(Placeholder::new(PlaceholderKind::CenterTitle))
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(10_515_600, 1_325_563),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_paragraph(TextParagraph::new().with_run(TextRun::text("Title placeholder"))),
        );
    let subtitle =
        AutoShape::new(3, "Subtitle placeholder")
            .with_placeholder(Placeholder::new(PlaceholderKind::SubTitle).with_index(1))
            .with_properties(
                ShapeProperties::new().with_transform(
                    Transform2D::new()
                        .with_offset(838_200, 2_400_000)
                        .with_extent(10_515_600, 800_000),
                ),
            )
            .with_text_body(TextBody::new().with_paragraph(
                TextParagraph::new().with_run(TextRun::text("Subtitle placeholder")),
            ));

    let hyperlinked_shape = AutoShape::new(2, "Hyperlinked shape")
        .with_hyperlink("https://www.rust-lang.org")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(5_000_000, 1_000_000),
            ),
        )
        .with_text_body(TextBody::new().with_paragraph(
            TextParagraph::new().with_run(TextRun::text("Click this shape to open a link.")),
        ));

    let presentation = Presentation::new()
        .with_slide(Slide::new().with_shape(Shape::AutoShape(plain_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(text_box)))
        .with_slide(
            Slide::new()
                .with_shape(Shape::AutoShape(title))
                .with_shape(Shape::AutoShape(subtitle)),
        )
        .with_slide(Slide::new().with_shape(Shape::AutoShape(hyperlinked_shape)));

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

Trait Implementations

impl Clone for Placeholder

fn clone(&self) -> Placeholder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Placeholder

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

Formats the value using the given formatter.

impl Eq for Placeholder

impl PartialEq for Placeholder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Placeholder