139 lines
4.6 KiB
Python
139 lines
4.6 KiB
Python
|
# encoding: utf-8
|
||
|
|
|
||
|
|
"""
|
||
|
|
Presentation part, the main part in a .pptx package.
|
||
|
|
"""
|
||
|
|
|
||
|
|
from __future__ import absolute_import
|
||
|
|
|
||
|
|
from ..opc.constants import RELATIONSHIP_TYPE as RT
|
||
|
|
from ..opc.package import XmlPart
|
||
|
|
from ..opc.packuri import PackURI
|
||
|
|
from ..presentation import Presentation
|
||
|
|
from .slide import NotesMasterPart, SlidePart
|
||
|
|
from ..util import lazyproperty
|
||
|
|
|
||
|
|
|
||
|
|
class PresentationPart(XmlPart):
|
||
|
|
"""
|
||
|
|
Top level class in object model, represents the contents of the /ppt
|
||
|
|
directory of a .pptx file.
|
||
|
|
"""
|
||
|
|
|
||
|
|
def add_slide(self, slide_layout):
|
||
|
|
"""
|
||
|
|
Return an (rId, slide) pair of a newly created blank slide that
|
||
|
|
inherits appearance from *slide_layout*.
|
||
|
|
"""
|
||
|
|
partname = self._next_slide_partname
|
||
|
|
slide_layout_part = slide_layout.part
|
||
|
|
slide_part = SlidePart.new(partname, self.package, slide_layout_part)
|
||
|
|
rId = self.relate_to(slide_part, RT.SLIDE)
|
||
|
|
return rId, slide_part.slide
|
||
|
|
|
||
|
|
@property
|
||
|
|
def core_properties(self):
|
||
|
|
"""
|
||
|
|
A |CoreProperties| object providing read/write access to the core
|
||
|
|
properties of this presentation.
|
||
|
|
"""
|
||
|
|
return self.package.core_properties
|
||
|
|
|
||
|
|
def get_slide(self, slide_id):
|
||
|
|
"""
|
||
|
|
Return the |Slide| object identified by *slide_id* (in this
|
||
|
|
presentation), or |None| if not found.
|
||
|
|
"""
|
||
|
|
for sldId in self._element.sldIdLst:
|
||
|
|
if sldId.id == slide_id:
|
||
|
|
return self.related_parts[sldId.rId].slide
|
||
|
|
return None
|
||
|
|
|
||
|
|
@lazyproperty
|
||
|
|
def notes_master(self):
|
||
|
|
"""
|
||
|
|
Return the |NotesMaster| object for this presentation. If the
|
||
|
|
presentation does not have a notes master, one is created from
|
||
|
|
a default template. The same single instance is returned on each
|
||
|
|
call.
|
||
|
|
"""
|
||
|
|
return self.notes_master_part.notes_master
|
||
|
|
|
||
|
|
@lazyproperty
|
||
|
|
def notes_master_part(self):
|
||
|
|
"""
|
||
|
|
Return the |NotesMasterPart| object for this presentation. If the
|
||
|
|
presentation does not have a notes master, one is created from
|
||
|
|
a default template. The same single instance is returned on each
|
||
|
|
call.
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
return self.part_related_by(RT.NOTES_MASTER)
|
||
|
|
except KeyError:
|
||
|
|
notes_master_part = NotesMasterPart.create_default(self.package)
|
||
|
|
self.relate_to(notes_master_part, RT.NOTES_MASTER)
|
||
|
|
return notes_master_part
|
||
|
|
|
||
|
|
@lazyproperty
|
||
|
|
def presentation(self):
|
||
|
|
"""
|
||
|
|
A |Presentation| object providing access to the content of this
|
||
|
|
presentation.
|
||
|
|
"""
|
||
|
|
return Presentation(self._element, self)
|
||
|
|
|
||
|
|
def related_slide(self, rId):
|
||
|
|
"""
|
||
|
|
Return the |Slide| object for the related |SlidePart| corresponding
|
||
|
|
to relationship key *rId*.
|
||
|
|
"""
|
||
|
|
return self.related_parts[rId].slide
|
||
|
|
|
||
|
|
def related_slide_master(self, rId):
|
||
|
|
"""
|
||
|
|
Return the |SlideMaster| object for the related |SlideMasterPart|
|
||
|
|
corresponding to relationship key *rId*.
|
||
|
|
"""
|
||
|
|
return self.related_parts[rId].slide_master
|
||
|
|
|
||
|
|
def rename_slide_parts(self, rIds):
|
||
|
|
"""
|
||
|
|
Assign incrementing partnames like ``/ppt/slides/slide9.xml`` to the
|
||
|
|
slide parts identified by *rIds*, in the order their id appears in
|
||
|
|
that sequence. The name portion is always ``slide``. The number part
|
||
|
|
forms a continuous sequence starting at 1 (e.g. 1, 2, ... 10, ...).
|
||
|
|
The extension is always ``.xml``.
|
||
|
|
"""
|
||
|
|
for idx, rId in enumerate(rIds):
|
||
|
|
slide_part = self.related_parts[rId]
|
||
|
|
slide_part.partname = PackURI("/ppt/slides/slide%d.xml" % (idx + 1))
|
||
|
|
|
||
|
|
def save(self, path_or_stream):
|
||
|
|
"""
|
||
|
|
Save this presentation package to *path_or_stream*, which can be
|
||
|
|
either a path to a filesystem location (a string) or a file-like
|
||
|
|
object.
|
||
|
|
"""
|
||
|
|
self.package.save(path_or_stream)
|
||
|
|
|
||
|
|
def slide_id(self, slide_part):
|
||
|
|
"""
|
||
|
|
Return the slide identifier associated with *slide_part* in this
|
||
|
|
presentation.
|
||
|
|
"""
|
||
|
|
for sldId in self._element.sldIdLst:
|
||
|
|
if self.related_parts[sldId.rId] is slide_part:
|
||
|
|
return sldId.id
|
||
|
|
raise ValueError("matching slide_part not found")
|
||
|
|
|
||
|
|
@property
|
||
|
|
def _next_slide_partname(self):
|
||
|
|
"""
|
||
|
|
Return |PackURI| instance containing the partname for a slide to be
|
||
|
|
appended to this slide collection, e.g. ``/ppt/slides/slide9.xml``
|
||
|
|
for a slide collection containing 8 slides.
|
||
|
|
"""
|
||
|
|
sldIdLst = self._element.get_or_add_sldIdLst()
|
||
|
|
partname_str = "/ppt/slides/slide%d.xml" % (len(sldIdLst) + 1)
|
||
|
|
return PackURI(partname_str)
|