File: //home/arjun/projects/env/lib/python3.10/site-packages/docx/__pycache__/section.cpython-310.pyc
o
$wefH � @ s* d Z ddlmZ ddlmZmZmZmZmZ ddl m
Z
ddl m Z ddl
mZ ddlmZmZ ddlmZ dd lmZ dd
lmZ erjdd l mZmZ dd lmZ dd
l m Z ddl m Z ddl m!Z! ddlm"Z" G dd� d�Z#G dd� dee# �Z$G dd� de
�Z%G dd� de%�Z&G dd� de%�Z'dS ) z/The |Section| object and related proxy classes.� )� annotations)�
TYPE_CHECKING�Iterator�List�Sequence�overload)�BlockItemContainer)�WD_HEADER_FOOTER)�CT_P)�
FooterPart�
HeaderPart)� lazyproperty)�Table)� Paragraph)�WD_ORIENTATION�WD_SECTION_START)� CT_Document)� CT_SectPr)� DocumentPart)� StoryPart)�Lengthc s� e Zd ZdZdI� fdd� ZedJd
d ��ZejdKdd ��ZedLdd��ZejdMdd��ZedNdd��Z edOdd��Z
edNdd��Z edOdd ��Z e
dNd d ��ZedJd d ��ZejdKd!d ��ZedJd"d#��ZejdKd$d#��Ze
dOd%d&��ZedJd'd(��ZejdKd)d(��ZdPd+d,�ZedJd-d.��ZejdKd/d.��ZedQd1d2��ZejdRd4d2��ZedJd5d6��ZejdSd7d6��ZedJd8d9��ZejdSd:d9��ZedTd<d=��ZedJd>d?��ZejdSd@d?��ZedUdBdC��ZejdVdEdC��ZedJdFdG��ZejdSdHdG��Z� Z S )W�Sectionz}Document section, providing access to section and page setup settings.
Also provides access to headers and footers.
�sectPrr �
document_partr c � t t| ��� || _|| _d S �N)�superr �__init__�_sectPr�_document_part)�selfr r �� __class__� �E/home/arjun/projects/env/lib/python3.10/site-packages/docx/section.pyr �
zSection.__init__�return�
Length | Nonec C � | j jS )z�Read/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_margin�r r# r# r$ r* # � zSection.bottom_margin�value�int | Length | Nonec C � || j _d S r r) �r r- r# r# r$ r* , � �boolc C r( )z�True 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+ r# r# r$ �"different_first_page_header_footer0 r, z*Section.different_first_page_header_footerc C r/ r r3 r0 r# r# r$ r5 9 r1 �_Footerc C � t | j| jtj�S )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.
)r6 r r r � EVEN_PAGEr+ r# r# r$ �even_page_footer= � zSection.even_page_footer�_Headerc C r7 )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.
)r; r r r r8 r+ r# r# r$ �even_page_headerF r: zSection.even_page_headerc C r7 )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.
)r6 r r r �
FIRST_PAGEr+ r# r# r$ �first_page_footerO r: zSection.first_page_footerc C r7 )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 r r r= r+ r# r# r$ �first_page_headerX r: zSection.first_page_headerc C r7 )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.
)r6 r r r �PRIMARYr+ r# r# r$ �footera r: zSection.footerc C r( )z�Distance from bottom edge of page to bottom edge of the footer.
Read/write. |None| if no setting is present in the XML.
�r rA r+ r# r# r$ �footer_distancej � zSection.footer_distancec C r/ r rB r0 r# r# r$ rC r r1 c C r( )ai |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.
�r �gutterr+ r# r# r$ rF v s zSection.gutterc C r/ r rE r0 r# r# r$ rF � r1 c C r7 )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 r r r@ r+ r# r# r$ �header� r: zSection.headerc C r( )z�Distance 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.
�r rG r+ r# r# r$ �header_distance� r, zSection.header_distancec C r/ r rH r0 r# r# r$ rI � r1 �Iterator[Paragraph | Table]c c s6 � | j �� D ]}t|t�rt|| �nt|| �V qdS )zlGenerate each Paragraph or Table object in this `section`.
Items appear in document order.
N)r �iter_inner_content�
isinstancer
r r )r �elementr# r# r$ rK � s � ���zSection.iter_inner_contentc C r( )zk|Length| object representing the left margin for all pages in this section in
English Metric Units.�r � left_marginr+ r# r# r$ rO � � zSection.left_marginc C r/ r rN r0 r# r# r$ rO � r1 r c C r( )z�:ref:`WdOrientation` member specifying page orientation for this section.
One of ``WD_ORIENT.PORTRAIT`` or ``WD_ORIENT.LANDSCAPE``.
�r � orientationr+ r# r# r$ rR � rD zSection.orientation�WD_ORIENTATION | Nonec C r/ r rQ r0 r# r# r$ rR � r1 c C r( )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+ r# r# r$ rU � � zSection.page_heightc C r/ r rT r0 r# r# r$ rU � r1 c C r( )aA Total 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+ r# r# r$ rX � s
zSection.page_widthc C r/ r rW r0 r# r# r$ rX � r1 r c C s | j S r )r r+ r# r# r$ �part� s z Section.partc C r( )zl|Length| object representing the right margin for all pages in this section
in English Metric Units.�r � right_marginr+ r# r# r$ r[ � rP zSection.right_marginc C r/ r rZ r0 r# r# r$ r[ � r1 r c C r( )z�Type 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+ r# r# r$ r] � r, zSection.start_type�WD_SECTION_START | Nonec C r/ r r\ r0 r# r# r$ r] � r1 c C r( )zj|Length| object representing the top margin for all pages in this section in
English Metric Units.�r �
top_marginr+ r# r# r$ r` � rP zSection.top_marginc C r/ r r_ r0 r# r# r$ r` � r1 )r r r r )r& r' )r- r. �r& r2 )r- r2 )r& r6 )r& r; )r& rJ )r& r )r- rS )r- r' )r& r )r& r )r- r^ ) �__name__�
__module__� __qualname__�__doc__r �propertyr* �setterr5 r9 r< r> r? r
rA rC rF rG rI rK rO rR rU rX rY r[ r] r` �
__classcell__r# r# r! r$ r s�
r c s\ e Zd ZdZd� fdd� Zedd d
��Zeddd
��Zd dd
�Zd dd�Zd dd�Z� Z S ) �Sectionsz�Sequence of |Section| objects corresponding to the sections in the document.
Supports ``len()``, iteration, and indexed access.
� document_elmr r r c r r )r ri r �
_document_elmr )r rj r r! r# r$ r
r% zSections.__init__�key�intr& r c C � d S r r# �r rl r# r# r$ � __getitem__ � zSections.__getitem__�slice�
List[Section]c C rn r r# ro r# r# r$ rp rq � int | slice�Section | List[Section]c s8 t |t�r� fdd�� jj| D �S t� jj| � j�S )Nc s g | ]}t |� j��qS r# )r r )�.0r r+ r# r$ �
<listcomp> s
��z(Sections.__getitem__.<locals>.<listcomp>)rL rr rk �
sectPr_lstr r ro r# r+ r$ rp s
��Iterator[Section]c c s" � | j jD ] }t|| j�V qd S r )rk rx r r )r r r# r# r$ �__iter__ s � �zSections.__iter__c C s t | jj�S r )�lenrk rx r+ r# r# r$ �__len__# s zSections.__len__)rj r r r )rl rm r& r )rl rr r& rs )rl rt r& ru )r& ry )r& rm )
rb rc rd re r r rp rz r| rh r# r# r! r$ ri s
ri c @ s� e Zd ZdZd$dd �Zed%d d
��Zejd&dd
��Zed'dd��Zd'dd�Z ed'dd��Z
d(dd�Z edd� �Z d'd d �Z
ed%d d ��Zed)d!d"��Zd#S )*�_BaseHeaderFooterz)Base class for header and footer classes.r r r r �header_footer_indexr c C s || _ || _|| _d S r )r r �
_hdrftr_index)r r r r~ r# r# r$ r * s
z_BaseHeaderFooter.__init__r& r2 c C s | 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_definitionr+ r# r# r$ �is_linked_to_previous4 s z'_BaseHeaderFooter.is_linked_to_previousr- �Nonec C s6 t |�}|| jkr d S |du r| �� d S | �� d S )NT)r2 r� �_drop_definition�_add_definition)r r- � new_stater# r# r$ r� B s
�HeaderPart | FooterPartc C s | � � S )z�The |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+ r# r# r$ rY M rV z_BaseHeaderFooter.partc C � t d��)z&Return newly-added header/footer part.�$must be implemented by each subclass��NotImplementedErrorr+ r# r# r$ r� X � z!_BaseHeaderFooter._add_definitionc C r� )zE|HeaderPart| or |FooterPart| object containing header/footer content.r� r� r+ r# r# r$ � _definition\ � z _BaseHeaderFooter._definitionc C r� )zJRemove header/footer part containing the definition of this header/footer.r� r� r+ r# r# r$ r� a r� z"_BaseHeaderFooter._drop_definitionc C s
| � � jS )z7`w:hdr` or `w:ftr` element, root of header/footer part.)r� rM r+ r# r# r$ �_elemente s
z_BaseHeaderFooter._elementc C s& | j r| jS | j}|r|�� S | �� S )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.
)r� r� �_prior_headerfooterr� r� )r �prior_headerfooterr# r# r$ r� j s z(_BaseHeaderFooter._get_or_add_definitionc C r� )zHTrue if this header/footer has a related part containing its definition.r� r� r+ r# r# r$ r� ~ r� z!_BaseHeaderFooter._has_definition�_Header | _Footer | Nonec C r� )zn|_Header| or |_Footer| proxy on prior sectPr element.
Returns None if this is first section.
r� r� r+ r# r# r$ r� � rD z%_BaseHeaderFooter._prior_headerfooterN)r r r r r~ r ra )r- r2 r& r� )r& r� )r& r� )r& r� )rb rc rd re r rf r� rg rY r� r� r� r� r� r� r� r# r# r# r$ r} ' s(
r} c @ sH e Zd ZdZddd�Zedd� �Zdd � Zedd d ��Zed
d� �Z dS )r6 a� Page 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.
r& r c C �" | j �� \}}| j�| j|� |S )z Return newly-added footer part.)r �add_footer_partr �add_footerReferencer )r � footer_part�rIdr# r# r$ r� � � z_Footer._add_definitionc C �( | j �| j�}|dus
J �| j�|j�S )z6|FooterPart| object containing content of this footer.N)r �get_footerReferencer r r� r� �r �footerReferencer# r# r$ r� � � z_Footer._definitionc C � | j �| j�}| j�|� dS )zDRemove footer definition (footer part) associated with this section.N)r �remove_footerReferencer r �drop_rel�r r� r# r# r$ r� � � z_Footer._drop_definitionr2 c C � | j �| j�}|duS )z-True if a footer is defined for this section.N)r r� r r� r# r# r$ r� � � z_Footer._has_definitionc C �$ | j j}|du r
dS t|| j| j�S )zI|_Footer| proxy on prior sectPr element or None if this is first section.N)r �preceding_sectPrr6 r r �r r� r# r# r$ r� � � ���z_Footer._prior_headerfooterN)r& r ra �
rb rc rd re r� rf r� r� r� r� r# r# r# r$ r6 � s
r6 c @ sF e Zd ZdZdd� Zedd� �Zdd� Zedd
d ��Zed d
� �Z dS )r; a� Page 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.
c C r� )z Return newly-added header part.)r �add_header_partr �add_headerReferencer )r � header_partr� r# r# r$ r� � r� z_Header._add_definitionc C r� )z6|HeaderPart| object containing content of this header.N)r �get_headerReferencer r r� r� �r �headerReferencer# r# r$ r� � r� z_Header._definitionc C r� )z6Remove header definition associated with this section.N)r �remove_headerReferencer r �drop_header_partr� r# r# r$ r� � r� z_Header._drop_definitionr& r2 c C r� )z8True if a header is explicitly defined for this section.N)r r� r r� r# r# r$ r� � r� z_Header._has_definitionc C r� )zI|_Header| proxy on prior sectPr element or None if this is first section.N)r r� r; r r r� r# r# r$ r� � r� z_Header._prior_headerfooterNra r� r# r# r# r$ r; � s
r; N)(re �
__future__r �typingr r r r r �
docx.blkcntnrr �docx.enum.sectionr �docx.oxml.text.paragraphr
�docx.parts.hdrftrr r � docx.sharedr
�
docx.tabler �docx.text.paragraphr r r �docx.oxml.documentr �docx.oxml.sectionr �docx.parts.documentr �docx.parts.storyr r r ri r} r6 r; r# r# r# r$ �<module> s. m#e.