1PDF::API2::Basic::PDF::UDsiecrt(C3o)ntributed Perl DocumPeDnFt:a:tAiPoIn2::Basic::PDF::Dict(3)
2
3
4
6 PDF::API2::Basic::PDF::Dict - PDF Dictionaries and Streams. Inherits
7 from PDF::Objind
8
10 There are various special instance variables which are used to look
11 after, particularly, streams. Each begins with a space:
12
13 stream
14 Holds the stream contents for output
15
16 streamfile
17 Holds the stream contents in an external file rather than in
18 memory. This is not the same as a PDF file stream. The data is
19 stored in its unfiltered form.
20
21 streamloc
22 If both ' stream' and ' streamfile' are empty, this indicates where
23 in the source PDF the stream starts.
24
26 $type = $d->type($type)
27 Get/Set the standard Type key. It can be passed, and will return, a
28 text value rather than a Name object.
29
30 @filters = $d->filter(@filters)
31 Get/Set one or more filters being used by the optional stream attached
32 to the dictionary.
33
34 $d->outobjdeep($fh)
35 Outputs the contents of the dictionary to a PDF file. This is a
36 recursive call.
37
38 It also outputs a stream if the dictionary has a stream element. If
39 this occurs then this method will calculate the length of the stream
40 and insert it into the stream's dictionary.
41
42 $d->read_stream($force_memory)
43 Reads in a stream from a PDF file. If the stream is greater than
44 "PDF::Dict::mincache" (defaults to 32768) bytes to be stored, then the
45 default action is to create a file for it somewhere and to use that
46 file as a data cache. If $force_memory is set, this caching will not
47 occur and the data will all be stored in the $self->{' stream'}
48 variable.
49
50 $d->val
51 Returns the dictionary, which is itself.
52
53
54
55perl v5.34.0 2021-08-02 PDF::API2::Basic::PDF::Dict(3)