1PDF::API2::Basic::PDF::UOsbejrinCdo(n3t)ributed Perl DocPuDmFe:n:tAaPtIi2o:n:Basic::PDF::Objind(3)
2
6 PDF::API2::Basic::PDF::Objind - Low-level PDF indirect object
7
9 Instance variables differ from content variables in that they all start
10 with a space.
11 parent
13 For an object which is a reference to an object in some source,
14 this holds the reference to the source object, so that should the
15 reference have to be de-referenced, then we know where to go and
16 get the info.
17 objnum (R)
19 The object number in the source (only for object references)
20 objgen (R)
22 The object generation in the source
23 There are other instance variables which are used by the parent for
25 file control.
26 isfree
28 This marks whether the object is in the free list and available for
29 re-use as another object elsewhere in the file.
30 nextfree
32 Holds a direct reference to the next free object in the free list.
33
35 PDF::API2::Basic::PDF::Objind->new()
36 Creates a new indirect object
37 uid
39 Returns a Unique id for this object, creating one if it didn't have one
40 before
41 $r->release
43 Releases ALL of the memory used by this indirect object, and all of its
44 component/child objects. This method is called automatically by
45 '"PDF::API2::Basic::PDF::File->release"' (so you don't have to call it
46 yourself).
47 Note: it is important that this method get called at some point prior
49 to the actual destruction of the object. Internally, PDF files have an
50 enormous amount of cross-references and this causes circular references
51 within our own internal data structures. Calling '"release()"' forces
52 these circular references to be cleaned up and the entire internal data
53 structure purged.
54 $r->val
56 Returns the value of this object or reads the object and then returns
57 its value.
58 Note that all direct subclasses *must* make their own versions of this
60 subroutine otherwise we could be in for a very deep loop!
61 $r->realise
63 Makes sure that the object is fully read in, etc.
64 $r->outobjdeep($fh, $pdf)
66 If you really want to output this object, then you must need to read it
67 first. This also means that all direct subclasses must subclass this
68 method or loop forever!
69 $r->outobj($fh)
71 If this is a full object then outputs a reference to the object,
72 otherwise calls outobjdeep to output the contents of the object at this
73 point.
74 $r->elements
76 Abstract superclass function filler. Returns self here but should
77 return something more useful if an array.
78 $r->empty
80 Empties all content from this object to free up memory or to be read to
81 pass the object into the free list. Simplistically undefs all instance
82 variables other than object number and generation.
83 $r->merge($objind)
85 This merges content information into an object reference place-holder.
86 This occurs when an object reference is read before the object
87 definition and the information in the read data needs to be merged into
88 the object place-holder
89 $r->is_obj($pdf)
91 Returns whether this object is a full object with its own object number
92 or whether it is purely a sub-object. $pdf indicates which output file
93 we are concerned that the object is an object in.
94 $r->copy($pdf, $res)
96 Returns a new copy of this object. The object is assumed to be some
97 kind of associative array and the copy is a deep copy for elements
98 which are not PDF objects, according to $pdf, and shallow copy for
99 those that are. Notice that calling "copy" on an object forces at
100 least a one level copy even if it is a PDF object. The returned object
101 loses its PDF object status though.
102 If $res is defined then the copy goes into that object rather than
104 creating a new one. It is up to the caller to bless $res, etc. Notice
105 that elements from $self are not copied into $res if there is already
106 an entry for them existing in $res.
107perl v5.36.0 2022-07-22 PDF::API2::Basic::PDF::Objind(3)