o j6[)@shdZddlmZmZmZmZddlmZddlm Z m Z m Z m Z m Z mZddlmZGdd d e Zd S) z Paragraph-related proxy types. )absolute_importdivisionprint_functionunicode_literals)WD_LINE_SPACING) ElementProxyEmu lazypropertyLengthPtTwips)TabStopsc@speZdZdZdZeddZejddZeddZejddZed d Z e jd d Z ed d Z e jdd Z eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZeddZejddZeddZejd dZed!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. )Z _tab_stopscC|jj}|dur 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)_elementpPrjc_valselfrr@D:\Projects\ConvertPro\env\Lib\site-packages\docx\text\parfmt.py alignmentzParagraphFormat.alignmentcC|j}||_dSN)rget_or_add_pPrrrvaluerrrrr%  cCr)aI |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)rrfirst_line_indentrrrrr!* z!ParagraphFormat.first_line_indentcCrr)rrr!rrrrr!8r cCr)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)rr keepLines_valrrrr keep_together=rzParagraphFormat.keep_togethercC||j_dSr)rrr#rrrrrr$IcCr)a\ |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)rr keepNext_valrrrrkeep_with_nextMr"zParagraphFormat.keep_with_nextcCr%r)rrr(r&rrrr)[r'cCr)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)rrind_leftrrrr left_indent_zParagraphFormat.left_indentcCrr)rrr*rrrrr+lr cC$|jj}|dur dS||j|jS)aJ |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)rr _line_spacing spacing_linespacing_lineRulerrrr line_spacingqs zParagraphFormat.line_spacingcCsl|j}|durd|_d|_dSt|tr'||_|jtjkr%tj|_dSdSt |t d|_tj |_dS)N) rrr/r0 isinstancer rZAT_LEASTZEXACTLYr r MULTIPLErrrrr1s      cCr-)a| 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)rr_line_spacing_ruler/r0rrrrline_spacing_rules  z!ParagraphFormat.line_spacing_rulecCst|j}|tjkrtd|_tj|_dS|tjkr%td|_tj|_dS|tj kr5td|_tj|_dS||_dS)Nr2h) rrrSINGLEr r/r4r0ONE_POINT_FIVEDOUBLErrrrr6s           cCr)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)rrpageBreakBefore_valrrrrpage_break_beforerz!ParagraphFormat.page_break_beforecCr%r)rrr<r&rrrr=r'cCr)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)rr ind_rightrrrr right_indentr,zParagraphFormat.right_indentcCrr)rrr>rrrrr?r cCr)a |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)rr spacing_afterrrrr space_after zParagraphFormat.space_aftercCr%r)rrr@r&rrrrAr'cCr)av |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)rrspacing_beforerrrr space_beforerBzParagraphFormat.space_beforecCr%r)rrrCr&rrrrDr'cCs|j}t|S)zp |TabStops| object providing access to the tab stops defined for this paragraph format. )rrrrrrr tab_stopss zParagraphFormat.tab_stopscCr)a |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)rrwidowControl_valrrrr widow_controlr,zParagraphFormat.widow_controlcCr%r)rrrFr&rrrrG r'cCs&|durdS|tjkr|tdS|S)ac 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 )rr4r )r/r0rrrr.s    zParagraphFormat._line_spacingcCsD|tjkr |tdkrtjS|tdkrtjS|tdkr tjS|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. r2r7r8)rr4r r9r:r;)lineZlineRulerrrr5 s    z"ParagraphFormat._line_spacing_ruleN)__name__ __module__ __qualname____doc__ __slots__propertyrsetterr!r$r)r+r1r6r=r?rArDr rErG staticmethodr.r5rrrrrsr                          rN)rMZ __future__rrrrZ enum.textrsharedrr r r r r Ztabstopsrrrrrrs