Paper Office
paper-pptxAPI referencehf

pptx.hf

paper-pptx 0.2.0 API reference

Footer, date, and slide-number application machinery (paper-pptx addition).

Reproduces what PowerPoint's Insert > Header & Footer dialog actually persists: the dialog materializes minimal placeholder p:sp shapes on each slide - dt/ftr/sldNum, with idx matching the slide layout's furniture so geometry and formatting inherit; slide-number and auto-date content are real a:fld elements; footer text and fixed dates are literal runs; p:hf flags are left untouched (the dialog leaves them absent, and absent means all-visible).

This package AUTHORS fields; it never computes their live values. An a:fld's cached a:t text is a consumer-refreshed hint - PowerPoint and LibreOffice rewrite it on open (proven by the lo_footers_applied fixture round-trip) - so the cache seeded here (slide position for slidenum, an injectable-clock rendering for datetime*) is never something the package vouches for at render time.

DATETIME_FIELD_FORMATS

attributeDATETIME_FIELD_FORMATS'Dict[str, str]'
= {'datetime': '%m/%d/%Y', 'datetime1': '%m/%d/%Y', 'datetime2': '%A, %B %d, %Y', 'datetime3': '%d %B %Y', 'datetime4': '%B %d, %Y', 'datetime5': '%d-%b-%y', 'datetime6': '%B %y', 'datetime7': '%b-%y', 'datetime8': '%m/%d/%Y %I:%M %p', 'datetime9': '%m/%d/%Y %I:%M:%S %p', 'datetime10': '%H:%M', 'datetime11': '%H:%M:%S', 'datetime12': '%I:%M %p', 'datetime13': '%I:%M:%S %p'}

apply_presentation_footers

funcapply_presentation_footers(prs: 'Presentation', *, footer: 'Optional[str]' = None, slide_number: bool = False, date_format: 'Optional[str]' = None, fixed_date: 'Optional[str]' = None, skip_title_slides: bool = False, now: 'Optional[datetime]' = None) -> None

Apply the complete footer state to every slide (the dialog's "Apply to All").

paramprs'Presentation'
paramfooter'Optional[str]'
= None
paramslide_numberbool
= False
paramdate_format'Optional[str]'
= None
paramfixed_date'Optional[str]'
= None
paramskip_title_slidesbool
= False
paramnow'Optional[datetime]'
= None

Returns

None

apply_slide_footers

funcapply_slide_footers(slide: 'Slide', *, footer: 'Optional[str]' = None, slide_number: bool = False, date_format: 'Optional[str]' = None, fixed_date: 'Optional[str]' = None, now: 'Optional[datetime]' = None) -> None

Apply the complete footer state to one slide (the dialog's per-slide "Apply").

paramslide'Slide'
paramfooter'Optional[str]'
= None
paramslide_numberbool
= False
paramdate_format'Optional[str]'
= None
paramfixed_date'Optional[str]'
= None
paramnow'Optional[datetime]'
= None

Returns

None

On this page