pptx 0.1.0

A Rust library for creating and manipulating PowerPoint (.pptx) files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Slide animation types and settings.
//!
//! Provides basic support for `PowerPoint` slide animations (entrance, exit,
//! emphasis, and motion-path effects). Animations are serialised into the
//! `<p:timing>` element that sits at the end of every slide XML.

mod effects;
mod xml_gen;

pub use effects::{AnimationEffect, AnimationTrigger, EmphasisType, EntranceType, ExitType};

use crate::units::{DurationMs, ShapeId};

// ---------------------------------------------------------------------------
// SlideAnimation
// ---------------------------------------------------------------------------

/// A single animation applied to one shape on a slide.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SlideAnimation {
    /// The `spid` of the target shape (OOXML shape identifier).
    pub target_shape_id: ShapeId,
    /// The animation effect to apply.
    pub effect: AnimationEffect,
    /// When the animation starts.
    pub trigger: AnimationTrigger,
    /// Duration in milliseconds (default 500).
    pub duration_ms: DurationMs,
    /// Delay before the animation starts, in milliseconds (default 0).
    pub delay_ms: DurationMs,
}

impl SlideAnimation {
    /// Create a new animation with sensible defaults.
    #[must_use]
    pub const fn new(target_shape_id: ShapeId, effect: AnimationEffect) -> Self {
        Self {
            target_shape_id,
            effect,
            trigger: AnimationTrigger::OnClick,
            duration_ms: DurationMs(500),
            delay_ms: DurationMs(0),
        }
    }

    /// Set the trigger type.
    #[must_use]
    pub const fn with_trigger(mut self, trigger: AnimationTrigger) -> Self {
        self.trigger = trigger;
        self
    }

    /// Set the duration in milliseconds.
    #[must_use]
    pub const fn with_duration(mut self, ms: DurationMs) -> Self {
        self.duration_ms = ms;
        self
    }

    /// Set the delay in milliseconds.
    #[must_use]
    pub const fn with_delay(mut self, ms: DurationMs) -> Self {
        self.delay_ms = ms;
        self
    }
}

// ---------------------------------------------------------------------------
// AnimationSequence
// ---------------------------------------------------------------------------

/// An ordered sequence of animations for a slide.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AnimationSequence {
    pub(crate) animations: Vec<SlideAnimation>,
}

impl AnimationSequence {
    /// Create an empty animation sequence.
    #[must_use]
    pub const fn new() -> Self {
        Self {
            animations: Vec::new(),
        }
    }

    /// Append an animation to the sequence.
    pub fn add(&mut self, animation: SlideAnimation) {
        self.animations.push(animation);
    }

    /// Number of animations in the sequence.
    #[must_use]
    pub fn len(&self) -> usize {
        self.animations.len()
    }

    /// Returns `true` if the sequence contains no animations.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.animations.is_empty()
    }
}

/// Creates an empty animation sequence with no effects.
impl Default for AnimationSequence {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests;