U cqeâ%ã@súdZddlmZddlmZmZmZmZddlm Z ddl m Z ddl mZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZerØddlmZddl m!Z!m"Z"ddlm#Z#Gdd„deƒZ$Gdd„dƒZ%dS)z=Run-related proxy objects for python-docx, Run in particular.é)Ú annotations)ÚIOÚ TYPE_CHECKINGÚIteratorÚcast)Útypes)ÚDrawing)Ú WD_STYLE_TYPE)ÚWD_BREAK)Ú CT_Drawing)ÚCT_LastRenderedPageBreak)Ú InlineShape)Ú StoryChild)ÚCharacterStyle)ÚFont)ÚRenderedPageBreak)Ú WD_UNDERLINE)ÚCT_RÚCT_Text)ÚLengthcsfeZdZdZdddœ‡fdd„ Zejfddœd d „Zd:d d d ddœdd„Zddœdd„Z ddœdd„Z e ddœdd„ƒZ e j ddœdd„ƒZ dd „Ze d!dœd"d#„ƒZe d$dœd%d&„ƒZe ddœd'd(„ƒZej ddœd)d(„ƒZd*dœd+d,„Ze d-dœd.d/„ƒZej d0d1œd2d/„ƒZe ddœd3d4„ƒZej ddœd5d4„ƒZe d6dœd7d8„ƒZej d!dœd9d8„ƒZ‡ZS);ÚRunaIProxy object wrapping `` element. Several of the properties on Run take a tri-state value, |True|, |False|, or |None|. |True| and |False| correspond to on and off respectively. |None| indicates the property is not specified directly on the run and its effective value is taken from the style hierarchy. rzt.ProvidesStoryPart)ÚrÚparentcs"tƒ |¡||_|_|_dS©N)ÚsuperÚ__init__Ú_rÚ_elementÚelement)Úselfrr©Ú __class__©ú1/tmp/pip-unpacked-wheel-gx5hpqp3/docx/text/run.pyr"s z Run.__init__r )Ú break_typec CsZtjdtjdtjdtjdtjdtjdi|\}}|j ¡}|dk rH||_ |dk rV||_ dS)a Add a break element of `break_type` to this run. `break_type` can take the values `WD_BREAK.LINE`, `WD_BREAK.PAGE`, and `WD_BREAK.COLUMN` where `WD_BREAK` is imported from `docx.enum.text`. `break_type` defaults to `WD_BREAK.LINE`. )NN)ÚpageN)ÚcolumnN)Ú textWrappingÚleft)r'Úright)r'ÚallN) r ÚLINEZPAGEZCOLUMNZLINE_CLEAR_LEFTZLINE_CLEAR_RIGHTZLINE_CLEAR_ALLrZadd_brÚtypeÚclear)rr$Útype_r-Úbrr"r"r#Ú add_break&s(úù z Run.add_breakNzstr | IO[bytes]z Length | Noner )Úimage_path_or_streamÚwidthÚheightÚreturncCs$|j |||¡}|j |¡t|ƒS)aÑReturn |InlineShape| containing image identified by `image_path_or_stream`. The picture is added to the end of this run. `image_path_or_stream` can be a path (a string) or a file-like object containing a binary image. If neither width nor height is specified, the picture appears at its native size. If only one is specified, it is used to compute a scaling factor that is then applied to the unspecified dimension, preserving the aspect ratio of the image. The native size of the picture is calculated using the dots- per-inch (dpi) value specified in the image file, defaulting to 72 dpi if no value is specified, as is often the case. )ÚpartZnew_pic_inlinerZ add_drawingr )rr1r2r3Úinliner"r"r#Ú add_picture;s zRun.add_pictureÚNone)r4cCs|j ¡dS)zcAdd a ```` element at the end of the run, which Word interprets as a tab character.N)rÚadd_tab©rr"r"r#r9Ssz Run.add_tabÚstr)ÚtextcCs|j |¡}t|ƒS)zþReturns a newly appended |_Text| object (corresponding to a new ```` child element) to the run, containing `text`. Compare with the possibly more friendly approach of assigning text to the :attr:`Run.text` property. )rZadd_tÚ_Text)rr<Útr"r"r#Úadd_textXs z Run.add_textz bool | NonecCs|jjS)aRead/write tri-state value. When |True|, causes the text of the run to appear in bold face. When |False|, the text unconditionally appears non-bold. When |None| the bold setting for this run is inherited from the style hierarchy. ©ÚfontÚboldr:r"r"r#rBbszRun.bold)ÚvaluecCs ||j_dSrr@©rrCr"r"r#rBlscCs|j ¡|S)zoReturn reference to this run after removing all its content. All run formatting is preserved. )rÚ clear_contentr:r"r"r#r-ps z Run.clearÚboolcCs t|jjƒS)a¯`True` when one or more rendered page-breaks occur in this run. Note that "hard" page-breaks inserted by the author are not included. A hard page-break gives rise to a rendered page-break in the right position so if those were included that page-break would be "double-counted". It would be very rare for multiple rendered page-breaks to occur in a single run, but it is possible. )rFrZlastRenderedPageBreaksr:r"r"r#Úcontains_page_breakxs zRun.contains_page_breakrcCs t|jƒS)z{The |Font| object providing access to the character formatting properties for this run, such as font name and size.)rrr:r"r"r#rA…szRun.fontcCs|jjS)a Read/write tri-state value. When |True|, causes the text of the run to appear in italics. When |False|, the text unconditionally appears non-italic. When |None| the italic setting for this run is inherited from the style hierarchy. ©rAÚitalicr:r"r"r#rI‹sz Run.italiccCs ||j_dSrrHrDr"r"r#rI•sz+Iterator[str | Drawing | RenderedPageBreak]ccsR|jjD]D}t|tƒr|Vqt|tƒr6t||ƒVqt|tƒrt||ƒVqdS)a'Generate the content-items in this run in the order they appear. NOTE: only content-types currently supported by `python-docx` are generated. In this version, that is text and rendered page-breaks. Drawing is included but currently only provides access to its XML element (CT_Drawing) on its `._drawing` attribute. `Drawing` attributes and methods may be expanded in future releases. There are a number of element-types that can appear inside a run, but most of those (w:br, w:cr, w:noBreakHyphen, w:t, w:tab) have a clear plain-text equivalent. Any contiguous range of such elements is generated as a single `str`. Rendered page-break and drawing elements are generated individually. Any other elements are ignored. N)rZinner_content_itemsÚ isinstancer;r rr r)rÚitemr"r"r#Úiter_inner_content™s   ÿzRun.iter_inner_contentrcCs|jj}tt|j |tj¡ƒS)aaRead/write. A |CharacterStyle| object representing the character style applied to this run. The default character style for the document (often `Default Character Font`) is returned if the run has no directly-applied character style. Setting this property to |None| removes any directly-applied character style. )rÚstylerrr5Z get_styler Ú CHARACTER)rÚstyle_idr"r"r#rM²s ÿz Run.stylezstr | CharacterStyle | None)Ú style_or_namecCs|j |tj¡}||j_dSr)r5Z get_style_idr rNrrM)rrPrOr"r"r#rMÀscCs|jjS)a"String formed by concatenating the text equivalent of each run. Each `` element adds the text characters it contains. A `` element adds a `\t` character. A `` or `` element each add a `\n` character. Note that a `` element can indicate a page break or column break as well as a line break. Only line-break `` elements translate to a `\n` character. Others are ignored. All other content child elements, such as ``, are ignored. Assigning text to this property has the reverse effect, translating each `\t` character to a `` element and each `\n` or `\r` character to a `` element. Any existing run content is replaced. Run formatting is preserved. ©rr<r:r"r"r#r<ÅszRun.textcCs ||j_dSrrQ)rr<r"r"r#r<×szbool | WD_UNDERLINE | NonecCs|jjS)a«The underline style for this |Run|. Value is one of |None|, |True|, |False|, or a member of :ref:`WdUnderline`. A value of |None| indicates the run has no directly-applied underline value and so will inherit the underline value of its containing paragraph. Assigning |None| to this property removes any directly-applied underline value. A value of |False| indicates a directly-applied setting of no underline, overriding any inherited value. A value of |True| indicates single underline. The values from :ref:`WdUnderline` are used to specify other outline styles such as double, wavy, and dotted. ©rAÚ underliner:r"r"r#rSÛsz Run.underlinecCs ||j_dSrrRrDr"r"r#rSïs)NN)Ú__name__Ú __module__Ú __qualname__Ú__doc__rr r+r0r7r9r?ÚpropertyrBÚsetterr-rGrArIrLrMr<rSÚ __classcell__r"r"r r#rsDü     rcs&eZdZdZddœ‡fdd„ Z‡ZS)r=z&Proxy object wrapping `` element.r)Út_elmcstt|ƒ ¡||_dSr)rr=rZ_t)rr[r r"r#r÷sz_Text.__init__)rTrUrVrWrrZr"r"r r#r=ôsr=N)&rWÚ __future__rÚtypingrrrrZdocxrr>Z docx.drawingrZdocx.enum.styler Zdocx.enum.textr Zdocx.oxml.drawingr Zdocx.oxml.text.pagebreakr Z docx.shaper Z docx.sharedrZdocx.styles.stylerZdocx.text.fontrZdocx.text.pagebreakrrZdocx.oxml.text.runrrrrr=r"r"r"r#Ús(              \