@@ -1,5 +1,21 @@ module Prawn class Document + # A span is a special purpose bounding box that allows a column of + # elements to be positioned relative to the margin_box. + # + # Arguments: + # +width+:: The width of the column in PDF points + # + # Options: + # <tt>:position</tt>:: One of :left, :center, :right or an x offset + # + # This method is typically used for flowing a column of text from one + # page to the next. + # + # span(350, :position => :center) do + # text "Here's some centered text in a 350 point column. " * 100 + # end + # def span(width, options={}) Prawn.verify_options [:position], options original_position = self.y lib/prawn/document/span.rb @@ -15,14 +15,14 @@ module Prawn # JPG and PNG files are supported. # # Arguments: - # <tt>filename</tt>:: the path to the file to be embedded + # <tt>file</tt>:: path to file or an object that responds to #read # # Options: # <tt>:at</tt>:: the location of the top left corner of the image. # <tt>:position</tt>:: One of (:left, :center, :right) or an x-offset # <tt>:height</tt>:: the height of the image [actual height of the image] # <tt>:width</tt>:: the width of the image [actual width of the image] - # <tt>:scale</tt>:: scale the dimensions of the image proportionally + # <tt>:scale</tt>:: scale the dimensions of the image proportionally # # Prawn::Document.generate("image2.pdf", :page_layout => :landscape) do # pigs = "#{Prawn::BASEDIR}/data/images/pigs.jpg" @@ -36,6 +36,20 @@ module Prawn # proportionally. When both are provided, the image will be stretched to # fit the dimensions without maintaining the aspect ratio. # + # If instead of an explicit filename, an object with a read method is + # passed as +file+, you can embed images from IO objects and things + # that act like them (including Tempfiles and open-uri objects). + # + # require "open-uri" + # + # Prawn::Document.generate("remote_images.pdf") do + # image open("http://prawn.majesticseacreature.com/media/prawn_logo.png") + # end + # + # This method returns an image info object which can be used to check the + # dimensions of an image object if needed. + # (See also: Prawn::Images::PNG , Prawn::Images::JPG) + # def image(file, options={}) Prawn.verify_options [:at,:position, :height, :width, :scale], options lib/prawn/images.rb @@ -12,7 +12,7 @@ module Prawn module Images # A convenience class that wraps the logic for extracting the parts # of a PNG image that we need to embed them in a PDF - class JPG #:nodoc: + class JPG attr_reader :width, :height, :bits, :channels JPEG_SOF_BLOCKS = %W(\xc0 \xc1 \xc2 \xc3 \xc5 \xc6 \xc7 \xc9 \xca \xcb \xcd \xce \xcf) @@ -21,6 +21,7 @@ module Prawn # Process a new JPG image # # <tt>:data</tt>:: A string containing a full PNG file + # def initialize(data) data = StringIO.new(data.dup) lib/prawn/images/jpg.rb @@ -14,7 +14,7 @@ module Prawn module Images # A convenience class that wraps the logic for extracting the parts # of a PNG image that we need to embed them in a PDF - class PNG #:nodoc: + class PNG attr_reader :palette, :img_data, :transparency attr_reader :width, :height, :bits attr_reader :color_type, :compression_method, :filter_method @@ -23,6 +23,7 @@ module Prawn # Process a new PNG image # # <tt>:data</tt>:: A string containing a full PNG file + # def initialize(data) data = StringIO.new(data.dup) lib/prawn/images/png.rb db62a1a371964c8579bdf2e5052b98c6bab6b1b5 Gregory Brown gregory.t.brown@gmail.com http://github.com/sandal/prawn/commit/69ba7fa9435f0d803af4ff1fc99df4bde290bf80 69ba7fa9435f0d803af4ff1fc99df4bde290bf80 2008-10-17T12:12:27-07:00 2008-10-17T11:26:01-07:00 Paying the documentation dues 953db04394e13cc2d3a1a5223ebc6ae46664f07d Gregory Brown gregory.t.brown@gmail.com