o 'fP@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@sXeZdZUdZded<ded<ded<ded <ed d d Zed d d ZedddZ dS) CT_HdrFtrzN`w:hdr` and `w:ftr`, the root element for header and footer part respectively.zCallable[[], CT_P]add_pz List[CT_P]p_lstz List[CT_Tbl]tbl_lstzCallable[[CT_Tbl], CT_Tbl] _insert_tblzw:p successorszw:tblreturnList[CT_P | CT_Tbl]cCs |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)xpathselfr"r"I/home/ubuntu/flask/venv/lib/python3.10/site-packages/docx/oxml/section.pyinner_content_elements)s z CT_HdrFtr.inner_content_elementsN)r%r&) __name__ __module__ __qualname____doc____annotations__rptblpropertyr+r"r"r"r*rs   rc@s6eZdZUdZedeZded<edeZ ded<dS) CT_HdrFtrRefz5`w:headerReference` and `w:footerReference` elements.w:typer type_zr:idstrrIdN) r,r-r.r/rr r6r0rr8r"r"r"r*r43s  r4c@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/rrr;r0rr<r=r>r?r@rAr"r"r"r*r9@s.       r9c@sNeZdZUdZedeZded<edeZded<ede e j dZ d ed <d S) CT_PageSzz?```` element, defining page dimensions and orientation.zw:wr:wzw:hhzw:orient)defaultr orientN) r,r-r.r/rrrCr0rDr PORTRAITrFr"r"r"r*rBZs   rBc@seZdZUdZded<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$<[dmd+d,Zdmd-d.Zednd0d1Zejdod4d1Zdpd5d6Zednd7d8Zejdod9d8Zdqd;d<Zdqd=d>Zednd?d@ZejdodAd@ZedndBdCZejdodDdCZdrdFdGZedndHdIZejdodJdIZedsdLdMZejdtdOdMZedndPdQZejdudRdQZedndSdTZejdudUdTZedvdWdXZdwdYdZZdxd[d\Z ednd]d^Z!e!jdud_d^Z!edydadbZ"e"jdzdddbZ"ed{dfdgZ#e#jd|didgZ#edndjdkZ$e$jdudldkZ$dS)} 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:endnotePrr5w: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:headerReferencer#zw:footerReferencer5NzCT_SectType | NonetyperQzCT_PageSz | NonepgSzrRzCT_PageMar | NonepgMarrSzCT_OnOff | NonetitlePgr6r r8r7r%r4cC|}||_||_|S)zxReturn newly added CT_HdrFtrRef element of `type_` with `rId`. The element tag is `w:footerReference`. )rMr6r8)r)r6r8footerReferencer"r"r*add_footerReferencezCT_SectPr.add_footerReferencecCr\)zxReturn newly added CT_HdrFtrRef element of `type_` with `rId`. The element tag is `w:headerReference`. )rNr6r8)r)r6r8headerReferencer"r"r*add_headerReferencer_zCT_SectPr.add_headerReferencer:cC|j}|dur dS|jS)zValue of the `w:bottom` attr of `` child element, as |Length|. |None| when either the element or the attribute is not present. N)rYr=r)rYr"r"r* bottom_marginzCT_SectPr.bottom_marginvalueint | Length | NonecC2|}|dus t|tr||_dSt||_dSN)rI isinstancerr=r)rfrYr"r"r*rd cCst|}|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. )rattribclear)r) cloned_sectPrr"r"r*clones zCT_SectPr.clonecCrb)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)rYr@rcr"r"r*r@szCT_SectPr.footercCrhri)rIrjrr@rkr"r"r*r@rlCT_HdrFtrRef | NonecCs(dt|}||}|sdS|dS)zAReturn footerReference element of `type_` or None if not present.z!./w:footerReference[@w:type='%s']Nr)r to_xmlr')r)r6pathfooterReferencesr"r"r*get_footerReferences  zCT_SectPr.get_footerReferencecCs,|dt|}t|dkrdS|dS)zAReturn headerReference element of `type_` or None if not present.z!./w:headerReference[@w:type='%s']rN)r'r rrlen)r)r6matching_headerReferencesr"r"r*get_headerReferences   zCT_SectPr.get_headerReferencecCrb)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)rYrArcr"r"r*rAzCT_SectPr.guttercCrhri)rIrjrrArkr"r"r*rArlcCrb)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)rYr?rcr"r"r*r?szCT_SectPr.headercCrhri)rIrjrr?rkr"r"r*r?rlIterator[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(r"r"r*iter_inner_contents zCT_SectPr.iter_inner_contentcCrb)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)rYr>rcr"r"r* left_marginryzCT_SectPr.left_margincCrhri)rIrjrr>rkr"r"r*r~'rlr cCs|j}|dur tjS|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)rWr rGrFr)rWr"r"r* orientation.szCT_SectPr.orientationWD_ORIENTATION | NonecCs"|}|r ||_dStj|_dSri)rJr rGrFr)rfrWr"r"r*r:scCrb)ziValue in EMU of the `h` attribute of the `w:pgSz` child element. |None| if not present. N)rWrDrr"r"r* page_height?rezCT_SectPr.page_heightcC|}||_dSri)rJrDrr"r"r*rJ cCrb)zoValue in EMU of the ``w`` attribute of the ```` child element. |None| if not present. N)rWrCrr"r"r* page_widthOrezCT_SectPr.page_widthcCrri)rJrCrr"r"r*rZrCT_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'rv)r)preceding_sectPrsr"r"r*preceding_sectPr_s zCT_SectPr.preceding_sectPrcC.||}|dur td|j}|||S)zCReturn rId of w:footerReference child of `type_` after removing it.Nz!CT_SectPr has no footer reference)ru ValueErrorr8remove)r)r6r]r8r"r"r*remove_footerReferencef  z CT_SectPr.remove_footerReferencecCr)zCReturn rId of w:headerReference child of `type_` after removing it.Nz!CT_SectPr has no header reference)rxrr8r)r)r6r`r8r"r"r*remove_headerReferenceprz CT_SectPr.remove_headerReferencecCrb)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)rYr<rcr"r"r* right_marginzryzCT_SectPr.right_margincCrri)rIr<rkr"r"r*rrr 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)rUvalr NEW_PAGE)r)rUr"r"r* start_typeszCT_SectPr.start_typeWD_SECTION_START | NonecCs0|dus |tjur|dS|}||_dSri)r rrPrLr)r)rfrUr"r"r*rs  boolcCs|j}|dur dS|jS)zEValue of `w:titlePg/@val` or |False| if `./w:titlePg` is not present.NF)r[r)r)r[r"r"r* titlePg_valszCT_SectPr.titlePg_val bool | NonecCs"|dvr |dSd|_dS)N)NFT)rOrKr)r)rfr"r"r*rs cCrb)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)rYr;rcr"r"r* top_marginryzCT_SectPr.top_margincCrri)rIr;rkr"r"r*rr)r6r r8r7r%r4)r%r:)rfrg)r%rH)r6r r%rq)r%rz)r%r )rfr)rfr:)r%r)r6r r%r7)r6r )r%r )rfr)r%r)rfr)%r,r-r.r/r0_tag_seqrr`r]rrUrWrYr[r^rar3rdsetterrpr@rurxrAr?r}r~rrrrrrrrrrr"r"r"r*rHjs                                        rHc@s$eZdZUdZedeZded<dS) CT_SectTypez:```` element, defining the section start type.zw:valrrN)r,r-r.r/rr rr0r"r"r"r*rs rc@s|eZdZUdZdZded<dZded<ddd Zedd d Z dddZ dddZ e d ddZ d!ddZe d"ddZdS)#r{zGenerates 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_xpathsectPrrHcCs ||_dSri)_sectPr)r)rr"r"r*__init__s z"_SectBlockElementIterator.__init__r%Iterator[BlockElement]cCs ||S)zIGenerate each CT_P or CT_Tbl element within extents governed by `sectPr`.)_iter_sect_block_elements)clsrr"r"r*r|s z2_SectBlockElementIterator.iter_sect_block_elementsccsZ|j|j}}||}|dkrdn|||d}|||dD]}|Vq%dS)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)rsectPrs sectPr_idxn_blks_to_skipelementr"r"r*rs z3_SectBlockElementIterator._iter_sect_block_elementsSequence[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'r"r"r*rs z6_SectBlockElementIterator._blocks_in_and_above_sectionr7c 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)p_sect_term_blockbody_sect_termpred_ps_and_tblsr"r"r*rs z<_SectBlockElementIterator._blocks_in_and_above_section_xpathintcCs>|jdurtjd|jdtdd|_|j}ttt||S)rNzcount()Fr)rr rrrrrfloatrr"r"r*rs  z?_SectBlockElementIterator._count_of_blocks_in_and_above_sectionSequence[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(r"r"r*r$sz"_SectBlockElementIterator._sectPrs)rrH)rrHr%r)r%r)rrHr%r)r%r7)rrHr%r)r%r)r,r-r.r/rr0rr classmethodr|rrrrrrr"r"r"r*r{s          r{N)1r/ __future__rcopyrtypingrrrrrlxmlr typing_extensionsr docx.enum.sectionr r r docx.oxml.nsrdocx.oxml.sharedrdocx.oxml.simpletypesrrrdocx.oxml.tablerdocx.oxml.text.paragraphrdocx.oxml.xmlchemyrrrrr docx.sharedrrrr0rr4r9rBrHrr{r"r"r"r*s0          R