1PDF::API2::Basic::PDF::UOsbejrinCdo(n3t)ributed Perl DocPuDmFe:n:tAaPtIi2o:n:Basic::PDF::Objind(3)
2
6 PDF::API2::Basic::PDF::Objind - PDF indirect object reference. Also
7 acts as an abstract superclass for all elements in a PDF file.
8
10 Instance variables differ from content variables in that they all start
11 with a space.
12 parent
14 For an object which is a reference to an object in some source,
15 this holds the reference to the source object, so that should the
16 reference have to be de-referenced, then we know where to go and
17 get the info.
18 objnum (R)
20 The object number in the source (only for object references)
21 objgen (R)
23 The object generation in the source
24 There are other instance variables which are used by the parent for
26 file control.
27 isfree
29 This marks whether the object is in the free list and available for
30 re-use as another object elsewhere in the file.
31 nextfree
33 Holds a direct reference to the next free object in the free list.
34
36 PDF::API2::Basic::PDF::Objind->new()
37 Creates a new indirect object
38 uid
40 Returns a Unique id for this object, creating one if it didn't have one
41 before
42 $r->release
44 Releases ALL of the memory used by this indirect object, and all of its
45 component/child objects. This method is called automatically by
46 '"PDF::API2::Basic::PDF::File->release"' (so you don't have to call it
47 yourself).
48 NOTE, that it is important that this method get called at some point
50 prior to the actual destruction of the object. Internally, PDF files
51 have an enormous amount of cross-references and this causes circular
52 references within our own internal data structures. Calling
53 '"release()"' forces these circular references to be cleaned up and the
54 entire internal data structure purged.
55 Developer note: As part of the brute-force cleanup done here, this
57 method will throw a warning message whenever unexpected key values are
58 found within the "PDF::API2::Basic::PDF::Objind" object. This is done
59 to help ensure that unexpected and unfreed values are brought to your
60 attention, so you can bug us to keep the module updated properly;
61 otherwise the potential for memory leaks due to dangling circular
62 references will exist.
63 $r->val
65 Returns the val of this object or reads the object and then returns its
66 value.
67 Note that all direct subclasses *must* make their own versions of this
69 subroutine otherwise we could be in for a very deep loop!
70 $r->realise
72 Makes sure that the object is fully read in, etc.
73 $r->outobjdeep($fh, $pdf)
75 If you really want to output this object, then you must need to read it
76 first. This also means that all direct subclasses must subclass this
77 method or loop forever!
78 $r->outobj($fh)
80 If this is a full object then outputs a reference to the object,
81 otherwise calls outobjdeep to output the contents of the object at this
82 point.
83 $r->elementsof
85 Abstract superclass function filler. Returns self here but should
86 return something more useful if an array.
87 $r->empty
89 Empties all content from this object to free up memory or to be read to
90 pass the object into the free list. Simplistically undefs all instance
91 variables other than object number and generation.
92 $r->merge($objind)
94 This merges content information into an object reference place-holder.
95 This occurs when an object reference is read before the object
96 definition and the information in the read data needs to be merged into
97 the object place-holder
98 $r->is_obj($pdf)
100 Returns whether this object is a full object with its own object number
101 or whether it is purely a sub-object. $pdf indicates which output file
102 we are concerned that the object is an object in.
103 $r->copy($pdf, $res)
105 Returns a new copy of this object. The object is assumed to be some
106 kind of associative array and the copy is a deep copy for elements
107 which are not PDF objects, according to $pdf, and shallow copy for
108 those that are. Notice that calling "copy" on an object forces at
109 least a one level copy even if it is a PDF object. The returned object
110 loses its PDF object status though.
111 If $res is defined then the copy goes into that object rather than
113 creating a new one. It is up to the caller to bless $res, etc. Notice
114 that elements from $self are not copied into $res if there is already
115 an entry for them existing in $res.
116perl v5.12.2 2011-01-24 PDF::API2::Basic::PDF::Objind(3)