o 7hc@sddZddlmZddlmZmZmZddlmZddl m Z ddl m Z ddl mZmZmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZmZmZm Z m!Z!erddl"m#Z#ddl m$Z$mZm%Z%ddl&m'Z'ddl(m)Z)m*Z*m+Z+m,Z,m-Z-ddl.m/Z/m0Z0GdddeZ1Gddde2Z3GdddeZ4GdddeZ5GdddeZ6dS)z5Text-related objects such as TextFrame and Paragraph.) annotations) TYPE_CHECKINGIteratorcast) FillFormat)MSO_FILL)MSO_LANGUAGE_ID) MSO_AUTO_SIZE MSO_UNDERLINEMSO_VERTICAL_ANCHOR)RELATIONSHIP_TYPE)ST_TextWrappingType)Subshape) FontFiles) TextFitter) CentipointsEmuLengthPt lazyproperty) ColorFormat)MSO_TEXT_UNDERLINE_TYPEr PP_PARAGRAPH_ALIGNMENT) CT_Hyperlink)CT_RegularTextRun CT_TextBodyCT_TextCharacterPropertiesCT_TextParagraphCT_TextParagraphProperties)ProvidesExtents ProvidesPartcs~eZdZdZdNfdd Zdd ZedOd d ZejdPdd ZddZ     dQdRdd Z edSd"d#Z e jdTd%d#Z edSd&d'Z e jdTd(d'Z edSd)d*Z e jdTd+d*Z edSd,d-ZejdTd.d-ZedUd0d1ZedVd2d3ZejdWd5d3ZedXd7d8ZejdYd9d8ZedZd;d<Zejd[d=d<Zd\dAdBZd]dDdEZedFdGZed^dIdJZd_dLdMZZS)` TextFramezThe part of a shape that contains its text. Not all shapes have a text frame. Corresponds to the `p:txBody` element that can appear as a child element of `p:sp`. Not intended to be constructed directly. txBodyrparentr cs&tt||||_|_||_dSN)superr!__init___element_txBody_parent)selfr"r# __class__V/var/www/html/figdemos/bartoux_crm/venv/lib/python3.10/site-packages/pptx/text/text.pyr&+s  zTextFrame.__init__cC|j}t||S)z Return new |_Paragraph| instance appended to the sequence of paragraphs contained in this text frame. )r(add_p _Paragraphr*pr-r-r. add_paragraph0s  zTextFrame.add_paragraphreturnMSO_AUTO_SIZE | NonecC|jjS)asResizing strategy used to fit text within this shape. Determins the type of automatic resizing used to fit the text of this shape within its bounding box when the text would otherwise extend beyond the shape boundaries. May be |None|, `MSO_AUTO_SIZE.NONE`, `MSO_AUTO_SIZE.SHAPE_TO_FIT_TEXT`, or `MSO_AUTO_SIZE.TEXT_TO_FIT_SHAPE`. _bodyPrautofitr*r-r-r. auto_size8s zTextFrame.auto_sizevaluecC ||j_dSr$r8r*r=r-r-r.r<C cCs8|jjddD]}|j|q|jd}|dS)z+Remove all paragraphs except one empty one.Nr)r(p_lstremove paragraphsclearr2r-r-r.rEGs  zTextFrame.clearCalibriFN font_familystrmax_sizeintboldboolitalic font_file str | NonecCs4|jdkrdS||||||}|||||dS)aFit text-frame text entirely within bounds of its shape. Make the text in this text frame fit entirely within the bounds of its shape by setting word wrap on and applying the "best-fit" font size to all the text it contains. :attr:`TextFrame.auto_size` is set to :attr:`MSO_AUTO_SIZE.NONE`. The font size will not be set larger than `max_size` points. If the path to a matching TrueType font is provided as `font_file`, that font file will be used for the font metrics. If `font_file` is |None|, best efforts are made to locate a font file with matchhing `font_family`, `bold`, and `italic` installed on the current system (usually succeeds if the font is installed). N)text_best_fit_font_size _apply_fit)r*rHrJrLrNrO font_sizer-r-r.fit_textNs zTextFrame.fit_textrcCr7)z|Length| value representing the inset of text from the bottom text frame border. :meth:`pptx.util.Inches` provides a convenient way of setting the value, e.g. `text_frame.margin_bottom = Inches(0.05)`. r9bInsr;r-r-r. margin_bottomhszTextFrame.margin_bottomemucCr>r$rWr*rZr-r-r.rYqr@cCr7)zr$r\r[r-r-r.r^zr@cCr7)z=Inset of text from right text frame border as |Length| value.r9rInsr;r-r-r. margin_right~r_zTextFrame.margin_rightcCr>r$r`r[r-r-r.rbr@cCr7)z;Inset of text from top text frame border as |Length| value.r9tInsr;r-r-r. margin_topr_zTextFrame.margin_topcCr>r$rcr[r-r-r.rer@tuple[_Paragraph, ...]ctfddjjDS)zqSequence of paragraphs in this text frame. A text frame always contains at least one paragraph. csg|]}t|qSr-)r1).0r3r;r-r. sz(TextFrame.paragraphs..)tupler(rBr;r-r;r.rDszTextFrame.paragraphscCsddd|jDS)auAll text in this text-frame as a single string. Read/write. The return value contains all text in this text-frame. A line-feed character (`"\n"`) separates the text for each paragraph. A vertical-tab character (`"\v"`) appears for each line break (aka. soft carriage-return) encountered. The vertical-tab character is how PowerPoint represents a soft carriage return in clipboard text, which is why that encoding was chosen. Assignment replaces all text in the text frame. A new paragraph is added for each line-feed character (`"\n"`) encountered. A line-break (soft carriage-return) is inserted for each vertical-tab character (`"\v"`) encountered. Any control character other than newline, tab, or vertical-tab are escaped as plain-text like "_x001B_" (for ESC (ASCII 32) in this example).  cs|]}|jVqdSr$rR)rhZ paragraphr-r-r. z!TextFrame.text..)joinrDr;r-r-r.rRszTextFrame.textrRcCs4|j}||dD] }|}||q dS)Nrk)r( clear_contentsplitr0 append_text)r*rRr"Zp_textr3r-r-r.rRs  MSO_VERTICAL_ANCHOR | NonecCs |jjjS)zRepresents the vertical alignment of text in this text frame. |None| indicates the effective value should be inherited from this object's style hierarchy. r(bodyPranchorr;r-r-r.vertical_anchor zTextFrame.vertical_anchorcCs|jj}||_dSr$ru)r*r=rvr-r-r.rxs  bool | NonecCstjdtjdddi|jjjS)az`True` when lines of text in this shape are wrapped to fit within the shape's width. Read-write. Valid values are True, False, or None. True and False turn word wrap on and off, respectively. Assigning None to word wrap causes any word wrap setting to be removed from the text frame, causing it to inherit this setting from its style hierarchy. TFN)r SQUARENONEr(rvwrapr;r-r-r. word_wraps  zTextFrame.word_wrapcCs2|dvr td|tjtjdd||jj_dS)N)TFNz3assigned value must be True, False, or None, got %s) ValueErrorr r{r|r(rvr}r?r-r-r.r~srUis_bold is_italiccCs"tj|_d|_|||||dS)zArrange text in this text frame to fit inside its extents. This is accomplished by setting auto size off, wrap on, and setting the font of all its text to `font_family`, `font_size`, `is_bold`, and `is_italic`. TN)r r|r<r~ _set_font)r*rHrUrrr-r-r.rTszTextFrame._apply_fitfamilycCs*|dur t|||}t|j|j||S)aReturn font-size in points that best fits text in this text-frame. The best-fit font size is the largest integer point size not greater than `max_size` that allows all the text in this text frame to fit inside its extents when rendered using the font described by `family`, `bold`, and `italic`. If `font_file` is specified, it is used to calculate the fit, whether or not it matches `family`, `bold`, and `italic`. N)rfindrZbest_fit_font_sizerR_extents)r*rrJrLrNrOr-r-r.rSs zTextFrame._best_fit_font_sizecCr7r$)r(rvr;r-r-r.r9zTextFrame._bodyPrtuple[Length, Length]cCs8td|j}t|j|j|jt|j|j|jfS)z(cx, cy) 2-tuple representing the effective rendering area of this text-frame. Margins are taken into account. r) rr)rwidthr^rbheightrerY)r*r#r-r-r.rs zTextFrame._extentssizec s@ddd}dfdd }|j}||D] }|||||qdS)z;Set the font properties of all the text in this text frame.r"rr5$Iterator[CT_TextCharacterProperties]css2|jD]}|jD]}|Vq |VqdSr$)rBcontent_childrenget_or_add_rPrget_or_add_endParaRPr)r"r3elmr-r-r. iter_rPrss     z&TextFrame._set_font..iter_rPrsrPrrnamerIrrKrLrMrNcs,t|}t|||f\|_|_|_|_dSr$)FontrrrrLrN)rrrrLrNfrr-r. set_rPr_font s$z)TextFrame._set_font..set_rPr_fontN)r"rr5r) rrrrIrrKrLrMrNrM)r') r*rrrLrNrrr"rr-rr.rs  zTextFrame._set_font)r"rr#r )r5r6)r=r6)rFrGFFN) rHrIrJrKrLrMrNrMrOrP)r5r)rZr)r5rfr5rIrRrI)r5rt)r=rtr5rzr=rz)rHrIrUrKrrMrrM) rrIrJrKrLrMrNrMrOrPr5rK)r5r)rrIrrKrLrMrNrM)__name__ __module__ __qualname____doc__r&r4propertyr<setterrErVrYr^rbrerDrRrxr~rTrSr9rr __classcell__r-r-r+r.r!$sh                       r!cseZdZdZd&fdd Zed'dd Zejd(d d Zed)d dZ ed*ddZ ed'ddZ e jd(ddZ ed+ddZ e jd,ddZ ed-ddZ e jd.ddZ ed/ddZejd0d!dZed1d#d$Zejd2d%d$ZZS)3rzCharacter properties object, providing font size, font name, bold, italic, etc. Corresponds to `a:rPr` child element of a run. Also appears as `a:defRPr` and `a:endParaRPr` in paragraph and `a:defRPr` in list style elements. rrcstt|||_|_dSr$)r%rr&r'_rPrr*rr+r-r.r&sz Font.__init__r5rzcCr7)ajGet or set boolean bold value of |Font|, e.g. `paragraph.font.bold = True`. If set to |None|, the bold setting is cleared and is inherited from an enclosing shape's setting, or a setting in a style or master. Returns None if no bold attribute is present, meaning the effective bold value is inherited from a master or the theme. rbr;r-r-r.rL#z Font.boldr=cCr>r$rr?r-r-r.rL-r@rcCs |jjtjkr |j|jjS)zTThe |ColorFormat| instance that provides access to the color settings for this font.)filltyperSOLIDsolid fore_colorr;r-r-r.color1s z Font.colorrcCs t|jS)zm|FillFormat| instance for this font. Provides access to fill properties such as fill color. )rfrom_fill_parentrr;r-r-r.r8s z Font.fillcCr7)zGet or set boolean italic value of |Font| instance. Has the same behaviors as bold with respect to None values. rir;r-r-r.rN@sz Font.italiccCr>r$rr?r-r-r.rNHr@MSO_LANGUAGE_ID | NonecCs|jj}|dur tjS|jjS)zGet or set the language id of this |Font| instance. The language id is a member of the :ref:`MsoLanguageId` enumeration. Assigning |None| removes any language setting, the same behavior as assigning `MSO_LANGUAGE_ID.NONE`. N)rlangrr|)r*rr-r-r. language_idLszFont.language_idcCs|tjkrd}||j_dSr$)rr|rrr?r-r-r.rXs  rPcC|jj}|dur dS|jS)a5Get or set the typeface name for this |Font| instance. Causes the text it controls to appear in the named font, if a matching font is found. Returns |None| if the typeface is currently inherited from the theme. Setting it to |None| removes any override of the theme typeface. N)rlatintypeface)r*rr-r-r.r^z Font.namecCs*|dur |jdS|j}||_dSr$)r _remove_latinget_or_add_latinr)r*r=rr-r-r.rks   Length | NonecCs|jj}|dur dSt|S)a@Indicates the font height in English Metric Units (EMU). Read/write. |None| indicates the font size should be inherited from its style hierarchy, such as a placeholder or document defaults (usually 18pt). |Length| is a subclass of |int| having properties for convenient conversion into points or other length units. Likewise, the :class:`pptx.util.Pt` class allows convenient specification of point values:: >>> font.size = Pt(24) >>> font.size 304800 >>> font.size.pt 24.0 N)rszr)r*rr-r-r.rssz Font.sizerZcCs*|dur d|j_dSt|j}||j_dSr$)rrr centipoints)r*rZrr-r-r.rs   %bool | MSO_TEXT_UNDERLINE_TYPE | NonecCs(|jj}|tjur dS|tjurdS|S)aIndicaties the underline setting for this font. Value is |True|, |False|, |None|, or a member of the :ref:`MsoTextUnderlineType` enumeration. |None| is the default and indicates the underline setting should be inherited from the style hierarchy, such as from a placeholder. |True| indicates single underline. |False| indicates no underline. Other settings such as double and wavy underlining are indicated with members of the :ref:`MsoTextUnderlineType` enumeration. FT)rur r| SINGLE_LINE)r*rr-r-r. underlines   zFont.underlinecCs*|durtj}n|durtj}||j_dS)NTF)r rr|r'rr?r-r-r.rs  )rrrr)r5r)r5r)r5r)r=rr5rP)r=rPr5r)rZr)r5r)r=r)rrrrr&rrLrrrrrNrrrrrr-r-r+r.rs>             rcs`eZdZdZdfdd Zedd d Zejdd d ZdddZedddZ ddZ Z S) _Hyperlinkz{Text run hyperlink object. Corresponds to `a:hlinkClick` child element of the run's properties element (`a:rPr`). rrr#r ctt||||_dSr$)r%rr&r)r*rr#r+r-r.r& z_Hyperlink.__init__r5rPcCs|jdurdS|j|jjS)z{The URL of the hyperlink. Read/write. URL can be on http, https, mailto, or file scheme; others may work. N) _hlinkClickpart target_refrIdr;r-r-r.addresss z_Hyperlink.addressurlcCs(|jdur ||r||dSdSr$)r_remove_hlinkClick_add_hlinkClick)r*rr-r-r.rs rIcCs$|jj|tjdd}|j|dS)NT) is_external)r relate_toRT HYPERLINKradd_hlinkClick)r*rrr-r-r.rsz_Hyperlink._add_hlinkClickCT_Hyperlink | NonecCr7r$)r hlinkClickr;r-r-r.rrz_Hyperlink._hlinkClickcCs,|jdusJ|j|jj|jdSr$)rrdrop_relrrrr;r-r-r.rsz_Hyperlink._remove_hlinkClick)rrr#r r)rrP)rrI)r5r) rrrrr&rrrrrrrr-r-r+r.rs    rcs(eZdZdZd6fdd Zdd Zd7d d Zed8ddZej d9ddZddZ ed:ddZ ed;ddZ e j dd dZ ed?d"d#Zed@d%d&Zej dAd'd&Zed@d(d)Zej dAd*d)ZedBd,d-Zej dCd/d-ZedDd1d2ZedEd4d5ZZS)Fr1z:Paragraph object. Not intended to be constructed directly.r3rr#r cs tt||||_|_dSr$)r%r1r&r'_p)r*r3r#r+r-r.r&sz_Paragraph.__init__cCs|jdS)z(Add line break at end of this paragraph.N)radd_brr;r-r-r.add_line_breaksz_Paragraph.add_line_breakr5_RuncCr/)z8Return a new run appended to the runs in this paragraph.)radd_rr)r*rr-r-r.add_run  z_Paragraph.add_runPP_PARAGRAPH_ALIGNMENT | NonecCr7)aHorizontal alignment of this paragraph. The value |None| indicates the paragraph should 'inherit' its effective value from its style hierarchy. Assigning |None| removes any explicit setting, causing its inherited value to be used. _pPralgnr;r-r-r. alignmentrz_Paragraph.alignmentr=cCr>r$rr?r-r-r.rr@cCs|jjD]}|j|q|S)zRemove all content from this paragraph. Paragraph properties are preserved. Content includes runs, line breaks, and fields. )r'rrC)r*rr-r-r.rEs z_Paragraph.clearrcCs t|jS)aJ|Font| object containing default character properties for the runs in this paragraph. These character properties override default properties inherited from parent objects such as the text frame the paragraph is contained in and they may be overridden by character properties set at the run level. )r_defRPrr;r-r-r.fonts z_Paragraph.fontrKcCr7)aIndentation level of this paragraph. Read-write. Integer in range 0..8 inclusive. 0 represents a top-level paragraph and is the default value. Indentation level is most commonly encountered in a bulleted list, as is found on a word bullet slide. rlvlr;r-r-r.levelrz_Paragraph.levelrcCr>r$r)r*rr-r-r.rr@int | float | Length | NonecCr)aThe space between baselines in successive lines of this paragraph. A value of |None| indicates no explicit value is assigned and its effective value is inherited from the paragraph's style hierarchy. A numeric value, e.g. `2` or `1.5`, 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. N)rpPr line_spacingr*rr-r-r.rs z_Paragraph.line_spacingcC|j}||_dSr$)rget_or_add_pPrrr*r=rr-r-r.r!rtuple[_Run, ...]crg)z#Sequence of runs in this paragraph.c3s|]}t|VqdSr$)r)rhrr;r-r.rn)sz"_Paragraph.runs..)rjr'r_lstr;r-r;r.runs&sz_Paragraph.runsrcCr)a{The spacing to appear between this paragraph and the subsequent paragraph. A value of |None| indicates no explicit value is assigned and its effective value is inherited from the paragraph's style hierarchy. |Length| objects provide convenience properties, such as `.pt` and `.inches`, that allow easy conversion to various length units. N)rr space_afterrr-r-r.r+s z_Paragraph.space_aftercCrr$)rrrrr-r-r.r9rcCr)ajThe spacing to appear between this paragraph and the prior paragraph. A value of |None| indicates no explicit value is assigned and its effective value is inherited from the paragraph's style hierarchy. |Length| objects provide convenience properties, such as `.pt` and `.cm`, that allow easy conversion to various length units. N)rr space_beforerr-r-r.r>rz_Paragraph.space_beforecCrr$)rrrrr-r-r.rKrrIcCsddd|jjDS)aTText of paragraph as a single string. Read/write. This value is formed by concatenating the text in each run and field making up the paragraph, adding a vertical-tab character (`"\v"`) for each line-break element (``, soft carriage-return) encountered. While the encoding of line-breaks as a vertical tab might be surprising at first, doing so is consistent with PowerPoint's clipboard copy behavior and allows a line-break to be distinguished from a paragraph boundary within the str return value. Assignment causes all content in the paragraph to be replaced. Each vertical-tab character (`"\v"`) in the assigned str is translated to a line-break, as is each line-feed character (`"\n"`). Contrast behavior of line-feed character in `TextFrame.text` setter. If line-feed characters are intended to produce new paragraphs, use `TextFrame.text` instead. Any other control characters in the assigned string are escaped as a hex representation like "_x001B_" (for ESC (ASCII 27) in this example). rQcsrlr$rm)rhrr-r-r.rncroz"_Paragraph.text..)rpr'rr;r-r-r.rRPsz_Paragraph.textrRcCs||j|dSr$)rEr'rsr*rRr-r-r.rResrcC |jS)zThe element that defines the default run properties for runs in this paragraph. Causes the element to be added if not present. )rget_or_add_defRPrr;r-r-r.rjryz_Paragraph._defRPrrcCr)zlContains the properties for this paragraph. Causes the element to be added if not present. )rrr;r-r-r.rrryz_Paragraph._pPr)r3rr#r )r5r)r5r)r=r)r5r)r5rK)rrK)r5r)r=r)r5rr)r=rrr)r5r)r5r)rrrrr&rrrrrrErrrrrrrRrrrr-r-r+r.r1sL                r1csXeZdZdZdfdd Zedd Zedd d ZeddZ e j dddZ Z S)rzCText run object. Corresponds to `a:r` child element in a paragraph.rrr#r crr$)r%rr&_r)r*rr#r+r-r.r&~rz _Run.__init__cCs|j}t|S)a`|Font| instance containing run-level character properties for the text in this run. Character properties can be and perhaps most often are inherited from parent objects such as the paragraph and slide layout the run is contained in. Only those specifically overridden at the run level are contained in the font object. )rrrrr-r-r.rs z _Run.fontr5rcCr/)a;Proxy for any `a:hlinkClick` element under the run properties element. Created on demand, the hyperlink object is available whether an `a:hlinkClick` element is present or not, and creates or deletes that element as appropriate in response to actions on its methods and attributes. )rrrrr-r-r. hyperlinks  z_Run.hyperlinkcCr7)abRead/write. A unicode string containing the text in this run. Assignment replaces all text in the run. The assigned value can be a 7-bit ASCII string, a UTF-8 encoded 8-bit string, or unicode. String values are converted to unicode assuming UTF-8 encoding. Any other control characters in the assigned string other than tab or newline are escaped as a hex representation. For example, ESC (ASCII 27) is escaped as "_x001B_". Contrast the behavior of `TextFrame.text` and `_Paragraph.text` with respect to line-feed and vertical-tab characters. rrRr;r-r-r.rRs z _Run.textrRrIcCr>r$rrr-r-r.rRr@)rrr#r )r5rr) rrrrr&rrrrrRrrr-r-r+r.r{s   rN)7r __future__rtypingrrr pptx.dml.fillr pptx.enum.dmlrpptx.enum.langrpptx.enum.textr r r pptx.opc.constantsr rpptx.oxml.simpletypesr Z pptx.shapesrZpptx.text.fontsrZpptx.text.layoutr pptx.utilrrrrrpptx.dml.colorrrrpptx.oxml.actionrpptx.oxml.textrrrrrZ pptx.typesrr r!objectrrr1rr-r-r-r.s6           u*)