a ]jO@sTUdZddlmZddlmZddlmZmZmZm Z m Z ddl m Z ddl mZddlmZmZmZddlmZdd lmZdd lmZmZmZdd lmZdd lmZdd lm Z m!Z!m"Z"m#Z#m$Z$ddl%m&Z&m'Z'dZ(de)d<Gddde Z*Gddde Z+Gddde Z,Gddde Z-Gddde Z.Gddde Z/GdddZ0d S)!z'Section-related custom element classes.) annotations)deepcopy)CallableIteratorListSequencecast)etree) TypeAlias)WD_HEADER_FOOTERWD_ORIENTATIONWD_SECTION_START)nsmap)CT_OnOff)ST_SignedTwipsMeasureST_TwipsMeasure XsdString)CT_Tbl)CT_P)BaseOxmlElementOptionalAttributeRequiredAttribute ZeroOrMore ZeroOrOne)Length lazypropertyz CT_P | CT_Tblr BlockElementc@s\eZdZUdZded<ded<ded<ded <ed d d Zed d d ZeddddZ dS) CT_HdrFtrzN`w:hdr` and `w:ftr`, the root element for header and footer part respectively.zCallable[[], CT_P]Zadd_pz List[CT_P]Zp_lstz List[CT_Tbl]Ztbl_lstzCallable[[CT_Tbl], CT_Tbl]Z _insert_tblzw:p successorszw:tblzList[CT_P | CT_Tbl]returncCs |dS)zGenerate all `w:p` and `w:tbl` elements in this header or footer. Elements appear in document order. Elements shaded by nesting in a `w:ins` or other "wrapper" element will not be included. z./w:p | ./w:tbl)xpathselfrrM/var/www/html/assistant/venv/lib/python3.9/site-packages/docx/oxml/section.pyinner_content_elements)sz CT_HdrFtr.inner_content_elementsN) __name__ __module__ __qualname____doc____annotations__rpZtblpropertyr'rrrr&rs   rc@s6eZdZUdZedeZded<edeZ ded<dS) CT_HdrFtrRefz5`w:headerReference` and `w:footerReference` elements.w:typer type_zr:idstrrIdN) r(r)r*r+rr r1r,rr3rrrr&r/3s  r/c@seZdZUdZedeZded<edeZ ded<edeZ ded<ed eZ ded <ed eZ ded <ed eZ ded<edeZded<dS) CT_PageMarz-```` element, defining page margins.zw:top Length | Nonetopzw:rightrightzw:bottombottomzw:leftleftzw:headerheaderzw:footerfooterzw:guttergutterN)r(r)r*r+rrr6r,rr7r8r9r:r;r<rrrr&r4<s,       r4c@sNeZdZUdZedeZded<edeZded<ede e j dZ d ed <d S) CT_PageSzz?```` element, defining page dimensions and orientation.zw:wr5wzw:hhzw:orient)defaultr orientN) r(r)r*r+rrr>r,r?r PORTRAITrArrrr&r=Vs   r=c@s8eZdZUdZded<ded<ded<ded <d ed <d ed <d ed<d ed<dZededZededZe dedddZ ded<e dedddZ ded<e dedddZ ded <e d!ed"ddZ d#ed$<[d%d&d'd(d)d*Zd%d&d'd(d+d,Zed-d.d/d0Zejd1d2d3d0Zdd.d4d5Zed-d.d6d7Zejd1d2d8d7Zd%d9d:d;d<Zd%d9d:d=d>Zed-d.d?d@Zejd1d2dAd@Zed-d.dBdCZejd1d2dDdCZdEd.dFdGZed-d.dHdIZejd1d2dJdIZedKd.dLdMZejdNd2dOdMZed-d.dPdQZejd-d2dRdQZed-d.dSdTZejd-d2dUdTZedVd.dWdXZd%d&d:dYdZZd%d[d\d]Z ed-d.d^d_Z!e!jd-d2d`d_Z!edad.dbdcZ"e"jddd2dedcZ"edfd.dgdhZ#e#jdid2djdhZ#ed-d.dkdlZ$e$jd-d2dmdlZ$dS)n CT_SectPrzA`w:sectPr` element, the container element for section properties.zCallable[[], CT_PageMar]get_or_add_pgMarzCallable[[], CT_PageSz]get_or_add_pgSzzCallable[[], CT_OnOff]get_or_add_titlePgzCallable[[], CT_SectType]get_or_add_typezCallable[[], CT_HdrFtrRef]_add_footerReference_add_headerReferencezCallable[[], None]_remove_titlePg _remove_type)z w:footnotePrz w:endnotePrr0w:pgSzw:pgMarz w:paperSrcz w:pgBordersz w:lnNumTypez w:pgNumTypezw:colsz w:formProtzw:vAlignz w:noEndnote w:titlePgzw:textDirectionzw:bidiz w:rtlGutterz w:docGridzw:printerSettingszw:sectPrChangezw:headerReferencerzw:footerReferencer0NzCT_SectType | NonetyperLzCT_PageSz | NonepgSzrMzCT_PageMar | NonepgMarrNzCT_OnOff | NonetitlePgr r2r/)r1r3r"cCs|}||_||_|S)zxReturn newly added CT_HdrFtrRef element of `type_` with `rId`. The element tag is `w:footerReference`. )rHr1r3)r%r1r3footerReferencerrr&add_footerReferenceszCT_SectPr.add_footerReferencecCs|}||_||_|S)zxReturn newly added CT_HdrFtrRef element of `type_` with `rId`. The element tag is `w:headerReference`. )rIr1r3)r%r1r3headerReferencerrr&add_headerReferenceszCT_SectPr.add_headerReferencer5r!cCs|j}|durdS|jS)zValue of the `w:bottom` attr of `` child element, as |Length|. |None| when either the element or the attribute is not present. N)rTr8r%rTrrr& bottom_marginszCT_SectPr.bottom_marginzint | Length | None)valuecCs,|}|dust|tr|nt||_dSN)rD isinstancerr8r%r]rTrrr&r\scCst|}|j|S)zReturn an exact duplicate of this ```` element tree suitable for use in adding a section break. All rsid* attributes are removed from the root ```` element. )rZattribclear)r%Z cloned_sectPrrrr&clones zCT_SectPr.clonecCs|j}|durdS|jS)aDistance from bottom edge of page to bottom edge of the footer. This is the value of the `w:footer` attribute in the `w:pgMar` child element, as a |Length| object, or |None| if either the element or the attribute is not present. N)rTr;r[rrr&r;szCT_SectPr.footercCs,|}|dust|tr|nt||_dSr^)rDr_rr;r`rrr&r;szCT_HdrFtrRef | None)r1r"cCs(dt|}||}|s dS|dS)zAReturn footerReference element of `type_` or None if not present.z!./w:footerReference[@w:type='%s']Nr)r to_xmlr#)r%r1pathZfooterReferencesrrr&get_footerReferences  zCT_SectPr.get_footerReferencecCs,|dt|}t|dkr$dS|dS)zAReturn headerReference element of `type_` or None if not present.z!./w:headerReference[@w:type='%s']rN)r#r rclen)r%r1Zmatching_headerReferencesrrr&get_headerReferences   zCT_SectPr.get_headerReferencecCs|j}|durdS|jS)zThe value of the ``w:gutter`` attribute in the ```` child element, as a |Length| object, or |None| if either the element or the attribute is not present.N)rTr<r[rrr&r<szCT_SectPr.guttercCs,|}|dust|tr|nt||_dSr^)rDr_rr<r`rrr&r<scCs|j}|durdS|jS)zDistance from top edge of page to top edge of header. This value comes from the `w:header` attribute on the `w:pgMar` child element. |None| if either the element or the attribute is not present. N)rTr:r[rrr&r:szCT_SectPr.headercCs,|}|dust|tr|nt||_dSr^)rDr_rr:r`rrr&r:szIterator[CT_P | CT_Tbl]cCs t|S)zGenerate all `w:p` and `w:tbl` elements in this section. Elements appear in document order. Elements shaded by nesting in a `w:ins` or other "wrapper" element will not be included. )_SectBlockElementIteratoriter_sect_block_elementsr$rrr&iter_inner_contentszCT_SectPr.iter_inner_contentcCs|j}|durdS|jS)zThe value of the ``w:left`` attribute in the ```` child element, as a |Length| object, or |None| if either the element or the attribute is not present.N)rTr9r[rrr& left_marginszCT_SectPr.left_margincCs,|}|dust|tr|nt||_dSr^)rDr_rr9r`rrr&rksr cCs|j}|durtjS|jS)z`WD_ORIENTATION` member indicating page-orientation for this section. This is the value of the `orient` attribute on the `w:pgSz` child, or `WD_ORIENTATION.PORTRAIT` if not present. N)rRr rBrAr%rRrrr& orientationszCT_SectPr.orientationzWD_ORIENTATION | NonecCs|}|r|ntj|_dSr^)rEr rBrAr%r]rRrrr&rm*scCs|j}|durdS|jS)ziValue in EMU of the `h` attribute of the `w:pgSz` child element. |None| if not present. N)rRr?rlrrr& page_height/szCT_SectPr.page_heightcCs|}||_dSr^)rEr?rnrrr&ro:scCs|j}|durdS|jS)zoValue in EMU of the ``w`` attribute of the ```` child element. |None| if not present. N)rRr>rlrrr& page_width?szCT_SectPr.page_widthcCs|}||_dSr^)rEr>rnrrr&rpJszCT_SectPr | NonecCs"|d}t|dkr|dSdS)zCSectPr immediately preceding this one or None if this is the first.z./preceding::w:sectPr[1]rN)r#rf)r%Zpreceding_sectPrsrrr&preceding_sectPrOs zCT_SectPr.preceding_sectPrcCs.||}|durtd|j}|||S)zCReturn rId of w:footerReference child of `type_` after removing it.Nz!CT_SectPr has no footer reference)re ValueErrorr3remove)r%r1rWr3rrr&remove_footerReferenceVs   z CT_SectPr.remove_footerReference)r1cCs.||}|durtd|j}|||S)zCReturn rId of w:headerReference child of `type_` after removing it.Nz!CT_SectPr has no header reference)rgrrr3rs)r%r1rYr3rrr&remove_headerReference`s   z CT_SectPr.remove_headerReferencecCs|j}|durdS|jS)zThe value of the ``w:right`` attribute in the ```` child element, as a |Length| object, or |None| if either the element or the attribute is not present.N)rTr7r[rrr& right_marginjszCT_SectPr.right_margincCs|}||_dSr^)rDr7r`rrr&rvtsr cCs$|j}|dus|jdurtjS|jS)zThe member of the ``WD_SECTION_START`` enumeration corresponding to the value of the ``val`` attribute of the ```` child element, or ``WD_SECTION_START.NEW_PAGE`` if not present.N)rPvalr NEW_PAGE)r%rPrrr& start_typeyszCT_SectPr.start_typeWD_SECTION_START | NonecCs0|dus|tjur|dS|}||_dSr^)r rxrKrGrw)r%r]rPrrr&rys boolcCs|j}|durdS|jS)zEValue of `w:titlePg/@val` or |False| if `./w:titlePg` is not present.NF)rVrw)r%rVrrr& titlePg_valszCT_SectPr.titlePg_valz bool | NonecCs |dvr|n d|_dS)N)NFT)rJrFrw)r%r]rrr&r|s cCs|j}|durdS|jS)zThe value of the ``w:top`` attribute in the ```` child element, as a |Length| object, or |None| if either the element or the attribute is not present.N)rTr6r[rrr& top_marginszCT_SectPr.top_margincCs|}||_dSr^)rDr6r`rrr&r}s)%r(r)r*r+r,Z_tag_seqrrYrWrrPrRrTrVrXrZr.r\setterrbr;rergr<r:rjrkrmrorprqrtrurvryr|r}rrrr&rCds                        rCc@s$eZdZUdZedeZded<dS) CT_SectTypez:```` element, defining the section start type.zw:valrzrwN)r(r)r*r+rr rwr,rrrr&rs rc@seZdZUdZdZded<dZded<dddd Zedd d d d Z d dddZ ddd ddZ e ddddZ ddd ddZe ddddZdS)rhzGenerates the block-item XML elements in a section. A block-item element is a `CT_P` (paragraph) or a `CT_Tbl` (table). Nzetree.XPath | None_compiled_blocks_xpath_compiled_count_xpathrC)sectPrcCs ||_dSr^)_sectPr)r%rrrr&__init__sz"_SectBlockElementIterator.__init__zIterator[BlockElement])rr"cCs ||S)zIGenerate each CT_P or CT_Tbl element within extents governed by `sectPr`.)_iter_sect_block_elements)clsrrrr&risz2_SectBlockElementIterator.iter_sect_block_elementsr!ccsX|j|j}}||}|dkr$dn|||d}|||dD] }|VqHdS)z0Generate each CT_P or CT_Tbl element in section.rN)r_sectPrsindex%_count_of_blocks_in_and_above_section_blocks_in_and_above_section)r%rZsectPrsZ sectPr_idxZn_blks_to_skipelementrrr&rs  z3_SectBlockElementIterator._iter_sect_block_elementszSequence[BlockElement]cCs6|jdurtj|jtdd|_|j}ttt||S)FAll ps and tbls in section defined by `sectPr` and all prior sections.NF namespacesregexp)rr XPath"_blocks_in_and_above_section_xpathrrrrr%rr#rrr&rs z6_SectBlockElementIterator._blocks_in_and_above_sectionr2c Cs,d}d}d}|d|d|d|d| S)zHXPath expr for ps and tbls in context of a sectPr and all prior sectPrs.z./parent::w:pPr/parent::w:pzself::w:sectPr[parent::w:body]z-preceding-sibling::*[self::w:p | self::w:tbl]z | /r)r%Zp_sect_term_blockZbody_sect_termZpred_ps_and_tblsrrr&rs z<_SectBlockElementIterator._blocks_in_and_above_section_xpathintcCs>|jdur&tjd|jdtdd|_|j}ttt||S)rNzcount()Fr)rr rrrrrfloatrrrr&rs  z?_SectBlockElementIterator._count_of_blocks_in_and_above_sectionzSequence[CT_SectPr]cCs |jdS)z5All w:sectPr elements in document, in document-order.zC/w:document/w:body/w:p/w:pPr/w:sectPr | /w:document/w:body/w:sectPr)rr#r$rrr&rsz"_SectBlockElementIterator._sectPrs)r(r)r*r+rr,rr classmethodrirrrrrrrrrr&rhs     rhN)1r+ __future__rcopyrtypingrrrrrZlxmlr Ztyping_extensionsr Zdocx.enum.sectionr r r Z docx.oxml.nsrZdocx.oxml.sharedrZdocx.oxml.simpletypesrrrZdocx.oxml.tablerZdocx.oxml.text.paragraphrZdocx.oxml.xmlchemyrrrrrZ docx.sharedrrrr,rr/r4r=rCrrhrrrr&s.          H