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
|
"""Main presentation object."""
from __future__ import annotations
from typing import IO, TYPE_CHECKING, cast
from pptx.shared import PartElementProxy
from pptx.slide import SlideMasters, Slides
from pptx.util import lazyproperty
if TYPE_CHECKING:
from pptx.oxml.presentation import CT_Presentation, CT_SlideId
from pptx.parts.presentation import PresentationPart
from pptx.slide import NotesMaster, SlideLayouts
from pptx.util import Length
class Presentation(PartElementProxy):
"""PresentationML (PML) presentation.
Not intended to be constructed directly. Use :func:`pptx.Presentation` to open or
create a presentation.
"""
_element: CT_Presentation
part: PresentationPart # pyright: ignore[reportIncompatibleMethodOverride]
@property
def core_properties(self):
"""|CoreProperties| instance for this presentation.
Provides read/write access to the Dublin Core document properties for the presentation.
"""
return self.part.core_properties
@property
def notes_master(self) -> NotesMaster:
"""Instance of |NotesMaster| for this presentation.
If the presentation does not have a notes master, one is created from a default template
and returned. The same single instance is returned on each call.
"""
return self.part.notes_master
def save(self, file: str | IO[bytes]):
"""Writes this presentation to `file`.
`file` can be either a file-path or a file-like object open for writing bytes.
"""
self.part.save(file)
@property
def slide_height(self) -> Length | None:
"""Height of slides in this presentation, in English Metric Units (EMU).
Returns |None| if no slide width is defined. Read/write.
"""
sldSz = self._element.sldSz
if sldSz is None:
return None
return sldSz.cy
@slide_height.setter
def slide_height(self, height: Length):
sldSz = self._element.get_or_add_sldSz()
sldSz.cy = height
@property
def slide_layouts(self) -> SlideLayouts:
"""|SlideLayouts| collection belonging to the first |SlideMaster| of this presentation.
A presentation can have more than one slide master and each master will have its own set
of layouts. This property is a convenience for the common case where the presentation has
only a single slide master.
"""
return self.slide_masters[0].slide_layouts
@property
def slide_master(self):
"""
First |SlideMaster| object belonging to this presentation. Typically,
presentations have only a single slide master. This property provides
simpler access in that common case.
"""
return self.slide_masters[0]
@lazyproperty
def slide_masters(self) -> SlideMasters:
"""|SlideMasters| collection of slide-masters belonging to this presentation."""
return SlideMasters(self._element.get_or_add_sldMasterIdLst(), self)
@property
def slide_width(self):
"""
Width of slides in this presentation, in English Metric Units (EMU).
Returns |None| if no slide width is defined. Read/write.
"""
sldSz = self._element.sldSz
if sldSz is None:
return None
return sldSz.cx
@slide_width.setter
def slide_width(self, width: Length):
sldSz = self._element.get_or_add_sldSz()
sldSz.cx = width
@lazyproperty
def slides(self):
"""|Slides| object containing the slides in this presentation."""
sldIdLst = self._element.get_or_add_sldIdLst()
self.part.rename_slide_parts([cast("CT_SlideId", sldId).rId for sldId in sldIdLst])
return Slides(sldIdLst, self)
|
