U Nf: @sdZdZdZddlmZmZmZmZmZddl m Z m Z ddl m Z dd lmZmZmZmZmZmZmZmZmZmZdd lmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#dd l$m%Z%dd l&m'Z'dd l(m)Z)ddl m*Z*m+Z+m,Z,m-Z-m.Z.ddl/m0Z0e eddddZ1dzHImplementation of generic PDF objects (dictionary, number, string, ...).zMathieu Fenniakzbiziqe@mathieu.fenniak.net)DictListOptionalTupleUnion) StreamTypedeprecate_with_replacement)OutlineFontFlag) BooleanObjectByteStringObject FloatObjectIndirectObject NameObject NullObject NumberObject PdfObjectTextStringObjectencode_pdfdocencoding) ArrayObject ContentStreamDecodedStreamObject DestinationDictionaryObjectEncodedStreamObjectField StreamObject TreeObject read_object)Fit) OutlineItemRectangleObject)create_string_objectdecode_pdfdocencoding hex_to_rgbread_hex_string_from_streamread_string_from_stream)ViewerPreferences)rr )streamreturncCstdddt|S)z,Deprecated, use read_hex_string_from_stream.readHexStringFromStreamr'4.0.0)r r')r*r.:/tmp/pip-unpacked-wheel-zevpxvmc/pypdf/generic/__init__.pyr,Is r,N)r*forced_encodingr+cCstdddt||S)z(Deprecated, use read_string_from_stream.readStringFromStreamr(r-)r r()r*r0r.r.r/r1Ss r1)stringr0r+cCstdddt||S)z%Deprecated, use create_string_object.createStringObjectr$r-)r r$)r2r0r.r.r/r3^s r3c @s4eZdZdZddlmZed-eeee e e e ffe e e e dddZed.e eeee e e e ffe e e e e ee ee e d ddZeddddeeee e e e ffe ee e e dddZed/ee e fee e feeee e e e ffe ee e dddZeeee e fe dddZed0eeee e e e ffee e dddZedd eeee e e e ffee e d!d"d#Zed1eeee e e e ffee e dd$d%Zeeee e fe dd&d'Zd(d)lmZedddefeeee e e e ffeeee ee ee d*d+d,ZdS)2AnnotationBuilderz The AnnotationBuilder is deprecated. Instead, use the annotation classes in pypdf.annotations. See `adding PDF annotations <../user/adding-pdf-annotations.html>`_ for it's usage combined with PdfWriter. rr"Fr)recttextopenflagsr+cCs(tdddddlm}|||||dS)a^ Add text annotation. Args: rect: array of four integers ``[xLL, yLL, xUR, yUR]`` specifying the clickable rectangular area text: The text that is added to the document open: flags: Returns: A dictionary object representing the annotation. AnnotationBuilder.textzpypdf.annotations.Textr-r)Text)r5r6r7r8)r annotationsr:)r5r6r7r8r:r.r.r/r6vs r9 Helvetica14pt000000ffffff) r6r5fontbolditalic font_size font_color border_colorbackground_colorr+c Cs2tdddddlm} | |||||||||d S)a@ Add text in a rectangle to a page. Args: text: Text to be added rect: array of four integers ``[xLL, yLL, xUR, yUR]`` specifying the clickable rectangular area font: Name of the Font, e.g. 'Helvetica' bold: Print the text in bold italic: Print the text in italic font_size: How big the text will be, e.g. '14pt' font_color: Hex-string for the color, e.g. cdcdcd border_color: Hex-string for the border color, e.g. cdcdcd. Use ``None`` for no border. background_color: Hex-string for the background of the annotation, e.g. cdcdcd. Use ``None`` for transparent background. Returns: A dictionary object representing the annotation. AnnotationBuilder.free_textzpypdf.annotations.FreeTextr-r)FreeText) r6r5r@rArBrCrDrFrE)r r;rH) r6r5r@rArBrCrDrErFrHr.r.r/ free_texts"  rGN)r8parentr7)r5r8rJr7r+cCs0tdddddlm}||||d}||_|S)a Add a popup to the document. Args: rect: Specifies the clickable rectangular area as `[xLL, yLL, xUR, yUR]` flags: 1 - invisible, 2 - hidden, 3 - print, 4 - no zoom, 5 - no rotate, 6 - no view, 7 - read only, 8 - locked, 9 - toggle no view, 10 - locked contents open: Whether the popup should be shown directly (default is False). parent: The contents of the popup. Create this via the AnnotationBuilder. Returns: A dictionary object representing the annotation. AnnotationBuilder.popupzpypdf.annotations.Popupr-r)Popup)r5r7rJ)r r;rLr8)r5r8rJr7rLpopupr.r.r/rMs rK)p1p2r5r6 title_barr+cCs*tdddddlm}||||||dS)a Draw a line on the PDF. Args: p1: First point p2: Second point rect: array of four integers ``[xLL, yLL, xUR, yUR]`` specifying the clickable rectangular area text: Text to be displayed as the line annotation title_bar: Text to be displayed in the title bar of the annotation; by convention this is the name of the author Returns: A dictionary object representing the annotation. AnnotationBuilder.linezpypdf.annotations.Liner-r)Line)rOrPr5r6rQ)r r;rS)rOrPr5r6rQrSr.r.r/lines rR)verticesr+cCs"tdddddlm}||dS)z Draw a polyline on the PDF. Args: vertices: Array specifying the vertices (x, y) coordinates of the poly-line. Returns: A dictionary object representing the annotation. AnnotationBuilder.polylinezpypdf.annotations.PolyLiner-r)PolyLinerU)r r;rW)rUrWr.r.r/polylines  rV)r5interiour_colorr+cCs$tdddddlm}|||dS)a Draw a rectangle on the PDF. This method uses the /Square annotation type of the PDF format. Args: rect: array of four integers ``[xLL, yLL, xUR, yUR]`` specifying the clickable rectangular area interiour_color: None or hex-string for the color, e.g. cdcdcd If None is used, the interiour is transparent. Returns: A dictionary object representing the annotation. AnnotationBuilder.rectanglezpypdf.annotations.Rectangler-r) Rectangler5rZ)r r;r\)r5rZr\r.r.r/ rectangles r[Zff0000)highlight_color)r5 quad_pointsr_r+cCs&tdddddlm}||||dS)a Add a highlight annotation to the document. Args: rect: Array of four integers ``[xLL, yLL, xUR, yUR]`` specifying the highlighted area quad_points: An ArrayObject of 8 FloatObjects. Must match a word or a group of words, otherwise no highlight will be shown. highlight_color: The color used for the highlight. Returns: A dictionary object representing the annotation. AnnotationBuilder.highlightzpypdf.annotations.Highlightr-r) Highlight)r5r`r_)r r;rb)r5r`r_rbr.r.r/ highlight2s racCs$tdddddlm}|||dS)a Draw a rectangle on the PDF. This method uses the /Circle annotation type of the PDF format. Args: rect: array of four integers ``[xLL, yLL, xUR, yUR]`` specifying the bounding box of the ellipse interiour_color: None or hex-string for the color, e.g. cdcdcd If None is used, the interiour is transparent. Returns: A dictionary object representing the annotation. AnnotationBuilder.ellipsezpypdf.annotations.Ellipser-r)Ellipser])r r;re)r5rZrer.r.r/ellipseOs rdcCs"tdddddlm}||dS)NAnnotationBuilder.polygonzpypdf.annotations.Polygonr-r)PolygonrX)r r;rh)rUrhr.r.r/polygonis rgr ) DEFAULT_FIT)r5borderurltarget_page_indexfitr+cCs*tdddddlm}||||||dS)a( Add a link to the document. The link can either be an external link or an internal link. An external link requires the URL parameter. An internal link requires the target_page_index, fit, and fit args. Args: rect: array of four integers ``[xLL, yLL, xUR, yUR]`` specifying the clickable rectangular area border: if provided, an array describing border-drawing properties. See the PDF spec for details. No border will be drawn if this argument is omitted. - horizontal corner radius, - vertical corner radius, and - border width - Optionally: Dash url: Link to a website (if you want to make an external link) target_page_index: index of the page to which the link should go (if you want to make an internal link) fit: Page fit or 'zoom' option. Returns: A dictionary object representing the annotation. AnnotationBuilder.linkzpypdf.annotations.Linkr-r)Link)r5rkrlrmrn)r r;rp)r5rkrlrmrnrpr.r.r/linkts" ro)Fr)r<FFr=r>r>r?)rNN)N)N)__name__ __module__ __qualname____doc__Zgeneric._rectangler# staticmethodrrfloatstrboolintrr6rrIrMrTrrYr^rrcrfri_fitrjr rqr.r.r.r/r4js 0#   r4r rrrrrrrr r PAGE_FITrrrrrrrr#rrr)r!r rr$rr%r&r'r()N)N);ru __author____author_email__typingrrrrr_utilsrr constantsr _baser r rrrrrrrrZ_data_structuresrrrrrrrrrrr{r Z_outliner!Z _rectangler#r$r%r&r'r(Z _viewerprefr)r,rxrzr1bytesr3rnr|r4__all__r.r.r.r/s 0 0        >