pyexlatex.models.page package¶

Submodules¶

pyexlatex.models.page.footer module¶

class pyexlatex.models.page.footer.CenterFooter(contents)[source]¶

Bases: pyexlatex.models.item.SimpleItem

A center-aligned footer

__init__(contents)[source]¶

name = 'cfoot'¶

class pyexlatex.models.page.footer.FooterLine(size=0.4, units='pt')[source]¶

Bases: pyexlatex.models.commands.renewcommand.ReNewCommand

Add a horizontal line above the footer

__init__(size=0.4, units='pt')[source]¶

class pyexlatex.models.page.footer.LeftFooter(contents)[source]¶

Bases: pyexlatex.models.item.SimpleItem

A left-aligned footer

__init__(contents)[source]¶

name = 'lfoot'¶

class pyexlatex.models.page.footer.RightFooter(contents)[source]¶

Bases: pyexlatex.models.item.SimpleItem

A right-aligned footer

__init__(contents)[source]¶

name = 'rfoot'¶

pyexlatex.models.page.header module¶

class pyexlatex.models.page.header.CenterHeader(contents)[source]¶

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.SimpleItem

__init__(contents)[source]¶

name = 'chead'¶

class pyexlatex.models.page.header.FancyHeader(contents)[source]¶

Bases: pyexlatex.models.item.SimpleItem

__init__(contents)[source]¶

name = 'fancyhead'¶

class pyexlatex.models.page.header.Header(contents, align='right')[source]¶

Bases: pyexlatex.models.containeritem.ContainerItem, pyexlatex.models.item.ItemBase

Adds a header to a document, aligned to right, center, or left.

__init__(contents, align='right')[source]¶

Parameters

contents¶ –
align¶ (str) – one of ‘right’, ‘left’, ‘center’

class pyexlatex.models.page.header.LeftHeader(contents)[source]¶

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.SimpleItem

__init__(contents)[source]¶

name = 'lhead'¶

class pyexlatex.models.page.header.RightHeader(contents)[source]¶

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.SimpleItem

__init__(contents)[source]¶

name = 'rhead'¶

pyexlatex.models.page.number module¶

class pyexlatex.models.page.number.PageReference(contents)[source]¶

Bases: pyexlatex.models.item.SimpleItem

__init__(contents)[source]¶

name = 'pageref'¶

class pyexlatex.models.page.number.ThisPageNumber[source]¶

Bases: pyexlatex.models.item.NoOptionsNoContentsItem

Gets a reference to the current page number, can be included in headers and more.

__init__()[source]¶

name = 'thepage'¶

pyexlatex.models.page.style module¶

class pyexlatex.models.page.style.FancyPageStyle(contents, page_style='plain')[source]¶

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.MultiOptionSimpleItem

Redefines an existing page style such as plain but with fancy page style features.

__init__(contents, page_style='plain')[source]¶

name = 'fancypagestyle'¶

class pyexlatex.models.page.style.PageStyle(contents)[source]¶

Bases: pyexlatex.models.item.SimpleItem

Sets style of the pages for the entire document.

__init__(contents)[source]¶

name = 'pagestyle'¶

class pyexlatex.models.page.style.ThisPageStyle(contents)[source]¶

Bases: pyexlatex.models.item.SimpleItem

Sets style of the current page in a document.

__init__(contents)[source]¶

name = 'thispagestyle'¶