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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

//! Animation effect type enums and trigger types.

// ---------------------------------------------------------------------------
// Entrance types
// ---------------------------------------------------------------------------

/// Preset entrance animation effects.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EntranceType {
    Appear,
    Fade,
    FlyIn,
    Wipe,
    Split,
    Wheel,
    RandomBars,
    GrowAndTurn,
    Zoom,
    Bounce,
}

impl EntranceType {
    /// OOXML `presetID` for this entrance type.
    #[must_use]
    pub const fn preset_id(self) -> u32 {
        match self {
            Self::Appear => 1,
            Self::Fade => 10,
            Self::FlyIn => 2,
            Self::Wipe => 22,
            Self::Split => 16,
            Self::Wheel => 21,
            Self::RandomBars => 14,
            Self::GrowAndTurn => 15,
            Self::Zoom => 23,
            Self::Bounce => 24,
        }
    }
}

// ---------------------------------------------------------------------------
// Exit types
// ---------------------------------------------------------------------------

/// Preset exit animation effects.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ExitType {
    Disappear,
    Fade,
    FlyOut,
    Wipe,
    Split,
}

impl ExitType {
    /// OOXML `presetID` for this exit type.
    #[must_use]
    pub const fn preset_id(self) -> u32 {
        match self {
            Self::Disappear => 1,
            Self::Fade => 10,
            Self::FlyOut => 2,
            Self::Wipe => 22,
            Self::Split => 16,
        }
    }
}

// ---------------------------------------------------------------------------
// Emphasis types
// ---------------------------------------------------------------------------

/// Preset emphasis animation effects.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EmphasisType {
    Bold,
    Grow,
    Spin,
    Transparency,
    Pulse,
    Teeter,
}

impl EmphasisType {
    /// OOXML `presetID` for this emphasis type.
    #[must_use]
    pub const fn preset_id(self) -> u32 {
        match self {
            Self::Bold => 1,
            Self::Grow => 6,
            Self::Spin => 8,
            Self::Transparency => 9,
            Self::Pulse => 10,
            Self::Teeter => 13,
        }
    }
}

// ---------------------------------------------------------------------------
// AnimationEffect
// ---------------------------------------------------------------------------

/// A single animation effect.
#[non_exhaustive]
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum AnimationEffect {
    Entrance(EntranceType),
    Exit(ExitType),
    Emphasis(EmphasisType),
    /// Custom motion path (the string is a VML-style path, e.g. `"M 0 0 L 1 1 E"`).
    MotionPath(String),
}

impl AnimationEffect {
    /// OOXML `presetClass` value.
    pub(super) const fn preset_class(&self) -> &'static str {
        match self {
            Self::Entrance(_) => "entr",
            Self::Exit(_) => "exit",
            Self::Emphasis(_) => "emph",
            Self::MotionPath(_) => "path",
        }
    }

    /// OOXML `presetID` value.
    pub(super) const fn preset_id(&self) -> u32 {
        match self {
            Self::Entrance(e) => e.preset_id(),
            Self::Exit(e) => e.preset_id(),
            Self::Emphasis(e) => e.preset_id(),
            Self::MotionPath(_) => 0, // custom path
        }
    }
}

// ---------------------------------------------------------------------------
// AnimationTrigger
// ---------------------------------------------------------------------------

/// How an animation is triggered relative to other animations.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum AnimationTrigger {
    /// Start on mouse click (default).
    OnClick,
    /// Start at the same time as the previous animation.
    WithPrevious,
    /// Start after the previous animation finishes.
    AfterPrevious,
}