hGTSrSSKJr SSKJrJrJrJrJr SSK J r SSK J r SSK Jr SSKJrJr SSKJr SS KJr SS KJr \(a&SS K JrJr SS KJr SS KJr SSKJr SSK J!r! SSKJ"r" "SS5r#"SS\\#5r$"SS\ 5r%"SS\%5r&"SS\%5r'g)z/The |Section| object and related proxy classes.) annotations) TYPE_CHECKINGIteratorListSequenceoverload)BlockItemContainer)WD_HEADER_FOOTER)CT_P) FooterPart HeaderPart) lazyproperty)Table) Paragraph)WD_ORIENTATIONWD_SECTION_START) CT_Document) CT_SectPr) DocumentPart) StoryPart)Lengthc^\rSrSrSrS%U4Sjjr\S&Sj5r\RS'Sj5r\S(Sj5r \ RS)Sj5r \S*Sj5r \S+S j5r \S*S j5r \S+S j5r \S*S j5r\S&S j5r\RS'Sj5r\S&Sj5r\RS'Sj5r\S+Sj5r\S&Sj5r\RS'Sj5rS,Sjr\S&Sj5r\RS'Sj5r\S-Sj5r\RS.Sj5r\S&Sj5r\RS/Sj5r\S&Sj5r\RS/Sj5r\S0Sj5r\S&Sj5r\RS/Sj5r\S1S j5r\RS2S!j5r\S&S"j5r\RS/S#j5rS$rU=r$)3SectionzuDocument section, providing access to section and page setup settings. Also provides access to headers and footers. cB>[[U] 5 XlX lgN)superr__init___sectPr_document_part)selfsectPr document_part __class__s >/var/www/html/env/lib/python3.13/site-packages/docx/section.pyrSection.__init__s gt%' +c.URR$)zRead/write. Bottom margin for pages in this section, in EMU. `None` when no bottom margin has been specified. Assigning |None| removes any bottom-margin setting. r bottom_marginr!s r%r*Section.bottom_margin#s||)))r'c$XRlgrr)r!values r%r*r,,s %* "r'c.URR$)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 titlePg_valr+s r%"different_first_page_header_footer*Section.different_first_page_header_footer0s||'''r'c$XRlgrr1r.s r%r3r49 #(  r'c`[URUR[R5$)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. )_Footerrr r EVEN_PAGEr+s r%even_page_footerSection.even_page_footer=$t||T%8%8:J:T:TUUr'c`[URUR[R5$)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. )_Headerrr r r9r+s r%even_page_headerSection.even_page_headerFr<r'c`[URUR[R5$)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. )r8rr r FIRST_PAGEr+s r%first_page_footerSection.first_page_footerO$t||T%8%8:J:U:UVVr'c`[URUR[R5$)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>rr r rBr+s r%first_page_headerSection.first_page_headerXrEr'c`[URUR[R5$)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. )r8rr r PRIMARYr+s r%footerSection.footera$t||T%8%8:J:R:RSSr'c.URR$)zyDistance from bottom edge of page to bottom edge of the footer. Read/write. |None| if no setting is present in the XML. rrKr+s r%footer_distanceSection.footer_distancejs ||"""r'c$XRlgrrOr.s r%rPrQr # r'c.URR$)aA|Length| object representing page gutter size in English Metric Units. Read/write. The page gutter is extra spacing added to the `inner` margin to ensure even margins after page binding. Generally only used in book-bound documents with double-sided and facing pages. This setting applies to all pages in this section. rgutterr+s r%rVSection.guttervs||"""r'c$XRlgrrUr.s r%rVrWrSr'c`[URUR[R5$)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>rr r rJr+s r%headerSection.headerrMr'c.URR$)zDistance from top edge of page to top edge of header. Read/write. |None| if no setting is present in the XML. Assigning |None| causes default value to be used. rrZr+s r%header_distanceSection.header_distances||"""r'c$XRlgrr]r.s r%r^r_rSr'c## URR5H0n[U[5(a [ X5O [ X5v M2 g7f)z\Generate each Paragraph or Table object in this `section`. Items appear in document order. N)riter_inner_content isinstancer rr)r!elements r%rbSection.iter_inner_contents= ||668G/9'4/H/H9W+eT[Nb c9sAAc.URR$)zc|Length| object representing the left margin for all pages in this section in English Metric Units.r left_marginr+s r%rhSection.left_margins||'''r'c$XRlgrrgr.s r%rhrir6r'c.URR$)z:ref:`WdOrientation` member specifying page orientation for this section. One of ``WD_ORIENT.PORTRAIT`` or ``WD_ORIENT.LANDSCAPE``. r orientationr+s r%rmSection.orientations ||'''r'c$XRlgrrlr.s r%rmrnr6r'c.URR$)a Total page height used for this section. This value is 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_heightr+s r%rrSection.page_heights||'''r'c$XRlgrrqr.s r%rrrsr6r'c.URR$)aTotal page width used for this section. This value is like "paper size" and includes 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_widthr+s r%rwSection.page_widths||&&&r'c$XRlgrrvr.s r%rwrx "' r'cUR$r)r r+s r%part Section.parts"""r'c.URR$)zd|Length| object representing the right margin for all pages in this section in English Metric Units.r right_marginr+s r%rSection.right_margins||(((r'c$XRlgrrr.s r%rrs $) !r'c.URR$)zType of page-break (if any) inserted at the start of this section. For exmple, ``WD_SECTION_START.ODD_PAGE`` if the section should begin on the next odd page, possibly inserting two page-breaks instead of one. r start_typer+s r%rSection.start_types||&&&r'c$XRlgrrr.s r%rrrzr'c.URR$)zb|Length| object representing the top margin for all pages in this section in English Metric Units.r top_marginr+s r%rSection.top_margins||&&&r'c$XRlgrrr.s r%rrrzr')r r)r"rr#r)return Length | None)r/zint | Length | Nonerbool)r/r)rr8)rr>)rzIterator[Paragraph | Table])rr)r/zWD_ORIENTATION | None)r/r)rr)rr)r/zWD_SECTION_START | None)__name__ __module__ __qualname____firstlineno____doc__rpropertyr*setterr3r:r?rCrGrrKrPrVrZr^rbrhrmrrrwr|rrr__static_attributes__ __classcell__r$s@r%rrs , **++(((..)/)VVVVWWWWTT##$$ # # ]]$$TT##$$d(( ))(())(()) ' '((##)) **''(('' ((r'rcv^\rSrSrSrS U4Sjjr\S Sj5r\S Sj5rS SjrSSjrSSjr S r U=r $)SectionszSequence of |Section| objects corresponding to the sections in the document. Supports ``len()``, iteration, and indexed access. cB>[[U] 5 XlX lgr)rrr _document_elmr )r! document_elmr#r$s r%rSections.__init__s h&()+r'cgrr!keys r% __getitem__Sections.__getitem__ s03r'cgrrrs r%rrs8;r'c [U[5(a=URRUVs/sHn[ X R 5PM sn$[ URRUUR 5$s snfr)rcslicer sectPr_lstrr )r!rr"s r%rrsx c5 ! !#00;;C@@F 3 34@ t))44S94;N;NOO sBc#t# URRHn[XR5v M g7fr)rrrr )r!r"s r%__iter__Sections.__iter__s,((33F&"5"56 64s68c@[URR5$r)lenrrr+s r%__len__Sections.__len__s4%%0011r')rr )rrr#r)rintrr)rrrz List[Section])rz int | slicerzSection | List[Section])rzIterator[Section])rr) rrrrrrrrrrrrrs@r%rrs@ , 33 ;;P722r'rc\rSrSrSrSSjr\SSj5r\RSSj5r\SSj5r SSjr \SSj5r SS jr \S 5r SS jr\SS j5r\SS j5rSrg)_BaseHeaderFooteri!z)Base class for header and footer classes.c(XlX lX0lgr)rr _hdrftr_index)r!r"r#header_footer_indexs r%r_BaseHeaderFooter.__init__$s  +0r'c$UR(+$)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_definitionr+s r%is_linked_to_previous'_BaseHeaderFooter.is_linked_to_previous.s''''r'c[U5nX R:XagUSLaUR5 gUR5 g)NT)rr_drop_definition_add_definition)r!r/ new_states r%rr<s:K 22 2     ! ! #  "r'c"UR5$)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_definitionr+s r%r|_BaseHeaderFooter.partGs**,,r'c[S5e)z&Return newly-added header/footer part.$must be implemented by each subclassNotImplementedErrorr+s r%r!_BaseHeaderFooter._add_definitionR!"HIIr'c[S5e)zE|HeaderPart| or |FooterPart| object containing header/footer content.rrr+s r% _definition_BaseHeaderFooter._definitionV""HIIr'c[S5e)zJRemove header/footer part containing the definition of this header/footer.rrr+s r%r"_BaseHeaderFooter._drop_definition[rr'c6UR5R$)z7`w:hdr` or `w:ftr` element, root of header/footer part.)rrdr+s r%_element_BaseHeaderFooter._element_s**,444r'cUR(a UR$URnU(aUR5$UR 5$)a{Return 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. )rr_prior_headerfooterrr)r!prior_headerfooters r%r(_BaseHeaderFooter._get_or_add_definitiondsF   ## #!55 %<<> >##%%r'c[S5e)zHTrue if this header/footer has a related part containing its definition.rrr+s r%r!_BaseHeaderFooter._has_definitionxrr'c[S5e)z^|_Header| or |_Footer| proxy on prior sectPr element. Returns None if this is first section. rrr+s r%r%_BaseHeaderFooter._prior_headerfooter}s ""HIIr')r rrN)r"rr#rrr r)r/rrNone)rzHeaderPart | FooterPart)rr)rz_Header | _Footer | None)rrrrrrrrrr|rrrrrrrrrr'r%rr!s311$1. 1 ( (!!#"#--JJJJ55&(JJJJr'rc\\rSrSrSrS Sjr\S5rSr\S Sj5r \S5r Sr g ) r8iaPage 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. cURR5upURRURU5 U$)zReturn newly-added footer part.)r add_footer_partradd_footerReferencer)r! footer_partrIds r%r_Footer._add_definition9..>>@  ((););SAr'cURRUR5nUceURR UR 5$)z6|FooterPart| object containing content of this footer.)rget_footerReferencerr rrr!footerReferences r%r_Footer._definitionG,,::4;M;MN***""../B/BCCr'cURRUR5nURR U5 g)zDRemove footer definition (footer part) associated with this section.N)rremove_footerReferencerr drop_relr!rs r%r_Footer._drop_definitions0ll11$2D2DE $$S)r'cTURRUR5nUSL$)z-True if a footer is defined for this section.N)rrrrs r%r_Footer._has_definition),,::4;M;MNd**r'cxURRnUcS$[XRUR5$)zI|_Footer| proxy on prior sectPr element or None if this is first section.N)rpreceding_sectPrr8r rr!rs r%r_Footer._prior_headerfooterD <<88 '  )+>+>@R@RS r'rN)rr r rrrrrrrrrrrrrr'r%r8r8sO DD* ++   r'r8cX\rSrSrSrSr\S5rSr\S Sj5r \S5r Sr g ) r>iaPage 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. cURR5upURRURU5 U$)zReturn newly-added header part.)r add_header_partradd_headerReferencer)r! header_partrs r%r_Header._add_definitionrr'cURRUR5nUceURR UR 5$)z6|HeaderPart| object containing content of this header.)rget_headerReferencerr rrr!headerReferences r%r_Header._definitionrr'cURRUR5nURR U5 g)z6Remove header definition associated with this section.N)rremove_headerReferencerr drop_header_partrs r%r_Header._drop_definitions0ll11$2D2DE ,,S1r'cTURRUR5nUSL$)z8True if a header is explicitly defined for this section.N)rrrrs r%r_Header._has_definitionrr'cxURRnUcS$[XRUR5$)zI|_Header| proxy on prior sectPr element or None if this is first section.N)rrr>r rrs r%r_Header._prior_headerfooterrr'rNrrrr'r%r>r>sO DD2 ++   r'r>N)(r __future__rtypingrrrrr docx.blkcntnrr docx.enum.sectionr docx.oxml.text.paragraphr docx.parts.hdrftrr r docx.sharedr docx.tablerdocx.text.paragraphrrrdocx.oxml.documentrdocx.oxml.sectionrdocx.parts.documentrdocx.parts.storyrrrrrr8r>rr'r%rs5"DD,.)4$)B.+0*"e(e(P2x 2BbJ*bJJ+ + \+ + r'