text::pdf::page(3pm) [debian man page]

Text::PDF::Page(3pm)					User Contributed Perl Documentation				      Text::PDF::Page(3pm)

NAME

       Text::PDF::Page - Represents a PDF page, inherits from Text::PDF::Pages

DESCRIPTION

       Represents a page of output in PDF. It also keeps track of the content stream, any resources (such as fonts) being switched, etc.

       Page inherits from Pages due to a number of shared methods. They are really structurally quite different.

INSTANCE VARIABLES

       A page has various working variables:

       curstrm
	      The currently open stream

METHODS

       Text::PDF::Page->new($pdf, $parent, $index)

       Creates a new page based on a pages object (perhaps the root object).

       The page is also added to the parent at this point, so pages are ordered in a PDF document in the order in which they are created rather
       than in the order they are closed.

       Only the essential elements in the page dictionary are created here, all others are either optional or can be inherited.

       The optional index value indicates the index in the parent list that this page should be inserted (so that new pages need not be appended)

       $p->add($str)

       Adds the string to the currently active stream for this page. If no stream exists, then one is created and added to the list of streams for
       this page.

       The slightly cryptic name is an aim to keep it short given the number of times people are likely to have to type it.

       $p->ship_out($pdf)

       Ships the page out to the given output file context

perl v5.8.8							    2006-09-09						      Text::PDF::Page(3pm)

Text::PDF::Dict(3pm)					User Contributed Perl Documentation				      Text::PDF::Dict(3pm)

NAME

       Text::PDF::Dict - PDF Dictionaries and Streams. Inherits from PDF::Objind

INSTANCE VARIABLES

       There are various special instance variables which are used to look after, particularly, streams. Each begins with a space:

       stream Holds the stream contents for output

       streamfile
	      Holds the stream contents in an external file rather than in memory. This is not the same as a PDF file stream. The data is stored
	      in its unfiltered form.

       streamloc
	      If both ' stream' and ' streamfile' are empty, this indicates where in the source PDF the stream starts.

METHODS

       $d->outobjdeep($fh)

       Outputs the contents of the dictionary to a PDF file. This is a recursive call.

       It also outputs a stream if the dictionary has a stream element. If this occurs then this method will calculate the length of the stream
       and insert it into the stream's dictionary.

       $d->read_stream($force_memory)

       Reads in a stream from a PDF file. If the stream is greater than "PDF::Dict::mincache" (defaults to 32768) bytes to be stored, then the
       default action is to create a file for it somewhere and to use that file as a data cache. If $force_memory is set, this caching will not
       occur and the data will all be stored in the $self->{' stream'} variable.

       $d->val

       Returns the dictionary, which is itself.

       $d->copy($inpdf, $res, $unique, $outpdf, %opts)

       Copies an object. See Text::PDF::Objind::Copy() for details

perl v5.8.8							    2006-09-09						      Text::PDF::Dict(3pm)