pdf::api2::basic::pdf::page(3pm) [debian man page]

PDF::API2::Basic::PDF::Page(3pm)			User Contributed Perl Documentation			  PDF::API2::Basic::PDF::Page(3pm)

NAME

       PDF::API2::Basic::PDF::Page - Represents a PDF page, inherits from PDF::API2::Basic::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

   PDF::API2::Basic::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.14.2							    2011-03-10					  PDF::API2::Basic::PDF::Page(3pm)

PDF::API2::Basic::PDF::Filter(3pm)			User Contributed Perl Documentation			PDF::API2::Basic::PDF::Filter(3pm)

NAME

       PDF::API2::Basic::PDF::Filter - Abstract superclass for PDF stream filters

SYNOPSIS

	   $f = PDF::API2::Basic::PDF::Filter->new;
	   $str = $f->outfilt($str, 1);
	   print OUTFILE $str;

	   while (read(INFILE, $dat, 4096))
	   { $store .= $f->infilt($dat, 0); }
	   $store .= $f->infilt("", 1);

DESCRIPTION

       A Filter object contains state information for the process of outputting and inputting data through the filter. The precise state
       information stored is up to the particular filter and may range from nothing to whole objects created and destroyed.

       Each filter stores different state information for input and output and thus may handle one input filtering process and one output
       filtering process at the same time.

METHODS

   PDF::API2::Basic::PDF::Filter->new
       Creates a new filter object with empty state information ready for processing data both input and output.

   $dat = $f->infilt($str, $isend)
       Filters from output to input the data. Notice that $isend == 0 implies that there is more data to come and so following it $f may contain
       state information (usually due to the break-off point of $str not being tidy). Subsequent calls will incorporate this stored state
       information.

       $isend == 1 implies that there is no more data to follow. The final state of $f will be that the state information is empty. Error messages
       are most likely to occur here since if there is required state information to be stored following this data, then that would imply an error
       in the data.

   $str = $f->outfilt($dat, $isend)
       Filter stored data ready for output. Parallels "infilt".

NAME

       PDF::API2::Basic::PDF::ASCII85Decode - Ascii85 filter for PDF streams. Inherits from PDF::API2::Basic::PDF::Filter

NAME

       PDF::API2::Basic::PDF::RunLengthDecode - Run Length encoding filter for PDF streams. Inherits from PDF::API2::Basic::PDF::Filter

NAME

       PDF::API2::Basic::PDF::ASCIIHexDecode - Ascii Hex encoding (very inefficient) for PDF streams.  Inherits from PDF::API2::Basic::PDF::Filter

perl v5.14.2							    2011-03-10					PDF::API2::Basic::PDF::Filter(3pm)