CTS logo
hazy blue Catskill Mountains in distance

A Thought…

I guess I didn’t know that the Oscars were on tonight. I accidentally missed it. Had I known, I would’ve intentionally missed it…

   — online comment on the 2023 Oscars

NAME

PDF::Builder::Basic::PDF::Dict - PDF Dictionaries and Streams

Inherits from PDF::Builder::Basic::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

new

    $d = PDF::Builder::Basic::PDF->new()
Creates a new instance of a dictionary. The usual practice is to call PDFDict() instead.

type

    $type = $d->type($type)
Get/Set the standard Type key. It can be passed, and will return, a text value rather than a Name object.

filter

    @filters = $d->filter(@filters)
Get/Set one or more filters being used by the optional stream attached to the dictionary.

outobjdeep

    $d->outobjdeep($fh, $pdf)
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.

read_stream

    $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.

val

    $d->val()
Returns the dictionary, which is itself.

NAVIGATION LINKS

Up (Parents)

Master Index
PDF::Builder -- Facilitates the creation and modification of PDF files
PDF::Builder::Basic::PDF -- Various utilities and support routines

Siblings

PDF::Builder::Basic::PDF::Array -- Corresponds to a PDF array
PDF::Builder::Basic::PDF::Bool -- Holds the strings true or false
PDF::Builder::Basic::PDF::File -- Holds the trailers and cross-reference tables for a PDF file
PDF::Builder::Basic::PDF::Filter -- Abstract superclass for PDF stream filters
PDF::Builder::Basic::PDF::Literal -- Literal PDF Object
PDF::Builder::Basic::PDF::Name -- Stores PDF names (things beginning with /)
PDF::Builder::Basic::PDF::Null -- PDF Null type object
PDF::Builder::Basic::PDF::Number -- Numbers in PDF
PDF::Builder::Basic::PDF::Objind -- PDF indirect object reference
PDF::Builder::Basic::PDF::Page -- Represents a PDF page
PDF::Builder::Basic::PDF::Pages -- PDF pages hierarchical element
PDF::Builder::Basic::PDF::String -- PDF String type objects
PDF::Builder::Basic::PDF::Utils -- Utility functions for PDF library

 

All content © copyright 2005 – 2025 by Catskill Technology Services, LLC.
All rights reserved.
Note that Third Party software (whether Open Source or proprietary) on this site remains under the copyright and license of its owners. Catskill Technology Services, LLC does not claim copyright over such software.

 

This page is https://www.catskilltech.com/Documentation/PDF/Builder/Basic/PDF/Dict.html

Search Quotations database.

Last updated Sat, 09 Dec 2023 at 10:59 PM

Valid HTML 5

Tue, 11 Feb 2025 at 1:42 AM EST