hexapdf 0.17.1 → 0.17.2

data/examples/019-acro_form.rb

@@ -0,0 +1,88 @@
+# # PDF Forms
+#
+# PDF files can be used for interactive forms, containing various types of form
+# fields. HexaPDF supports the creation and processing of these forms.
+#
+# This example show-cases how to create the various form field types and their
+# possible standard appearances.
+#
+# Usage:
+# : `ruby acro_form.rb`
+#
+
+require 'hexapdf'
+
+doc = HexaPDF::Document.new
+page = doc.pages.add
+canvas = page.canvas
+
+canvas.font("Helvetica", size: 36)
+canvas.text("Form Example", at: [50, 750])
+form = doc.acro_form(create: true)
+
+canvas.font_size(16)
+canvas.text("Check boxes", at: [50, 650])
+[:check, :circle, :cross, :diamond, :square, :star].each_with_index do |symbol, index|
+  cb = form.create_check_box("Checkbox #{index}")
+  widget = cb.create_widget(page, Rect: [200 + 50 * index, 640, 240 + 50 * index, 680])
+  widget.background_color(1 - 0.05 * index)
+  widget.marker_style(style: symbol, color: [0.166 * index, 0, 1 - 0.166 * index],
+                      size: 7 * index)
+  cb.field_value = true
+end
+
+canvas.text("Radio buttons", at: [50, 550])
+rb = form.create_radio_button("Radio")
+[:check, :circle, :cross, :diamond, :square, :star].each_with_index do |symbol, index|
+  widget = rb.create_widget(page, value: :"button#{index}",
+                            Rect: [200 + 50 * index, 540, 240 + 50 * index, 580])
+  widget.background_color(1 - 0.05 * index)
+  widget.marker_style(style: symbol, color: [0.166 * index, 0, 1 - 0.166 * index],
+                      size: 7 * index)
+end
+rb.field_value = :button0
+
+canvas.text("Text fields", at: [50, 450])
+
+canvas.text("Single line", at: [70, 420])
+tx = form.create_text_field("Single Line", font_size: 16)
+widget = tx.create_widget(page, Rect: [200, 415, 500, 435])
+tx.field_value = "A sample test string!"
+
+canvas.text("Multiline", at: [70, 390])
+tx = form.create_multiline_text_field("Multiline", font_size: 0, align: :right)
+widget = tx.create_widget(page, Rect: [200, 325, 500, 405])
+widget.border_style(color: 0, width: 1)
+tx.field_value = "A sample test string! " * 30 + "\nNew line\n\nAnother line"
+
+canvas.text("Password", at: [70, 300])
+tx = form.create_password_field("Password", font_size: 16)
+widget = tx.create_widget(page, Rect: [200, 295, 500, 315])
+
+canvas.text("File select", at: [70, 270])
+tx = form.create_file_select_field("File Select", font_size: 16)
+widget = tx.create_widget(page, Rect: [200, 265, 500, 285])
+tx.field_value = "path/to/file.pdf"
+
+canvas.text("Comb", at: [70, 240])
+tx = form.create_comb_text_field("Comb field", max_chars: 10, font_size: 16, align: :center)
+widget = tx.create_widget(page, Rect: [200, 220, 500, 255])
+widget.border_style(color: [30, 128, 0], width: 1)
+tx.field_value = 'Hello'
+
+canvas.text("Combo Box", at: [50, 170])
+cb = form.create_combo_box("Combo Box", font_size: 12, editable: true,
+                           option_items: ['Value 1', 'Another value', 'Choose me!'])
+widget = cb.create_widget(page, Rect: [200, 150, 500, 185])
+widget.border_style(width: 1)
+cb.field_value = 'Another value'
+
+canvas.text("List Box", at: [50, 120])
+lb = form.create_list_box("List Box", font_size: 15, align: :center, multi_select: true,
+                         option_items: 1.upto(7).map {|i| "Value #{i}" })
+widget = lb.create_widget(page, Rect: [200, 50, 500, 135])
+widget.border_style(width: 1)
+lb.list_box_top_index = 1
+lb.field_value = ['Value 6', 'Value 2']
+
+doc.write('acro_form.pdf', optimize: true)

data/lib/hexapdf/content/graphic_object/endpoint_arc.rb

@@ -43,6 +43,15 @@ module HexaPDF
       # This class describes an elliptical arc in endpoint parameterization. It allows one to
       # generate an arc from the current point to a given point, similar to Content::Canvas#line_to.
       #
+      # This graphic object is registered under the :endpoint_arc key for use with the
+      # HexaPDF::Content::Canvas class.
+      #
+      # Examples:
+      #
+      #   #>pdf-center
+      #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 10).stroke
+      #   arc.move_to(0, 0).draw(canvas).stroke    # or: canvas.draw(arc).stroke
+      #
       # See: GraphicObject::Arc, ARC - https://www.w3.org/TR/SVG/implnote.html#ArcImplementationNotes
       class EndpointArc
 
@@ -58,29 +67,86 @@ module HexaPDF
         end
 
         # x-coordinate of endpoint
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 20)
+        #   canvas.move_to(0, 0).draw(arc).stroke
+        #   canvas.stroke_color("red").move_to(0, 0).draw(arc, x: -50).stroke
         attr_reader :x
 
         # y-coordinate of endpoint
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 20)
+        #   canvas.move_to(0, 0).draw(arc).stroke
+        #   canvas.stroke_color("red").move_to(0, 0).draw(arc, y: -20).stroke
         attr_reader :y
 
         # Length of semi-major axis
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 20)
+        #   canvas.move_to(0, 0).draw(arc).stroke
+        #   canvas.stroke_color("red").move_to(0, 0).draw(arc, a: 40).stroke
         attr_reader :a
 
         # Length of semi-minor axis
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 20)
+        #   canvas.move_to(0, 0).draw(arc).stroke
+        #   canvas.stroke_color("red").move_to(0, 0).draw(arc, b: 50).stroke
         attr_reader :b
 
         # Inclination in degrees of semi-major axis in respect to x-axis
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 20)
+        #   canvas.move_to(0, 0).draw(arc).stroke
+        #   canvas.stroke_color("red").move_to(0, 0).draw(arc, inclination: 45).stroke
         attr_reader :inclination
 
         # Large arc choice - if +true+ use the large arc (i.e. the one spanning more than 180
         # degrees), else the small arc
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 20)
+        #   canvas.move_to(0, 0).draw(arc).stroke
+        #   canvas.stroke_color("red").move_to(0, 0).draw(arc, large_arc: false, clockwise: true).stroke
         attr_reader :large_arc
 
         # Direction of arc - if +true+ in clockwise direction, else in counterclockwise direction
+        #
+        # This is needed, for example, when filling paths using the nonzero winding number rule to achieve
+        # different effects.
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   arc = canvas.graphic_object(:endpoint_arc, x: 50, y: 20, a: 30, b: 20)
+        #   canvas.move_to(0, 0).draw(arc).stroke
+        #   canvas.stroke_color("red").move_to(0, 0).draw(arc, clockwise: true).stroke
         attr_reader :clockwise
 
         # Creates an endpoint arc with default values x=0, y=0, a=0, b=0, inclination=0,
         # large_arc=true, clockwise=false (a line to the origin).
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   canvas.move_to(30, 30).draw(:endpoint_arc).stroke
         def initialize
           @x = @y = 0
           @a = @b = 0

data/lib/hexapdf/content/graphic_object/geom2d.rb

@@ -57,9 +57,22 @@ module HexaPDF
         attr_accessor :object
 
         # The radius to use when drawing Geom2D::Point objects; defaults to 1
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   canvas.draw(:geom2d, object: ::Geom2D::Point(0, 0))
+        #   canvas.draw(:geom2d, object: ::Geom2D::Point(50, 0), point_radius: 5)
         attr_accessor :point_radius
 
         # Specifies whether only paths should be drawn or if they should be stroked/filled too
+        # (default).
+        #
+        # Examples:
+        #
+        #   #>pdf-center
+        #   canvas.draw(:geom2d, object: ::Geom2D::Segment([0, 0], [0, 50]))
+        #   canvas.draw(:geom2d, object: ::Geom2D::Segment([0, 0], [50, 0]), path_only: true)
         attr_accessor :path_only
 
         # Creates a Geom2D drawing support object.

data/lib/hexapdf/version.rb

@@ -37,6 +37,6 @@
 module HexaPDF
 
   # The version of HexaPDF.
-  VERSION = '0.17.1'
+  VERSION = '0.17.2'
 
 end

data/test/data/minimal.pdf

@@ -0,0 +1,44 @@
+%PDF-1.2
+%����
+1 0 obj
+<< /Pages 2 0 R /Type /Catalog >>
+endobj
+2 0 obj
+<< /Count 1 /Kids [ 3 0 R ] /MediaBox [ 0 0 612 446 ] /Type /Pages >>
+endobj
+3 0 obj
+<< /Contents 4 0 R /Parent 2 0 R /Resources 5 0 R /Type /Page >>
+endobj
+4 0 obj
+<< /Length 51 >>
+stream
+BT
+/F1 24 Tf
+1 0 0 1 260 254 Tm
+(Hello World)Tj
+ET
+endstream
+endobj
+5 0 obj
+<< /Font << /F1 6 0 R >> /ProcSet [ /PDF /Text ] >>
+endobj
+6 0 obj
+<< /BaseFont /Helvetica /Name /F1 /Subtype /Type1 /Type /Font >>
+endobj
+7 0 obj
+<</ModDate (D:20150409164600)>>
+endobj
+xref
+0 8
+0000000000 65535 f 
+0000000015 00000 n 
+0000000064 00000 n 
+0000000149 00000 n 
+0000000229 00000 n 
+0000000329 00000 n 
+0000000396 00000 n 
+0000000476 00000 n 
+trailer << /Root 1 0 R /Info 7 0 R /Size 8 /ID [<6790ffa610024e78369114311fc0df96><6790ffa610024e78369114311fc0df96>] >>
+startxref
+523
+%%EOF

data/test/data/standard-security-handler/README

@@ -0,0 +1,9 @@
+These files have been created by encrypting the minimal.pdf file.
+The used encryption algorithm as well as the key length is encoded
+in the files name.
+
+The prefix shows which if any password was used:
+* nopwd: No password was set.
+* userpwd: An user password of 'uhexapdf' has been set.
+* ownerpwd: An owner password of 'ohexapdf' has been set.
+* bothpwd: Both the above user and owner passwords have been set.

data/test/data/standard-security-handler/bothpwd-aes-128bit-V4.pdf

@@ -0,0 +1,44 @@
+%PDF-1.6
+%����
+1 0 obj
+<< /Pages 3 0 R /Type /Catalog >>
+endobj
+2 0 obj
+<< /ModDate <b4286731bb75a1fb638cb333dfba06afb0e6e5e4f9b5229e8561312123942a87ee51ce88cecfa5ebfc6c4e6dd107ecb6> >>
+endobj
+3 0 obj
+<< /Count 1 /Kids [ 4 0 R ] /MediaBox [ 0 0 612 446 ] /Type /Pages >>
+endobj
+4 0 obj
+<< /Contents 5 0 R /Parent 3 0 R /Resources 6 0 R /Type /Page >>
+endobj
+5 0 obj
+<< /Length 80 >>
+stream
+��=�����	����3&���m���L
+F}�&���o�}�����ɱH+L9�c������3��8�6�[�3d�q�Q���r�Iendstream
+endobj
+6 0 obj
+<< /Font << /F1 7 0 R >> /ProcSet [ /PDF /Text ] >>
+endobj
+7 0 obj
+<< /BaseFont /Helvetica /Name /F1 /Subtype /Type1 /Type /Font >>
+endobj
+8 0 obj
+<< /CF << /StdCF << /AuthEvent /DocOpen /CFM /AESV2 /Length 16 >> >> /Filter /Standard /Length 128 /O <1517aad6ec33e7aaa17972b91854f2f7c05c11fc7fcafe7df725ffcfd4c55705> /P -4 /R 4 /StmF /StdCF /StrF /StdCF /U <6ccfb47c809a4bab70d578d957cee8240122456a91bae5134273a6db134c87c4> /V 4 >>
+endobj
+xref
+0 9
+0000000000 65535 f 
+0000000015 00000 n 
+0000000064 00000 n 
+0000000193 00000 n 
+0000000278 00000 n 
+0000000358 00000 n 
+0000000487 00000 n 
+0000000554 00000 n 
+0000000634 00000 n 
+trailer << /Info 2 0 R /Root 1 0 R /Size 9 /ID [<6790ffa610024e78369114311fc0df96><dfcc7658b36e2ba5673af5e16cf91f4e>] /Encrypt 8 0 R >>
+startxref
+933
+%%EOF

data/test/data/standard-security-handler/bothpwd-arc4-128bit-V2.pdf

@@ -0,0 +1,43 @@
+%PDF-1.4
+%����
+1 0 obj
+<< /Pages 3 0 R /Type /Catalog >>
+endobj
+2 0 obj
+<< /ModDate <a4edf0aa882dd1e784a1f0d956592496> >>
+endobj
+3 0 obj
+<< /Count 1 /Kids [ 4 0 R ] /MediaBox [ 0 0 612 446 ] /Type /Pages >>
+endobj
+4 0 obj
+<< /Contents 5 0 R /Parent 3 0 R /Resources 6 0 R /Type /Page >>
+endobj
+5 0 obj
+<< /Length 51 >>
+stream
+��&X*�2�Р#�b&�
 �X\4t��=���~YCa�4��K�v�l���endstream
+endobj
+6 0 obj
+<< /Font << /F1 7 0 R >> /ProcSet [ /PDF /Text ] >>
+endobj
+7 0 obj
+<< /BaseFont /Helvetica /Name /F1 /Subtype /Type1 /Type /Font >>
+endobj
+8 0 obj
+<< /Filter /Standard /Length 128 /O <1517aad6ec33e7aaa17972b91854f2f7c05c11fc7fcafe7df725ffcfd4c55705> /P -4 /R 3 /U <6ccfb47c809a4bab70d578d957cee8240122456a91bae5134273a6db134c87c4> /V 2 >>
+endobj
+xref
+0 9
+0000000000 65535 f 
+0000000015 00000 n 
+0000000064 00000 n 
+0000000129 00000 n 
+0000000214 00000 n 
+0000000294 00000 n 
+0000000394 00000 n 
+0000000461 00000 n 
+0000000541 00000 n 
+trailer << /Info 2 0 R /Root 1 0 R /Size 9 /ID [<6790ffa610024e78369114311fc0df96><4b0eee51689dcb9ba602518b54b8c48d>] /Encrypt 8 0 R >>
+startxref
+748
+%%EOF

data/test/data/standard-security-handler/bothpwd-arc4-128bit-V4.pdf

@@ -0,0 +1,43 @@
+%PDF-1.5
+%����
+1 0 obj
+<< /Pages 3 0 R /Type /Catalog >>
+endobj
+2 0 obj
+<< /ModDate <a4edf0aa882dd1e784a1f0d956592496> >>
+endobj
+3 0 obj
+<< /Count 1 /Kids [ 4 0 R ] /MediaBox [ 0 0 612 446 ] /Type /Pages >>
+endobj
+4 0 obj
+<< /Contents 5 0 R /Parent 3 0 R /Resources 6 0 R /Type /Page >>
+endobj
+5 0 obj
+<< /Length 51 >>
+stream
+��&X*�2�Р#�b&�
 �X\4t��=���~YCa�4��K�v�l���endstream
+endobj
+6 0 obj
+<< /Font << /F1 7 0 R >> /ProcSet [ /PDF /Text ] >>
+endobj
+7 0 obj
+<< /BaseFont /Helvetica /Name /F1 /Subtype /Type1 /Type /Font >>
+endobj
+8 0 obj
+<< /CF << /StdCF << /AuthEvent /DocOpen /CFM /V2 /Length 16 >> >> /Filter /Standard /Length 128 /O <1517aad6ec33e7aaa17972b91854f2f7c05c11fc7fcafe7df725ffcfd4c55705> /P -4 /R 4 /StmF /StdCF /StrF /StdCF /U <6ccfb47c809a4bab70d578d957cee8240122456a91bae5134273a6db134c87c4> /V 4 >>
+endobj
+xref
+0 9
+0000000000 65535 f 
+0000000015 00000 n 
+0000000064 00000 n 
+0000000129 00000 n 
+0000000214 00000 n 
+0000000294 00000 n 
+0000000394 00000 n 
+0000000461 00000 n 
+0000000541 00000 n 
+trailer << /Info 2 0 R /Root 1 0 R /Size 9 /ID [<6790ffa610024e78369114311fc0df96><c076b76a546e168a79166606212af08f>] /Encrypt 8 0 R >>
+startxref
+837
+%%EOF

data/test/data/standard-security-handler/nopwd-aes-128bit-V4.pdf

@@ -0,0 +1,43 @@
+%PDF-1.6
+%����
+1 0 obj
+<< /Pages 3 0 R /Type /Catalog >>
+endobj
+2 0 obj
+<< /ModDate <fbf7060c68ac30939db362469e7f0e1dde4c372fe75fb33db8f1f1d1cbde1d5448e3cf2279e902e3da77a6dbfe67a1e2> >>
+endobj
+3 0 obj
+<< /Count 1 /Kids [ 4 0 R ] /MediaBox [ 0 0 612 446 ] /Type /Pages >>
+endobj
+4 0 obj
+<< /Contents 5 0 R /Parent 3 0 R /Resources 6 0 R /Type /Page >>
+endobj
+5 0 obj
+<< /Length 80 >>
+stream
+�L���j�
+endobj
+6 0 obj
+<< /Font << /F1 7 0 R >> /ProcSet [ /PDF /Text ] >>
+endobj
+7 0 obj
+<< /BaseFont /Helvetica /Name /F1 /Subtype /Type1 /Type /Font >>
+endobj
+8 0 obj
+<< /CF << /StdCF << /AuthEvent /DocOpen /CFM /AESV2 /Length 16 >> >> /Filter /Standard /Length 128 /O <36451bd39d753b7c1d10922c28e6665aa4f3353fb0348b536893e3b1db5c579b> /P -4 /R 4 /StmF /StdCF /StrF /StdCF /U <21b497bba6ef18247f972715de1d12780122456a91bae5134273a6db134c87c4> /V 4 >>
+endobj
+xref
+0 9
+0000000000 65535 f 
+0000000015 00000 n 
+0000000064 00000 n 
+0000000193 00000 n 
+0000000278 00000 n 
+0000000358 00000 n 
+0000000487 00000 n 
+0000000554 00000 n 
+0000000634 00000 n 
+trailer << /Info 2 0 R /Root 1 0 R /Size 9 /ID [<6790ffa610024e78369114311fc0df96><0995393fccfd6be04530deefef6eaafd>] /Encrypt 8 0 R >>
+startxref
+933
+%%EOF

data/test/data/standard-security-handler/nopwd-arc4-128bit-V2.pdf

@@ -0,0 +1,43 @@
+%PDF-1.4
+%����
+1 0 obj
+<< /Pages 3 0 R /Type /Catalog >>
+endobj
+2 0 obj
+<< /ModDate <05e6011e1e6068218845d13117a2ff4a> >>
+endobj
+3 0 obj
+<< /Count 1 /Kids [ 4 0 R ] /MediaBox [ 0 0 612 446 ] /Type /Pages >>
+endobj
+4 0 obj
+<< /Contents 5 0 R /Parent 3 0 R /Resources 6 0 R /Type /Page >>
+endobj
+5 0 obj
+<< /Length 51 >>
+stream
+S�ޣg����S�U��;�㇟�i���g�Fe�<���5�q?��^#��ڄOendstream
+endobj
+6 0 obj
+<< /Font << /F1 7 0 R >> /ProcSet [ /PDF /Text ] >>
+endobj
+7 0 obj
+<< /BaseFont /Helvetica /Name /F1 /Subtype /Type1 /Type /Font >>
+endobj
+8 0 obj
+<< /Filter /Standard /Length 128 /O <36451bd39d753b7c1d10922c28e6665aa4f3353fb0348b536893e3b1db5c579b> /P -4 /R 3 /U <21b497bba6ef18247f972715de1d12780122456a91bae5134273a6db134c87c4> /V 2 >>
+endobj
+xref
+0 9
+0000000000 65535 f 
+0000000015 00000 n 
+0000000064 00000 n 
+0000000129 00000 n 
+0000000214 00000 n 
+0000000294 00000 n 
+0000000394 00000 n 
+0000000461 00000 n 
+0000000541 00000 n 
+trailer << /Info 2 0 R /Root 1 0 R /Size 9 /ID [<6790ffa610024e78369114311fc0df96><4faaca305306e77695ef10973458e3e4>] /Encrypt 8 0 R >>
+startxref
+748
+%%EOF