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