File: //home/arjun/projects/env/lib/python3.10/site-packages/docx/text/__pycache__/parfmt.cpython-310.pyc
o
$wec( � @ sP d Z ddlmZ ddlmZmZmZmZmZm Z ddl
m Z G dd� de�Z dS )z Paragraph-related proxy types.� )�WD_LINE_SPACING)� ElementProxy�Emu�Length�Pt�Twips� lazyproperty)�TabStopsc @ sl e Zd ZdZedd� �Zejdd� �Zedd� �Zejdd� �Zedd � �Zejd
d � �Zed d � �Z e jd
d � �Z edd� �Z
e
jdd� �Z
edd� �Z e jdd� �Z edd� �Z e jdd� �Z edd� �Z
e
jdd� �Z
edd� �Zejd d� �Zed d � �Zejd d � �Zed d!� �Zejd"d!� �Zed#d$� �Zed%d&� �Zejd'd&� �Zed(d)� �Zed*d+� �Zd,S )-�ParagraphFormatz�Provides access to paragraph formatting such as justification, indentation, line
spacing, space before and after, and widow/orphan control.c C � | j j}|du r
dS |jS )z�A member of the :ref:`WdParagraphAlignment` enumeration specifying the
justification setting for this paragraph.
A value of |None| indicates paragraph alignment is inherited from the style
hierarchy.
N)�_element�pPr�jc_val��selfr
� r �I/home/arjun/projects/env/lib/python3.10/site-packages/docx/text/parfmt.py� alignment s zParagraphFormat.alignmentc C � | j �� }||_d S �N)r �get_or_add_pPrr �r �valuer
r r r r �
c C r )aA |Length| value specifying the relative difference in indentation for the
first line of the paragraph.
A positive value causes the first line to be indented. A negative value produces
a hanging indent. |None| indicates first line indentation is inherited from the
style hierarchy.
N)r r
�first_line_indentr r r r r � z!ParagraphFormat.first_line_indentc C r r )r r r r r r r r , r c C r )z�|True| if the paragraph should be kept "in one piece" and not broken across a
page boundary when the document is rendered.
|None| indicates its effective value is inherited from the style hierarchy.
N)r r
�
keepLines_valr r r r �
keep_together1 � z ParagraphFormat.keep_togetherc C � || j �� _d S r )r r r �r r r r r r = � c C r )aT |True| if the paragraph should be kept on the same page as the subsequent
paragraph when the document is rendered.
For example, this property could be used to keep a section heading on the same
page as its first paragraph. |None| indicates its effective value is inherited
from the style hierarchy.
N)r r
� keepNext_valr r r r �keep_with_nextA r z ParagraphFormat.keep_with_nextc C r r )r r r" r r r r r# O r! c C r )a1 |Length| value specifying the space between the left margin and the left side
of the paragraph.
|None| indicates the left indent value is inherited from the style hierarchy.
Use an |Inches| value object as a convenient way to apply indentation in units
of inches.
N)r r
�ind_leftr r r r � left_indentS r zParagraphFormat.left_indentc C r r )r r r$ r r r r r% a r c C �$ | j j}|du r
dS | �|j|j�S )aB |float| or |Length| value specifying the space between baselines in
successive lines of the paragraph.
A value of |None| indicates line spacing is inherited from the style hierarchy.
A float value, e.g. ``2.0`` or ``1.75``, indicates spacing is applied in
multiples of line heights. A |Length| value such as ``Pt(12)`` indicates spacing
is a fixed height. The |Pt| value class is a convenient way to apply line
spacing in units of points. Assigning |None| resets line spacing to inherit from
the style hierarchy.
N)r r
�
_line_spacing� spacing_line�spacing_lineRuler r r r � line_spacingf s z ParagraphFormat.line_spacingc C sl | j �� }|d u rd |_d |_d S t|t�r'||_|jtjkr%tj|_d S d S t |t
d� �|_tj |_d S )N�� ) r r r( r) �
isinstancer r �AT_LEAST�EXACTLYr r �MULTIPLEr r r r r* w s
� c C r& )at A member of the :ref:`WdLineSpacing` enumeration indicating how the value of
:attr:`line_spacing` should be interpreted.
Assigning any of the :ref:`WdLineSpacing` members :attr:`SINGLE`,
:attr:`DOUBLE`, or :attr:`ONE_POINT_FIVE` will cause the value of
:attr:`line_spacing` to be updated to produce the corresponding line spacing.
N)r r
�_line_spacing_ruler( r) r r r r �line_spacing_rule� s z!ParagraphFormat.line_spacing_rulec C st | j �� }|tjkrtd�|_tj|_d S |tjkr%td�|_tj|_d S |tj kr5td�|_tj|_d S ||_d S )Nr+ �h �� )
r r r �SINGLEr r( r/ r) �ONE_POINT_FIVE�DOUBLEr r r r r1 � s
c C r )z�|True| if the paragraph should appear at the top of the page following the
prior paragraph.
|None| indicates its effective value is inherited from the style hierarchy.
N)r r
�pageBreakBefore_valr r r r �page_break_before� r z!ParagraphFormat.page_break_beforec C r r )r r r7 r r r r r8 � r! c C r )a4 |Length| value specifying the space between the right margin and the right
side of the paragraph.
|None| indicates the right indent value is inherited from the style hierarchy.
Use a |Cm| value object as a convenient way to apply indentation in units of
centimeters.
N)r r
� ind_rightr r r r � right_indent� r z ParagraphFormat.right_indentc C r r )r r r9 r r r r r: � r c C r )ao |Length| value specifying the spacing to appear between this paragraph and
the subsequent paragraph.
|None| indicates this value is inherited from the style hierarchy. |Length|
objects provide convenience properties, such as :attr:`~.Length.pt` and
:attr:`~.Length.inches`, that allow easy conversion to various length units.
N)r r
�
spacing_afterr r r r � space_after� r zParagraphFormat.space_afterc C r r )r r r; r r r r r< � r! c C r )af |Length| value specifying the spacing to appear between this paragraph and
the prior paragraph.
|None| indicates this value is inherited from the style hierarchy. |Length|
objects provide convenience properties, such as :attr:`~.Length.pt` and
:attr:`~.Length.cm`, that allow easy conversion to various length units.
N)r r
�spacing_beforer r r r � space_before� r z ParagraphFormat.space_beforec C r r )r r r= r r r r r> � r! c C s | j �� }t|�S )z^|TabStops| object providing access to the tab stops defined for this
paragraph format.)r r r r r r r � tab_stops� s
zParagraphFormat.tab_stopsc C r )z�|True| if the first and last lines in the paragraph remain on the same page
as the rest of the paragraph when Word repaginates the document.
|None| indicates its effective value is inherited from the style hierarchy.
N)r r
�widowControl_valr r r r �
widow_control� r z ParagraphFormat.widow_controlc C r r )r r r@ r r r r rA � r! c C s& | du rdS |t jkr| td� S | S )a[ Return the line spacing value calculated from the combination of
`spacing_line` and `spacing_lineRule`.
Returns a |float| number of lines when `spacing_lineRule` is
``WD_LINE_SPACING.MULTIPLE``, otherwise a |Length| object of absolute line
height is returned. Returns |None| when `spacing_line` is |None|.
N� )r r/ r )r( r) r r r r' s
z ParagraphFormat._line_spacingc C sD |t jkr | td�krt jS | td�krt jS | td�kr t jS |S )z�Return the line spacing rule value calculated from the combination of `line`
and `lineRule`.
Returns special members of the :ref:`WdLineSpacing` enumeration when line
spacing is single, double, or 1.5 lines.
r+ r2 r3 )r r/ r r4 r5 r6 )�line�lineRuler r r r0 s
z"ParagraphFormat._line_spacing_ruleN)�__name__�
__module__� __qualname__�__doc__�propertyr �setterr r r# r% r* r1 r8 r: r< r> r r? rA � staticmethodr' r0 r r r r r
sp
r
N)
rH �docx.enum.textr � docx.sharedr r r r r r �docx.text.tabstopsr r
r r r r �<module> s