o a]I?@sdZddlmZmZmZmZddlmZddlm Z ddl m Z ddl m Z Gddde ZGd d d eZGd d d eZGd ddeZGdddeZdS)z.The |Section| object and related proxy classes)absolute_importdivisionprint_functionunicode_literals)BlockItemContainer)Sequence)WD_HEADER_FOOTER) lazypropertycs8eZdZdZfddZddZddZdd ZZS) SectionszSequence of |Section| objects corresponding to the sections in the document. Supports ``len()``, iteration, and indexed access. ctt|||_||_dSN)superr __init__ _document_elm_document_part)selfZ document_elm document_part __class__s z(Sections.__getitem__..) isinstanceslicer sectPr_lstrr)rkeyrrr __getitem__s   zSections.__getitem__ccs"|jjD] }t||jVqdSr )rrrr)rrrrr__iter__ s zSections.__iter__cCs t|jjSr )lenrrrrrr__len__$s zSections.__len__) __name__ __module__ __qualname____doc__rr!r"r$ __classcell__rrrrr s  r cseZdZdZfddZeddZejddZeddZejd dZed d Z ed d Z eddZ eddZ e ddZeddZejddZeddZejddZe ddZeddZejddZedd Zejd!d Zed"d#Zejd$d#Zed%d&Zejd'd&Zed(d)Zejd*d)Zed+d,Zejd-d,Zed.d/Zejd0d/Zed1d2Zejd3d2ZZS)4rz}Document section, providing access to section and page setup settings. Also provides access to headers and footers. cr r )r rr_sectPrr)rrrrrrr.rzSection.__init__cC|jjS)z |Length| object representing the bottom margin for all pages in this section in English Metric Units. r* bottom_marginrrrrr-3zSection.bottom_margincC ||j_dSr r,rvaluerrrr-; cCr+)zTrue if this section displays a distinct first-page header and footer. Read/write. The definition of the first-page header and footer are accessed using :attr:`.first_page_header` and :attr:`.first_page_footer` respectively. r*Z titlePg_valrrrr"different_first_page_header_footer?z*Section.different_first_page_header_footercCr/r r3r0rrrr4Hr2cCt|j|jtjS)z|_Footer| object defining footer content for even pages. The content of this footer definition is ignored unless the document setting :attr:`~.Settings.odd_and_even_pages_header_footer` is set True. )_Footerr*rr EVEN_PAGErrrreven_page_footerLzSection.even_page_footercCr6)z|_Header| object defining header content for even pages. The content of this header definition is ignored unless the document setting :attr:`~.Settings.odd_and_even_pages_header_footer` is set True. )_Headerr*rrr8rrrreven_page_headerUr:zSection.even_page_headercCr6)z|_Footer| object defining footer content for the first page of this section. The content of this footer definition is ignored unless the property :attr:`.different_first_page_header_footer` is set True. )r7r*rr FIRST_PAGErrrrfirst_page_footer^r:zSection.first_page_footercCr6)z|_Header| object defining header content for the first page of this section. The content of this header definition is ignored unless the property :attr:`.different_first_page_header_footer` is set True. )r;r*rrr=rrrrfirst_page_headergr:zSection.first_page_headercCr6)z|_Footer| object representing default page footer for this section. The default footer is used for odd-numbered pages when separate odd/even footers are enabled. It is used for both odd and even-numbered pages otherwise. )r7r*rrPRIMARYrrrrfooterpr:zSection.footercCr+)z |Length| object representing the distance from the bottom edge of the page to the bottom edge of the footer. |None| if no setting is present in the XML. r*rArrrrfooter_distanceyr5zSection.footer_distancecCr/r rBr0rrrrCr2cCr+)z |Length| object representing the page gutter size in English Metric Units for all pages in this section. The page gutter is extra spacing added to the *inner* margin to ensure even margins after page binding. r*gutterrrrrrEzSection.guttercCr/r rDr0rrrrEr2cCr6)z|_Header| object representing default page header for this section. The default header is used for odd-numbered pages when separate odd/even headers are enabled. It is used for both odd and even-numbered pages otherwise. )r;r*rrr@rrrrheaderr:zSection.headercCr+)z |Length| object representing the distance from the top edge of the page to the top edge of the header. |None| if no setting is present in the XML. r*rGrrrrheader_distancer5zSection.header_distancecCr/r rHr0rrrrIr2cCr+)z} |Length| object representing the left margin for all pages in this section in English Metric Units. r* left_marginrrrrrKr.zSection.left_margincCr/r rJr0rrrrKr2cCr+)z Member of the :ref:`WdOrientation` enumeration specifying the page orientation for this section, one of ``WD_ORIENT.PORTRAIT`` or ``WD_ORIENT.LANDSCAPE``. r* orientationrrrrrMr5zSection.orientationcCr/r rLr0rrrrMr2cCr+)a" Total page height used for this section, inclusive of all edge spacing values such as margins. Page orientation is taken into account, so for example, its expected value would be ``Inches(8.5)`` for letter-sized paper when orientation is landscape. r* page_heightrrrrrOrFzSection.page_heightcCr/r rNr0rrrrOr2cCr+)a  Total page width used for this section, inclusive of all edge spacing values such as margins. Page orientation is taken into account, so for example, its expected value would be ``Inches(11)`` for letter-sized paper when orientation is landscape. r* page_widthrrrrrQrFzSection.page_widthcCr/r rPr0rrrrQr2cCr+)z~ |Length| object representing the right margin for all pages in this section in English Metric Units. r* right_marginrrrrrSr.zSection.right_margincCr/r rRr0rrrrSr2cCr+)z The member of the :ref:`WdSectionStart` enumeration corresponding to the initial break behavior of this section, e.g. ``WD_SECTION.ODD_PAGE`` if the section should begin on the next odd page. r* start_typerrrrrUrFzSection.start_typecCr/r rTr0rrrrUr2cCr+)z| |Length| object representing the top margin for all pages in this section in English Metric Units. r* top_marginrrrrrWr.zSection.top_margincCr/r rVr0rrrrWr2)r%r&r'r(rpropertyr-setterr4r9r<r>r?r rArCrErGrIrKrMrOrQrSrUrWr)rrrrr(s~                              rc@seZdZdZddZeddZejddZeddZd d Z ed d Z d dZ eddZ ddZ eddZeddZdS)_BaseHeaderFooterz(Base class for header and footer classescCs||_||_||_dSr )r*r _hdrftr_index)rrrZheader_footer_indexrrrr s z_BaseHeaderFooter.__init__cCs|j S)a``True`` if this header/footer uses the definition from the prior section. ``False`` if this header/footer has an explicit definition. Assigning ``True`` to this property removes the header/footer definition for this section, causing it to "inherit" the corresponding definition of the prior section. Assigning ``False`` causes a new, empty definition to be added for this section, but only if no definition is already present. )_has_definitionrrrris_linked_to_previouss z'_BaseHeaderFooter.is_linked_to_previouscCs6t|}||jkr dS|dur|dS|dS)NT)boolr]_drop_definition_add_definition)rr1Z new_staterrrr]s    cCs|S)zThe |HeaderPart| or |FooterPart| for this header/footer. This overrides `BlockItemContainer.part` and is required to support image insertion and perhaps other content like hyperlinks. )_get_or_add_definitionrrrrpart's z_BaseHeaderFooter.partcCtd)z&Return newly-added header/footer part.$must be implemented by each subclassNotImplementedErrorrrrrr`2z!_BaseHeaderFooter._add_definitioncCrc)zE|HeaderPart| or |FooterPart| object containing header/footer content.rdrerrrr _definition6z_BaseHeaderFooter._definitioncCrc)zJRemove header/footer part containing the definition of this header/footer.rdrerrrrr_;rgz"_BaseHeaderFooter._drop_definitioncCs |jS)z7`w:hdr` or `w:ftr` element, root of header/footer part.)raelementrrrr_element?s z_BaseHeaderFooter._elementcCs&|jr|jS|j}|r|S|S)aReturn HeaderPart or FooterPart object for this section. If this header/footer inherits its content, the part for the prior header/footer is returned; this process continue recursively until a definition is found. If the definition cannot be inherited (because the header/footer belongs to the first section), a new definition is added for that first section and then returned. )r\rh_prior_headerfooterrar`)rZprior_headerfooterrrrraDs  z(_BaseHeaderFooter._get_or_add_definitioncCrc)zHTrue if this header/footer has a related part containing its definition.rdrerrrrr\Xriz!_BaseHeaderFooter._has_definitioncCrc)zn|_Header| or |_Footer| proxy on prior sectPr element. Returns None if this is first section. rdrerrrrrl]r.z%_BaseHeaderFooter._prior_headerfooterN)r%r&r'r(rrXr]rYrbr`rhr_rkrar\rlrrrrrZs(       rZc@DeZdZdZddZeddZddZedd Zed d Z d S) r7aPage footer, used for all three types (default, even-page, and first-page). Note that, like a document or table cell, a footer must contain a minimum of one paragraph and a new or otherwise "empty" footer contains a single empty paragraph. This first paragraph can be accessed as `footer.paragraphs[0]` for purposes of adding content to it. Using :meth:`add_paragraph()` by itself to add content will leave an empty paragraph above the newly added one. cC"|j\}}|j|j||S)zReturn newly-added footer part.)rZadd_footer_partr*Zadd_footerReferencer[)r footer_partrIdrrrr`pz_Footer._add_definitioncC|j|j}|j|jS)z6|FooterPart| object containing content of this footer.)r*get_footerReferencer[rrorprZfooterReferencerrrrhvz_Footer._definitioncC|j|j}|j|dS)zDRemove footer definition (footer part) associated with this section.N)r*Zremove_footerReferencer[rZdrop_relrrprrrr_|z_Footer._drop_definitioncC|j|j}|dur dSdS)z-True if a footer is defined for this section.NFT)r*rsr[rtrrrr\z_Footer._has_definitioncC$|jj}|dur dSt||j|jS)zI|_Footer| proxy on prior sectPr element or None if this is first section.N)r*preceding_sectPrr7rr[rr|rrrrl z_Footer._prior_headerfooterN r%r&r'r(r`rXrhr_r\rlrrrrr7f   r7c@rm) r;aPage header, used for all three types (default, even-page, and first-page). Note that, like a document or table cell, a header must contain a minimum of one paragraph and a new or otherwise "empty" header contains a single empty paragraph. This first paragraph can be accessed as `header.paragraphs[0]` for purposes of adding content to it. Using :meth:`add_paragraph()` by itself to add content will leave an empty paragraph above the newly added one. cCrn)zReturn newly-added header part.)rZadd_header_partr*Zadd_headerReferencer[)r header_partrprrrr`rqz_Header._add_definitioncCrr)z6|HeaderPart| object containing content of this header.)r*get_headerReferencer[rrrprZheaderReferencerrrrhruz_Header._definitioncCrv)z6Remove header definition associated with this section.N)r*Zremove_headerReferencer[rZdrop_header_partrwrrrr_rxz_Header._drop_definitioncCry)z8True if a header is explicitly defined for this section.NFT)r*rr[rrrrr\rzz_Header._has_definitioncCr{)zI|_Header| proxy on prior sectPr element or None if this is first section.N)r*r|r;rr[r}rrrrlr~z_Header._prior_headerfooterNrrrrrr;rr;N)r(Z __future__rrrrZ docx.blkcntnrrZ docx.compatrZdocx.enum.sectionrZ docx.sharedr r objectrrZr7r;rrrrs    _`,