a ]jc(@sPdZddlmZddlmZmZmZmZmZm Z ddl m Z GdddeZ dS)zParagraph-related proxy types.)WD_LINE_SPACING) ElementProxyEmuLengthPtTwips lazyproperty)TabStopsc@sleZdZdZeddZejddZeddZejddZedd Zejd d Zed d Z e jd d Z eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZ e jddZ eddZejddZeddZejddZed d!Zejd"d!Zed#d$Zed%d&Zejd'd&Zed(d)Zed*d+Zd,S)-ParagraphFormatzProvides access to paragraph formatting such as justification, indentation, line spacing, space before and after, and widow/orphan control.cCs|jj}|durdS|jS)zA 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_valselfr rL/var/www/html/assistant/venv/lib/python3.9/site-packages/docx/text/parfmt.py alignment szParagraphFormat.alignmentcCs|j}||_dSN)r get_or_add_pPrr rvaluer rrrrs cCs|jj}|durdS|jS)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_indentrrrrrs z!ParagraphFormat.first_line_indentcCs|j}||_dSr)r rrrrrrr,s cCs|jj}|durdS|jS)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_valrrrr keep_together1szParagraphFormat.keep_togethercCs||j_dSr)r rrrrrrrr=scCs|jj}|durdS|jS)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_valrrrrkeep_with_nextAs zParagraphFormat.keep_with_nextcCs||j_dSr)r rrrrrrrOscCs|jj}|durdS|jS)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_leftrrrr left_indentSs zParagraphFormat.left_indentcCs|j}||_dSr)r rrrrrrras cCs$|jj}|durdS||j|jS)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_linespacing_lineRulerrrr line_spacingfs zParagraphFormat.line_spacingcCsd|j}|dur d|_d|_n@t|trF||_|jtjkr`tj|_nt |t d|_tj |_dS)N) r rr r! isinstancerrZAT_LEASTZEXACTLYrrMULTIPLErrrrr"ws    cCs$|jj}|durdS||j|jS)atA 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!rrrrline_spacing_rules z!ParagraphFormat.line_spacing_rulecCsn|j}|tjkr(td|_tj|_nB|tjkrFtd|_tj|_n$|tj krdtd|_tj|_n||_dS)Nr#h) r rrSINGLErr r%r!ONE_POINT_FIVEDOUBLErrrrr's          cCs|jj}|durdS|jS)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_valrrrrpage_break_beforesz!ParagraphFormat.page_break_beforecCs||j_dSr)r rr-rrrrr.scCs|jj}|durdS|jS)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_rightrrrr right_indents zParagraphFormat.right_indentcCs|j}||_dSr)r rr/rrrrr0s cCs|jj}|durdS|jS)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_afterrrrr space_afters zParagraphFormat.space_aftercCs||j_dSr)r rr1rrrrr2scCs|jj}|durdS|jS)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_beforerrrr space_befores zParagraphFormat.space_beforecCs||j_dSr)r rr3rrrrr4scCs|j}t|S)z^|TabStops| object providing access to the tab stops defined for this paragraph format.)r rr rrrr tab_stopss zParagraphFormat.tab_stopscCs|jj}|durdS|jS)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_valrrrr widow_controlszParagraphFormat.widow_controlcCs||j_dSr)r rr6rrrrr7scCs&|dur dS|tjkr"|tdS|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 )rr%r)r r!rrrrs   zParagraphFormat._line_spacingcCsD|tjkr@|tdkrtjS|tdkr.tjS|tdkr@tjS|S)zReturn 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#r(r))rr%rr*r+r,)lineZlineRulerrrr&s    z"ParagraphFormat._line_spacing_ruleN)__name__ __module__ __qualname____doc__propertyrsetterrrrrr"r'r.r0r2r4rr5r7 staticmethodrr&rrrrr sn                          r N) r=Zdocx.enum.textrZ docx.sharedrrrrrrZdocx.text.tabstopsr r rrrrs